Axis type of this implementation. More...

#include <GmiEmulator.h>

Inheritance diagram for sf::GmiEmulator::TAxis:

Collaboration diagram for sf::GmiEmulator::TAxis:

[legend]

Public Types
typedef Axis	TInherited

Public Types inherited from sf::gmi::Controller::Axis
typedef TVector< Axis * >	PtrVector
	Easy to use vector for an array of Axis pointers.

Public Member Functions
	TAxis (GmiEmulator *me, EAxisLocation al)
	Constructor.

	~TAxis () override
	Destructor.

void	DoMovePos (EMovePosCmd mpc)

void	DoMoveVel (EMoveVelCmd mvc)

void	DoMoveCon (EMoveConCmd mcc)

bool	IsMovePosComplete (timespec clk)

bool	IsMoveVelComplete (timespec clk)

bool	IsMoveConComplete (timespec clk)

Public Member Functions inherited from sf::gmi::Controller::Axis
EAxisLocation	getLocation () const
	Returns the location of the axis in the constellation of axes.

AxisMovements	getMovements () const
	Returns the possible movements the is instance can make.

const char *	getName () const
	Returns the name of this instance.

const char *	getDescription () const
	Returns the description of this instance.

value_type	getCurrent (EAxisValueType avt) const
	Returns the current position/velocity/acceleration.

bool	setCurrent (EAxisValueType avt, value_type val)
	Sets the current position/velocity/acceleration. Only when not moving.

value_type	getAccuracy () const
	Returns the accuracy for velocity and position.

value_type	getResolution () const
	Returns the resolution of the axis.

value_type	getMinMax (EAxisMinMax amm) const
	Gets the current extremes from this axis.

bool	setOffset (double ofs)
	Set the position offset.

value_type	setOffset () const
	Get the position offset.

double	getTarget (EAxisValueType avt) const
	Returns the current velocity.

bool	setTarget (EAxisValueType avt, value_type val)
	Sets the current velocity.

bool	setPosition (value_type value)
	Sets the current position.

value_type	normalized (value_type pos) const
	normalize the passed position for all unlimited rotation axes. Uses accuracy to find the actual position to normalize. The passed value is also returned.

bool	setMode (EAxisMode mode)
	Sets the axis mode for operation. Returns false on failure.

EAxisMode	getMode () const
	Returns the mode of operation.

bool	canModeChange (EAxisMode cur_mode, EAxisMode new_mode, bool pos_complete, bool vel_complete, bool con_complete)
	Returns true if the mode can be changed.

Public Attributes
sf::ElapseTimer	MovePosTimer

sf::ElapseTimer	MoveVelTimer

sf::ElapseTimer	MoveConTimer

value_type	TrgPos

value_type	TrgVel

value_type	TrgAcc

value_type	TrgDist

value_type	TrgDist2

value_type	StartVel

value_type	CurPos

value_type	CurVel

value_type	OfsPos

value_type	MaxPos

value_type	MaxVel

value_type	MaxAcc

value_type	MinPos

value_type	Accuracy

value_type	Resolution

value_type	Round

EAxisMode	Mode

GmiEmulator *	_Controller

friend	GmiEmulator

Additional Inherited Members
Protected Member Functions inherited from sf::gmi::Controller::Axis
	Axis (Controller *mc, EAxisLocation)
	Constructor that registers itself at the passed controller.

virtual	~Axis ()
	Virtual destructor for possible derived destructors.

Protected Attributes inherited from sf::gmi::Controller::Axis
AxisMovements	_movements
	Holds the possible movements.

Detailed Description

Axis type of this implementation.

Member Typedef Documentation

◆ TInherited

typedef Axis sf::GmiEmulator::TAxis::TInherited

Constructor & Destructor Documentation

◆ TAxis()

sf::GmiEmulator::TAxis::TAxis	(	GmiEmulator *	me,
		EAxisLocation	al
	)

Constructor.

Parameters

me
al

◆ ~TAxis()

sf::GmiEmulator::TAxis::~TAxis ( )

override

Destructor.

Member Function Documentation

◆ DoMoveCon()

void sf::GmiEmulator::TAxis::DoMoveCon ( EMoveConCmd mcc )

◆ DoMovePos()

void sf::GmiEmulator::TAxis::DoMovePos ( EMovePosCmd mpc )

◆ DoMoveVel()

void sf::GmiEmulator::TAxis::DoMoveVel ( EMoveVelCmd mvc )

◆ IsMoveConComplete()

bool sf::GmiEmulator::TAxis::IsMoveConComplete ( timespec clk )

◆ IsMovePosComplete()

bool sf::GmiEmulator::TAxis::IsMovePosComplete ( timespec clk )

◆ IsMoveVelComplete()

bool sf::GmiEmulator::TAxis::IsMoveVelComplete ( timespec clk )

Member Data Documentation

◆ _Controller

GmiEmulator* sf::GmiEmulator::TAxis::_Controller

◆ Accuracy

value_type sf::GmiEmulator::TAxis::Accuracy

◆ CurPos

value_type sf::GmiEmulator::TAxis::CurPos

◆ CurVel

value_type sf::GmiEmulator::TAxis::CurVel

◆ GmiEmulator

friend sf::GmiEmulator::TAxis::GmiEmulator

◆ MaxAcc

value_type sf::GmiEmulator::TAxis::MaxAcc

◆ MaxPos

value_type sf::GmiEmulator::TAxis::MaxPos

◆ MaxVel

value_type sf::GmiEmulator::TAxis::MaxVel

◆ MinPos

value_type sf::GmiEmulator::TAxis::MinPos

◆ Mode

EAxisMode sf::GmiEmulator::TAxis::Mode

◆ MoveConTimer

sf::ElapseTimer sf::GmiEmulator::TAxis::MoveConTimer

◆ MovePosTimer

sf::ElapseTimer sf::GmiEmulator::TAxis::MovePosTimer

◆ MoveVelTimer

sf::ElapseTimer sf::GmiEmulator::TAxis::MoveVelTimer

◆ OfsPos

value_type sf::GmiEmulator::TAxis::OfsPos

◆ Resolution

value_type sf::GmiEmulator::TAxis::Resolution

◆ Round

value_type sf::GmiEmulator::TAxis::Round

◆ StartVel

value_type sf::GmiEmulator::TAxis::StartVel

◆ TrgAcc

value_type sf::GmiEmulator::TAxis::TrgAcc

◆ TrgDist

value_type sf::GmiEmulator::TAxis::TrgDist

◆ TrgDist2

value_type sf::GmiEmulator::TAxis::TrgDist2

◆ TrgPos

value_type sf::GmiEmulator::TAxis::TrgPos

◆ TrgVel

value_type sf::GmiEmulator::TAxis::TrgVel

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

GmiEmulator.h

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members