sf::TDefaultScanBinder::TStagePosition Class Reference

Structure to stage position information. More...

#include <DefaultScanBinder.h>

Public Member Functions
	TStagePosition ()
	Default constructor.
	TStagePosition (const TStagePosition &)
	Copy constructor.
	TStagePosition (int scan, EBinderStage stage, int index=-1, double frac=-1.0, bool rect=false)
	Initializing constructor.
const TStagePosition &	Set (int scan, EBinderStage stage, int index=-1, double frac=-1.0, bool rect=false)
	Initialize function.
bool	IsEqual (const TStagePosition &stage_pos) const
	Compares the members taking the binder stage into account.
bool	operator!= (const TStagePosition &sp) const
	Equal operator.
bool	operator== (const TStagePosition &sp) const
	Unequal operator.
std::string	GetName (TDefaultScanBinder *) 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

TStagePosition() [1/3]

sf::TDefaultScanBinder::TStagePosition::TStagePosition ( )

inline

Default constructor.

TStagePosition() [2/3]

sf::TDefaultScanBinder::TStagePosition::TStagePosition ( const TStagePosition &  sp )

inline

Copy constructor.

TStagePosition() [3/3]

sf::TDefaultScanBinder::TStagePosition::TStagePosition ( int  scan, EBinderStage  stage, int  index = -1, double  frac = -1.0, bool  rect = false  )

inline

Initializing constructor.

Parameters

scan
stage
index
frac
rect

Member Function Documentation

GetName()

std::string sf::TDefaultScanBinder::TStagePosition::GetName

(

TDefaultScanBinder *

)

const

Gets the name of this stage position.

GetString()

std::string sf::TDefaultScanBinder::TStagePosition::GetString

(

)

const

Retrieves information as a string.

IsEqual()

bool sf::TDefaultScanBinder::TStagePosition::IsEqual ( const TStagePosition &  stage_pos ) const

inline

Compares the members taking the binder stage into account.

Parameters

stage_pos

Returns

True when equal.

operator!=()

bool sf::TDefaultScanBinder::TStagePosition::operator!= ( const TStagePosition &  sp ) const

inline

Equal operator.

operator==()

bool sf::TDefaultScanBinder::TStagePosition::operator== ( const TStagePosition &  sp ) const

inline

Unequal operator.

Set()

const TDefaultScanBinder::TStagePosition & sf::TDefaultScanBinder::TStagePosition::Set ( int  scan, EBinderStage  stage, int  index = -1, double  frac = -1.0, bool  rect = false  )

inline

Initialize function.

Parameters

scan
stage
index
frac
rect

Returns

SetString()

bool sf::TDefaultScanBinder::TStagePosition::SetString

(

const std::string &

s

)

Sets information as a string.

Member Data Documentation

Frac

double sf::TDefaultScanBinder::TStagePosition::Frac

Fraction of the scan line. (bsSCAN only)

Index

int sf::TDefaultScanBinder::TStagePosition::Index

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

Rect

bool sf::TDefaultScanBinder::TStagePosition::Rect

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

Scan

int sf::TDefaultScanBinder::TStagePosition::Scan

Scan index in the project list.

Stage

EBinderStage sf::TDefaultScanBinder::TStagePosition::Stage

Stage in the movement process.

---

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

• DefaultScanBinder.h