Scanframe Modular Application 0.1.0
Loading...
Searching...
No Matches
sf::GmiEmulator::TAxis Class Referencefinal

Axis type of this implementation. More...

#include <GmiEmulator.h>

Inheritance diagram for sf::GmiEmulator::TAxis:
Collaboration diagram for sf::GmiEmulator::TAxis:

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.
 
double getCurrent (EAxisValueType avt) const
 Returns the current position/velocity/acceleration.
 
bool setCurrent (EAxisValueType avt, double val)
 Sets the current position/velocity/acceleration. Only when not moving.
 
double getAccuracy () const
 Returns the accuracy for velocity and position.
 
double getResolution () const
 Returns the resolution of the axis.
 
double getMinMax (EAxisMinMax amm) const
 Gets the current extremes from this axis.
 
bool setOffset (double ofs)
 Set the position offset.
 
double setOffset () const
 Get the position offset.
 
double getTarget (EAxisValueType avt) const
 Returns the current velocity.
 
bool setTarget (EAxisValueType avt, double val)
 Sets the current velocity.
 
bool setPosition (double value)
 Sets the current position.
 
double normalized (double 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_cmplt, bool vel_cmplt, bool con_cmplt)
 Returns true if the mode can be changed.
 

Public Attributes

sf::ElapseTimer MovePosTimer
 
sf::ElapseTimer MoveVelTimer
 
sf::ElapseTimer MoveConTimer
 
double TrgPos
 
double TrgVel
 
double TrgAcc
 
double TrgDist
 
double TrgDist2
 
double StartVel
 
double CurPos
 
double CurVel
 
double OfsPos
 
double MaxPos
 
double MaxVel
 
double MaxAcc
 
double MinPos
 
double Accuracy
 
double Resolution
 
double 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

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

double sf::GmiEmulator::TAxis::Accuracy

◆ CurPos

double sf::GmiEmulator::TAxis::CurPos

◆ CurVel

double sf::GmiEmulator::TAxis::CurVel

◆ GmiEmulator

friend sf::GmiEmulator::TAxis::GmiEmulator

◆ MaxAcc

double sf::GmiEmulator::TAxis::MaxAcc

◆ MaxPos

double sf::GmiEmulator::TAxis::MaxPos

◆ MaxVel

double sf::GmiEmulator::TAxis::MaxVel

◆ MinPos

double 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

double sf::GmiEmulator::TAxis::OfsPos

◆ Resolution

double sf::GmiEmulator::TAxis::Resolution

◆ Round

double sf::GmiEmulator::TAxis::Round

◆ StartVel

double sf::GmiEmulator::TAxis::StartVel

◆ TrgAcc

double sf::GmiEmulator::TAxis::TrgAcc

◆ TrgDist

double sf::GmiEmulator::TAxis::TrgDist

◆ TrgDist2

double sf::GmiEmulator::TAxis::TrgDist2

◆ TrgPos

double sf::GmiEmulator::TAxis::TrgPos

◆ TrgVel

double sf::GmiEmulator::TAxis::TrgVel

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