cpart_step Class Reference

step motor part class More...

#include <output_step.h>

Inheritance diagram for cpart_step:

Collaboration diagram for cpart_step:

Public Member Functions
std::string	GetAboutInfo (void) override
	Return the about information of part.
	cpart_step (const unsigned x, const unsigned y, const char *name, const char *type, board *pboard_, const int id_)
	constructor called once on part creation
	~cpart_step (void)
	destructor called once on part destruction
void	DrawOutput (const unsigned int index) override
	Called to draw every output.
void	PreProcess (void) override
	Called every start of CPU process.
void	Process (void) override
	Called every CPU step.
void	PostProcess (void) override
	Called every end of CPU process.
void	ConfigurePropertiesWindow (void) override
	Called to configure the properties window.
void	ReadPropertiesWindow (void) override
	Called when properties window close.
std::string	WritePreferences (void) override
	Called to save part preferences in configuration file.
void	ReadPreferences (std::string value) override
	Called whe configuration file load preferences.
unsigned short	GetInputId (char *name) override
	return the input ids numbers of names used in input map
unsigned short	GetOutputId (char *name) override
	return the output ids numbers of names used in output map
Public Member Functions inherited from part
std::string	GetName (void)
	Return the name of part.
virtual std::string	GetHelpURL (void)
	Return the help url of part.
void	Draw (void)
	Called ever 100ms to draw part.
virtual std::string	GetPictureFileName (void)
	Return the filename of part picture.
virtual std::string	GetMapFile (void)
	Return the filename of part picture map.
virtual std::string	GetPropertiesWindowFile (void)
	Return the filename of properties window XML file.
int	GetInputCount (void)
	Get part input count.
input_t *	GetInput (int n)
	Get part input.
int	GetOutputCount (void)
	Get part output count.
output_t *	GetOutput (int n)
	Get part input.
virtual void	Reset (void)
	Reset part status.
virtual void	Stop (void)
	Stop part simulation.
void	EvMouseButtonPress (unsigned int button, unsigned int x, unsigned int y, unsigned int state)
	Event handler on the part.
virtual void	OnMouseButtonPress (unsigned int inputId, unsigned int button, unsigned int x, unsigned int y, unsigned int state)
	Event handler on the part.
void	EvMouseButtonRelease (unsigned int button, unsigned int x, unsigned int y, unsigned int state)
	Event handler on the part.
virtual void	OnMouseButtonRelease (unsigned int inputId, unsigned int button, unsigned int x, unsigned int y, unsigned int state)
	Event handler on the part.
void	EvMouseMove (unsigned int button, unsigned int x, unsigned int y, unsigned int state)
	Event handler on the part.
virtual void	OnMouseMove (unsigned int inputId, unsigned int button, unsigned int x, unsigned int y, unsigned int state)
	Event handler on the part.
virtual void	EvKeyPress (unsigned int key, unsigned int mask)
	Event handler on the part.
virtual void	EvKeyRelease (unsigned int key, unsigned int mask)
	Event handler on the part.
virtual void	ComboChange (const char *controlname, std::string value)
	Used by properties window combos.
virtual void	SpinChange (const char *controlname, int value)
	Used by properties window spin.
virtual void	ButtonEvent (const char *controlname, unsigned int button, unsigned int x, unsigned int y, unsigned int state)
	Used by windows of parts.
virtual void	KeyEvent (const char *controlname, unsigned int keysym, unsigned int ukeysym, unsigned int state)
	Used by windows of parts.
virtual void	Event (const char *controlname)
	Used by windows of parts.
virtual void	filedialog_EvOnClose (int retId)
	Used by properties window filedialogs.
	part (const unsigned x, const unsigned y, const char *name, const char *type, board *pboard_, const int id_, const int fsize=8)
	Called once on part creation.
void	Init (void)
	Called once on part initialization.
virtual void	PostInit (void)
	Called once on part after initialization.
virtual	~part (void)
	Called once on part destruction.
int	GetBitmap (void)
	Return the Bitmap of part.
int	GetX (void)
	Return X position of part.
int	GetY (void)
	Return Y position of part.
void	SetX (int x)
	Set X position of part.
void	SetY (int y)
	Set Y position of part.
unsigned int	GetWidth (void)
	Return width of part.
unsigned int	GetHeight (void)
	Return height of part.
int	PointInside (int x, int y)
	Return if point x,y is inside of part.
void	RotateCoords (unsigned int *x, unsigned int *y)
	Return coords x y rotated by orientation.
