Scanframe Modular Application 0.1.0
Loading...
Searching...
No Matches
sf::DefaultScanBinder::StagePosition Class Reference

Structure to stage position information. More...

#include <DefaultScanBinder.h>

Public Member Functions

 StagePosition ()
 Default constructor.
 
 StagePosition (const StagePosition &)
 Copy constructor.
 
 StagePosition (int scan, EBinderStage stage, int index=-1, double frac=-1.0, bool perp=false)
 Initializing constructor.
 
const StagePositionset (int scan, EBinderStage stage, int index=-1, double frac=-1.0, bool perp=false)
 Initialize function.
 
bool isEqual (const StagePosition &stage_pos) const
 Compares the members taking the binder stage into account.
 
bool operator!= (const StagePosition &sp) const
 Equal operator.
 
bool operator== (const StagePosition &sp) const
 Unequal operator.
 
std::string getName (DefaultScanBinder *) const
 Gets the name of this stage position.
 
std::string getString () const
 Retrieves information as a string.
 
bool setString (const std::string &s)
 Sets information as a string.
 

Public Attributes

int _scan
 Scan index in the project list.
 
EBinderStage _stage
 Stage in the movement process.
 
int _index
 Index of the scan line or approach index or system position.
 
double _frac
 Fraction of the scan line. (bsSCAN only)
 
bool _rect
 Specifies if the position is rectangular to the surface or not.
 

Detailed Description

Structure to stage position information.

Constructor & Destructor Documentation

◆ StagePosition() [1/3]

sf::DefaultScanBinder::StagePosition::StagePosition ( )
inline

Default constructor.

◆ StagePosition() [2/3]

sf::DefaultScanBinder::StagePosition::StagePosition ( const StagePosition sp)
inline

Copy constructor.

◆ StagePosition() [3/3]

sf::DefaultScanBinder::StagePosition::StagePosition ( int  scan,
EBinderStage  stage,
int  index = -1,
double  frac = -1.0,
bool  perp = false 
)
inline

Initializing constructor.

Member Function Documentation

◆ getName()

std::string sf::DefaultScanBinder::StagePosition::getName ( DefaultScanBinder ) const

Gets the name of this stage position.

◆ getString()

std::string sf::DefaultScanBinder::StagePosition::getString ( ) const

Retrieves information as a string.

◆ isEqual()

bool sf::DefaultScanBinder::StagePosition::isEqual ( const StagePosition stage_pos) const
inline

Compares the members taking the binder stage into account.

Parameters
stage_pos
Returns
True when equal.

◆ operator!=()

bool sf::DefaultScanBinder::StagePosition::operator!= ( const StagePosition sp) const
inline

Equal operator.

◆ operator==()

bool sf::DefaultScanBinder::StagePosition::operator== ( const StagePosition sp) const
inline

Unequal operator.

◆ set()

const DefaultScanBinder::StagePosition & sf::DefaultScanBinder::StagePosition::set ( int  scan,
EBinderStage  stage,
int  index = -1,
double  frac = -1.0,
bool  perp = false 
)
inline

Initialize function.

◆ setString()

bool sf::DefaultScanBinder::StagePosition::setString ( const std::string &  s)

Sets information as a string.

Member Data Documentation

◆ _frac

double sf::DefaultScanBinder::StagePosition::_frac

Fraction of the scan line. (bsSCAN only)

◆ _index

int sf::DefaultScanBinder::StagePosition::_index

Index of the scan line or approach index or system position.

◆ _rect

bool sf::DefaultScanBinder::StagePosition::_rect

Specifies if the position is rectangular to the surface or not.

◆ _scan

int sf::DefaultScanBinder::StagePosition::_scan

Scan index in the project list.

◆ _stage

EBinderStage sf::DefaultScanBinder::StagePosition::_stage

Stage in the movement process.


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