virtual void	LoadPartImage (void)
	Load Part Image.
int	GetOrientation (void)
	Return the orientation to draw.
virtual void	SetOrientation (int orientation)
	Set the orientation to draw.
float	GetScale (void)
	Return the orientation to draw.
virtual void	SetScale (double scale)
	Set the orientation to draw.
int	GetId (void)
	Get the part ID.
virtual void	SetId (int id_)
	Set the part ID.
unsigned char	GetUpdate (void)
	Return if part need Draw update.
void	SetUpdate (unsigned char upd)
	Set part to Draw update.
int	GetAlwaysUpdate (void)
	Return if part need to be update every clock cycle.
void	SetAlwaysUpdate (int sau)
	Set if part need to be update every clock cycle.
const int	GetPCWCount (void)
const PCWProp *	GetPCWProperties (void)
const int	GetPinCount (void)
unsigned char *	GetPins (void)
const int	GetPinCtrlCount (void)
const unsigned char *	GetPinsCtrl (void)

Private Member Functions
void	RegisterRemoteControl (void) override
	Register remote control variables.

Private Attributes
unsigned char	input_pins [4]
	pulse input pind
unsigned char	output_pins [1]
	pulse output pin
float	steps
float	angle
int	input [2]
int	turns

Additional Inherited Members
Protected Member Functions inherited from part
void	ReadMaps (void)
	read maps
int	PointInside (int x, int y, input_t input)
	Return if point x,y is inside of input.
void	SetPCWProperties (const PCWProp *pcwprop)
void	SetPCWComboWithPinNames (const char *combo_name, const unsigned char pin)
unsigned char	GetPWCComboSelectedPin (const char *combo_name)
Protected Attributes inherited from part
int	id
	part ID
input_t	input [MAX_IDS]
	input map elements
input_t *	input_ids [MAX_IDS]
	input map elements by id order
output_t	output [MAX_IDS]
	output map elements
output_t *	output_ids [MAX_IDS]
	output map elements by id order
int	inputc
	input map elements counter
int	outputc
	output map elements counter
unsigned int	Height
	Height of part.
unsigned int	Width
	Width of part.
int	X
	X position of part.
int	Y
	Y position of part.
int	BitmapId
	Internal Bitmap.
unsigned int	refresh
	redraw is needed
int	Orientation
	orientation to draw part
float	Scale
	scale to draw part
unsigned int	Update
	part need draw Update
int	always_update
	part need to be update every clock cycle
std::string	Type
int	PinCount
int	PinCtrlCount
unsigned char *	Pins
unsigned char *	PinsCtrl
board *	pboard
int	Fsize

Detailed Description

step motor part class

class definition of step motor class.

Member Function Documentation

ConfigurePropertiesWindow()

void cpart_step::ConfigurePropertiesWindow ( void )

overridevirtual

Called to configure the properties window.

Implements part.

DrawOutput()

void cpart_step::DrawOutput ( const unsigned int index )

overridevirtual

Called to draw every output.

Implements part.

GetAboutInfo()

std::string cpart_step::GetAboutInfo ( void )

inlineoverridevirtual

Return the about information of part.

Implements part.

GetInputId()

unsigned short cpart_step::GetInputId ( char * name )

overridevirtual

return the input ids numbers of names used in input map

Implements part.

GetOutputId()

unsigned short cpart_step::GetOutputId ( char * name )

overridevirtual

return the output ids numbers of names used in output map

Implements part.

PostProcess()

void cpart_step::PostProcess ( void )

overridevirtual

Called every end of CPU process.

Reimplemented from part.

PreProcess()

void cpart_step::PreProcess ( void )

overridevirtual

Called every start of CPU process.

Reimplemented from part.

Process()

void cpart_step::Process ( void )

overridevirtual

Called every CPU step.

Reimplemented from part.

ReadPreferences()

void cpart_step::ReadPreferences ( std::string value )

overridevirtual

Called whe configuration file load preferences.

Implements part.

ReadPropertiesWindow()

void cpart_step::ReadPropertiesWindow ( void )

overridevirtual

Called when properties window close.

Implements part.

RegisterRemoteControl()

void cpart_step::RegisterRemoteControl ( void )

overrideprivatevirtual

Register remote control variables.

Reimplemented from part.

WritePreferences()

std::string cpart_step::WritePreferences ( void )

overridevirtual

Called to save part preferences in configuration file.

Implements part.

---

The documentation for this class was generated from the following files:

• src/parts/output_step.h
• src/parts/output_step.cc