#include <DefaultScanBinder.h>

Inheritance diagram for sf::DefaultScanBinder:

[legend]

Collaboration diagram for sf::DefaultScanBinder:

[legend]

Classes
struct	CheckPosition
	Structure to hold and compare check positions. More...

struct	CheckPositionList
	List of approach positions. More...

struct	Position
	Structure to hold and compare approach positions. More...

struct	PositionList
	List of approach positions. More...

struct	ScanInfo
	Holds the safe position of all scan area in the project. More...

struct	Scanning
	Structure holding all information during the scanning state. More...

class	StagePosition
	Structure to stage position information. More...

Public Types
enum	EPositionSource : int { psNONE , psSET , psPARK , psSAFE , psSCANSTART , psSCANSTOP , psSCANINDEX , psLASTENTRY }
	Enumerating the position sources. More...

enum	EBinderStage : int { bsSYSTEM = 0 , bsAPPROACH , bsSTART , bsSCAN }
	Stages of operation of this scan binder. Order of these enumerates are important. More...

enum	EScanningStage : int { ssABORTED , ssSTART , ssSPINUP , ssTRACE , ssRETRACE , ssFINISH , ssRETURN , ssREADY }
	Stages for scanning. More...

enum	EMoveMode : int { mmVEL , mmCON , mmUNI , mmBI }

enum	EBalance : int { balDISABLED , balACTIVE , balWAIT }
	State set when balancing needs to be called after motion completes. More...

typedef TVector< StagePosition >	StagePositions
	Type of list of stage positions.

Public Types inherited from sf::ScanBinder
enum	EState { sbsCFG_ERR = -2 , sbsERROR = -1 , sbsNO_INIT = 0 , sbsABORTED , sbsREADY , sbsWAITING , sbsSUSPENDED , sbsACTIVE , sbsCHECKING , sbsSCANNING , sbsEVALUATING }
	Enumeration of states of a scan binder. More...

Public Types inherited from sf::ScriptObject
enum	EIdentifier { idUnknown = 0 , idConstant , idVariable , idFunction , idTypedef , idKeyword }
	Keyword identifiers. More...

typedef std::string::size_type	pos_type
	Source position type.

typedef ssize_t	ip_type
	Instruction pointer type.

Public Member Functions
	DefaultScanBinder (const Parameters &parameters)
	Constructor for passing general structure for the class factory.

	~DefaultScanBinder () override
	Virtual destructor.

bool	MoveToCheckPosition (int check_index)
	Mostly called by the binder frame to execute checks.

bool	MoveToCheckPosition (const CheckPosition &check_pos)
	Moves to the check position of the active scan by default.

bool	MoveToCheckPosition (int scan, const CheckPosition &, bool confirm)
	Moves to the check position of the given scan.

bool	CanMoveToCheckPosition ()
	Checks if execution of MoveToCheckPosition() is possible.

const Vector3D &	GetCheckOffset () const
	Gets the check offset for the part established during check positions.

bool	SetCheckOffset (const Vector3D &chk_ofs)
	Applies a new check offset if in the range of allowed displacement otherwise it returns false.

bool	CalcCheckOffset (Vector3D &vect) const
	Calculates the check offset made using the manipulator or acquisition instrument.

void	ControllerEventHandler (gmi::Controller *ctrl, gmi::EControllerEvent event)
	Handler type for motion event handling.

void	doStoreConfig (IniEnvelope &ini, bool rd) override
	Overridden from base class.

InfoBase *	createScanInfo () override
	Overridden from base class.

void	addPropertyPages (PropertySheetDialog *sheet) override
	Overridden from base class.

void	addPropertyPages (PropertySheetDialog *sheet, bool scan) override
	Overridden from base class.

void	readProfile (IniProfile &inifile) override
	Overridden from base class.

void	writeProfile (IniProfile &inifile) override
	Overridden from base class.

void	sustain (const timespec &ts) override
	Overridden from base class.

void	stateChange (EState prev, EState cur) override
	Overridden from base class.

int	getIndex () override
	Overridden from base class.

void	clear () override
	Clears the settings of the derived instance initial state.

bool	initialize () override
	Initializes the instance for action.

bool	suspend (bool immediate) override
	Suspends action at a convenient position.

bool	resume () override
	Resumes a suspended action.

bool	stop () override
	Overridden from base class.

bool	abort () override
	Overridden from base class.

bool	moveTo (int scan, int index, double frac, bool perp) override
	Overridden from base class.

bool	check (int scan) override
	Overridden from base class.

bool	startScan (int scan) override
	Overridden from base class.

bool	evaluate (int scan) override
	Overridden from base class.

bool	activate (int scan) override
	Overridden from base class.

bool	rotate (int scan, int index) override
	Overridden from base class.

QWidget *	GetFrame () override
	Overridden from base class.

Vector3D	getOffset () const override
	Overridden from base class.

bool	getGenericInfoList (StringList &) override
	Overridden from base class.

const IdInfo *	getInfo (const std::string &name) const override
	Overridden from base class.

virtual bool	GetSetValue (const IdInfo info, Value value, Value::vector_type *params, bool flag_set)
	Overridden from base class.

bool	moveTo (int scan, int index, double frac, bool perp, bool chk)
	Same as the overridden function allowing to skip the position check.

bool	getStagePos (gmi::AxesCoord &pos, const StagePosition &stage_pos) const
	Gets the position for the given stage at given coordinate reference.

bool	checkPos (const gmi::AxesCoord &pos) const
	Checks if the given position is equals the current position.

bool	checkStagePos (const StagePosition &stage_pos) const
	Checks if the current controller position is equals the stage position.

bool	moveToStage (const StagePosition &stage_pos)
	Moves the given stage_pos.

void	setCurrentStage (const StagePosition &stage_pos)
	Sets a new stage.

bool	getNextStep (StagePosition &next, const StagePosition &sp1, const StagePosition &sp2, StagePositions &traject)
	Calculate the atomic next step to move from point 1 to point 2.

bool	addCalculatedTraject (StagePositions &traject, const StagePosition &from, const StagePosition &to)
	Calculates the trajectory of move steps to approach a certain position.

int	GetCommonApproachCount (int scan1, int scan2)
	Gets the common amount of approach stages between the passed two scans.

ScanInfo &	getScanInfo (int scan)
	Gets the cast scan info structure of the base class.

const ScanInfo &	getScanInfo (int scan) const
	Gets the constant cast scan info structure of the base class.

bool	setTrigger (int scan)
	Sets the trigger to frequency or density according the axis value.

bool	setScanAxes (bool)
	Sets the axes according to the active scan mode.

bool	getScanPos (gmi::AxesCoord &pos, int index, bool begin)
	Gets the scan index position.

bool	scanMoveTo (int index, bool begin, bool trace)
	Starts movement to the passed scan index.

bool	checkScanPos (int index, bool begin)
	Checks if the position has been reached.

void	handleVariableEventImport (Variable::EEvent event, const Variable &caller, Variable &link, bool same_inst)
	Event handler for imported variables.

bool	queryCheckPosition (CheckPosition &check_pos)
	Reads a check position from user input.

Public Member Functions inherited from sf::ScanBinder
	ScanBinder (const Parameters &parameters)
	Constructor for passing general structure for derived classes for the class factory.

	~ScanBinder () override
	Virtual overridden destructor.

void	storeConfig (bool rd)
	Reads and writes system configuration data.

ConfigStore &	getConfigStore ()
	Gets configuration store instance for reading and write the state of a derived class.

void	createScanEntry (ScanEntry *se)
	Called by the project to make the binder create the additional information.

void	destroyScanEntry (const ScanEntry *se)
	Called by the project to make the binder delete the additional information.

void	doAddPropertyPages (PropertySheetDialog *sheet, bool scan)
	Adds property pages for derived classes by calling virtual method AddPropertyPages. When scan is true it gets the property pages which are scan related when false it gets the project selected property pages.

QWidget *	doGetFrame ()
	Creates a scan binder frame if possible.

void	doReadProfile (IniProfile &inifile)
	Reads the settings from the passed inifile.

void	doWriteProfile (IniProfile &inifile)
	Writes the settings to the passed inifile.

bool	doPreInitialize ()
	Do some initialization which must be done before scan initializations.

bool	doInitialize ()
	Initializes the scan method. Is each time a project changes.

void	doSustain (const timespec &ts)
	Called from the project and rooted to the virtual Sustain function.

void	doClear ()
	Clears any settings of the scan binder to their initial state.

bool	doSuspend (bool immediate)
	Suspends action at a convenient position or immediate.

bool	doResume ()
	Resumes a suspended action.

bool	doStop ()
	Stops activity immediately.

bool	doAbort ()
	Abort immediately stop all movement.

bool	doMoveTo (int scan, int index=-1, double frac=0.0, bool perp=false)
	Moves the manipulator to a specific position of the scan area.

bool	doMoveToQuery (int scan)
	Queries for a surface position of the user.

bool	doMoveToSysPos (ESystemPosition sp)
	Moves to one of the system positions.

bool	doCheck (int scan)
	Starts position checking mode and a scan method in checking mode. This means the angle on the surface is always zero degree to get a better signal from the surface.

bool	doStartScan (int scan)
	Starts scan movements and a scan method for data recording.

bool	doEvaluate (int scan)
	Start in evaluation mode and a scan method in evaluation mode. This means the angle on the surface is the same as when evaluating but movements are initiated by the DoMoveTo function.

bool	doActivate (int scan)
	Activates possible added links and parameters in a derived instance.

bool	doRotate (int scan, int index=-1)
	Starts rotating the scan axis if one is available for rotation. It uses the scan rotation speed at the passed index or when index is -1 it uses the last index position.

bool	canRotate (int scan) const
	Checks if the passed scan-index is able to rotate regardless the current state.

bool	isRotating () const
	Checks if the rotating is active.

int	doGetIndex () const
	Gets the current scanning index. This is mainly for displaying progress purposes.

Vector3D	doGetOffset () const
	Gets the sum of offsets generated by the derived scan binder. When not, this method returns the same value as the fixture offset.

std::string_view	getStateName () const
	Gets the current state name.

EState	getState () const
	Gets the state of the instance.

const gmi::AxesCoord &	getVelocity () const
	Gets the velocity used to manipulate.

const gmi::AxesCoord &	getAcceleration () const
	Gets the acceleration used to manipulate.

const gmi::AxesCoord &	getParkPosition () const
	Gets the project park position.

const gmi::AxesCoord &	getToolPosition () const
	Gets the project park position.

const Vector3D &	getFixtureOffset () const
	Gets the fixture offset for the project applied on each scan.

const Variable &	getMediumVelocity () const
	Gets the medium sound velocity variable.

int	getActiveScanIndex () const
	Gets the active scan index when the state is active or higher an -1 when not active.

double	getScanProgress () const
	Gets the scan progress when scanning otherwise it returns -1.

bool	canAllocateController () const
	Gets true if the controller can be allocated.

bool	isControllerAllocated () const
	Gets true is the controller is allocated.

bool	allocateController (bool alloc)
	Allocates or frees the controller for this project.

gmi::Controller *	getController ()
	Gets the allocated controller for this project if not allocated it throws an exception and should be regarded as a design error.

const gmi::Controller *	getController () const

void	setAcqPopManual (RsaTypes::EPopManual pop_manual)
	Sets the pop to manual state on the acquisition device.

bool	isAcqPopManualReady () const
	Gets true if the pop manual process is completed.

void	setProgVelocityEnable (bool enabled)
	Enables or disables programming velocity.

bool	isProgVelocityEnable () const
	Checks is programming velocity is enabled.

const Variable::PtrVector &	getVars () const
	Gets the local variables of the scan binder.

Public Member Functions inherited from sf::ProjectScriptObject
	ProjectScriptObject (const char *type_name)
	Constructor.

	~ProjectScriptObject () override
	Virtual overridden destructor.

void	AddScriptParam (const std::string &name, Variable *variable)
	Adds the passed variable as a parameter in the script.

Public Member Functions inherited from sf::ScriptObject
	ScriptObject (const char type_name, ScriptObject parent=nullptr)

virtual	~ScriptObject ()=default
	Virtual destructor which can be overridden to clean up objects.

virtual std::string	getStatusText ()
	Gets the status text of this object for debugging purposes.

int	getRefCount () const
	Gets the reference count.

	operator Value () const
	Cast operator to be able to return this instance as a Value.

std::string	getTypeName () const
	Returns the type name Set at the constructor.

ScriptObject *	getParent ()
	Gets the script object owner.

const ScriptObject *	getParent () const
	Gets the script object owner.

ScriptObject *	castToObject (const Value &value)
	Casts a sf::Value::vitCustom typed sf::Value to a ScriptObject typed pointer.

Static Public Member Functions
static std::string	GetSourceName (int value)
	Gets the name of the given enumerate value.

static EPositionSource	GetSourceValue (const std::string &name)
	Gets enumerate value.

static std::string	getStageName (int stage)
	Gets the name of the given stage.

Static Public Member Functions inherited from sf::ScanBinder
static std::string_view	getStateName (EState state)
	Gets the state name string.

Static Public Member Functions inherited from sf::ScriptObject
static const IdInfo *	getInfoUnknown ()
	Returns the static Info structure for unknowns.

Public Attributes
const StagePosition	_current
	Holds the current stage position when the scan binder is active.

StagePosition	_move
	Holds the step movement position when moving.

StagePosition	_target
	Holds the targeted stage position information.

StagePosition	_resume
	Holds the coordinates where the controller was heading for.

ListenerList	_listenerList
	Holds the listeners for this instance to auto removed at destruction.

StagePositions	_traject
	Holds the current trajectory of movements of the applied command.

int	_trajectIndex
	Holds the current traject index. Movement is enabled when set other than -1.

PositionList	FPositions
	Holds the list of position.

EState	_afterStopState
	State to set when motion stops.

EState	_resumeState
	State to set when motion stops.

gmi::AxesCoord	_stopCoord
	Holds the coordinates where the controller stopped.

DefaultBinderFrame *	_binderFrame
	Holds the special binder frame when it is created.

struct sf::DefaultScanBinder::Scanning	_scanning

Vector3D	_checkOffset
	Holds the check offset for the project established during checking.

Variable::PtrVector	_varsImport
	Holds the imported variable pointers for iterations.

TVariableHandler< DefaultScanBinder >	_handlerVariableEventImport {this, &DefaultScanBinder::handleVariableEventImport}
	Variable handler callback hook.

Variable	vBalance
	For switching on balance and to detect when it is ready when it is reset.

Variable	vBidirectional
	To signal bidirectional was switched on.

Variable	vScanGainActive
	To signal scan gain must be active.

EBalance	_balanceState
	Holds the balance state.

bool	_checkMoveConfirm
	When enabled each position move wil be asked for7 confirmation.

bool	_clearCheckOffset
	When enabled a change in scan index will clear the offset.

int	_checkOffsetScanIndex
	Holds the scan index used for the last check offset.

CheckPosition	_manualPosition
	Holds the last manual entered check position.

friend	Scanning

Static Public Attributes
static constexpr int	MAX_POSITIONS {30}
	Maximum amount of positions.

Friends
class	StagePosition

class	SelectCurrentPositionDialog

class	DefaultBinderPropertyPage

class	CheckPositionsPropertyPage

class	DefaultBinderConfigPropertyPage

class	BinderCommonPropertyPage

class	DefaultBinderProjectPropertyPage

Additional Inherited Members
Protected Member Functions inherited from sf::ScanBinder
bool	getScanPos (gmi::AxesCoord &pos, int scan, int index, double frac, bool perp) const
	Gets the scan position at the passed scan index.

int	getScanIndex ()
	Gets the current project active scan index.

ScanMethod *	getScan (int scan) const
	Gets the scan method of the project.

bool	setState (EState state)
	Sets the state of the binder.

InfoBase *	getScanInfoBase (int scan)
	Gets the scan base information of the passed project scan list index.

const InfoBase *	getScanInfoBase (int scan) const
	Gets the const scan base information of the passed project scan list index.

InfoBase *	getScanInfoBase (const ScanMethod *sm)
	Gets the scan information of the passed scan method pointer.

const InfoBase *	getScanInfoBase (const ScanMethod *sm) const
	Gets the const scan information of the passed scan method pointer.

ProjectData *	getProjectData ()
	Gets the project data pointer.

const IdInfo *	getInfo (const std::string &name) const override
	Overridden from base class.

bool	getSetValue (const IdInfo info, Value value, Value::vector_type *params, bool flag_set) override
	Overridden from base class.

Protected Member Functions inherited from sf::ProjectScriptObject
void	destroyObject (bool &should_delete) override
	Overridden from base class.

Protected Member Functions inherited from sf::ScriptObject
void	makeParent (ScriptObject *so)
	Makes this object the owner of the other object.

void	setParent (ScriptObject *parent)
	Sets the owner to the pass script object.

Member Typedef Documentation

◆ StagePositions

typedef TVector<StagePosition> sf::DefaultScanBinder::StagePositions

Type of list of stage positions.

Member Enumeration Documentation

◆ EBalance

enum sf::DefaultScanBinder::EBalance : int

State set when balancing needs to be called after motion completes.

Enumerator
balDISABLED	Balancing sequence is disabled.
balACTIVE	Balancing needs to be triggered on motion position complete.
balWAIT	Waiting for balance completion.

◆ EBinderStage

enum sf::DefaultScanBinder::EBinderStage : int

Stages of operation of this scan binder. Order of these enumerates are important.

Enumerator
bsSYSTEM	Position is at system position.
bsAPPROACH	Position is at approach position index.
bsSTART	Position is at scan start.
bsSCAN	Position is at specified scan index.

◆ EMoveMode

enum sf::DefaultScanBinder::EMoveMode : int

Enumerator
mmVEL	Continuous move by the scan axis on unlimited axis and the other axis are used in velocity mode.
mmCON	Continuous move by the scan axis on unlimited axis.
mmUNI	Bidirectional move by the scan axis.
mmBI	Bidirectional move by the scan axis.

◆ EPositionSource

enum sf::DefaultScanBinder::EPositionSource : int

Enumerating the position sources.

Enumerator
psNONE	For reading from stream.
psSET	Position set in the structure.
psPARK	Park position.
psSAFE	Scan method safe position.
psSCANSTART	Scan method start position.
psSCANSTOP	Scan method stop position.
psSCANINDEX	Scan method index position.
psLASTENTRY	Entry to enable iteration.

◆ EScanningStage

enum sf::DefaultScanBinder::EScanningStage : int

Stages for scanning.

Enumerator
ssABORTED	Scanning was aborted.
ssSTART	Start of scanning.
ssSPINUP	Continuous mode axis spin up. Uses the timer.
ssTRACE	Tracing for data in uni- or bidirectional mode.
ssRETRACE	Moving back in unidirectional mode.
ssFINISH	Finishing scanning.
ssRETURN	Return to position from continuous mode.
ssREADY	Scanning has finished.

Constructor & Destructor Documentation

◆ DefaultScanBinder()

sf::DefaultScanBinder::DefaultScanBinder ( const Parameters & parameters )

explicit

Constructor for passing general structure for the class factory.

Parameters

parameters

◆ ~DefaultScanBinder()

sf::DefaultScanBinder::~DefaultScanBinder ( )

override

Virtual destructor.

Member Function Documentation

◆ abort()

bool sf::DefaultScanBinder::abort ( )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ activate()

bool sf::DefaultScanBinder::activate ( int scan )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ addCalculatedTraject()

bool sf::DefaultScanBinder::addCalculatedTraject	(	StagePositions &	traject,
		const StagePosition &	from,
		const StagePosition &	to
	)

Calculates the trajectory of move steps to approach a certain position.

Parameters

traject
from
to

Returns

◆ addPropertyPages() [1/2]

void sf::DefaultScanBinder::addPropertyPages ( PropertySheetDialog * sheet )

overridevirtual

Overridden from base class.

Reimplemented from sf::ScanBinder.

◆ addPropertyPages() [2/2]

void sf::DefaultScanBinder::addPropertyPages	(	PropertySheetDialog *	sheet,
		bool	scan
	)

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ CalcCheckOffset()

bool sf::DefaultScanBinder::CalcCheckOffset ( Vector3D & vect ) const

Calculates the check offset made using the manipulator or acquisition instrument.

Parameters

vect

Returns

◆ CanMoveToCheckPosition()

bool sf::DefaultScanBinder::CanMoveToCheckPosition ( )

Checks if execution of MoveToCheckPosition() is possible.

Returns: True when possible

◆ check()

bool sf::DefaultScanBinder::check ( int scan )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ checkPos()

bool sf::DefaultScanBinder::checkPos ( const gmi::AxesCoord & pos ) const

Checks if the given position is equals the current position.

Parameters

pos

Returns: True when equal.

◆ checkScanPos()

bool sf::DefaultScanBinder::checkScanPos	(	int	index,
		bool	begin
	)

Checks if the position has been reached.

Parameters

index	Index in the position list.
begin

Returns: True when positon is reached.

◆ checkStagePos()

bool sf::DefaultScanBinder::checkStagePos ( const StagePosition & stage_pos ) const

Checks if the current controller position is equals the stage position.

Parameters

stage_pos

Returns: True when equal.

◆ clear()

void sf::DefaultScanBinder::clear ( )

overridevirtual

Clears the settings of the derived instance initial state.

Implements sf::ScanBinder.

◆ ControllerEventHandler()

void sf::DefaultScanBinder::ControllerEventHandler	(	gmi::Controller *	ctrl,
		gmi::EControllerEvent	event
	)

Handler type for motion event handling.

Parameters

ctrl
event

◆ createScanInfo()

InfoBase * sf::DefaultScanBinder::createScanInfo ( )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ doStoreConfig()

void sf::DefaultScanBinder::doStoreConfig	(	IniEnvelope &	ini,
		bool	rd
	)

overridevirtual

Overridden from base class.

Reimplemented from sf::ScanBinder.

◆ evaluate()

bool sf::DefaultScanBinder::evaluate ( int scan )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ GetCheckOffset()

const Vector3D & sf::DefaultScanBinder::GetCheckOffset ( ) const

inline

Gets the check offset for the part established during check positions.

Returns: 3D vector having the XYZ-offset.

◆ GetCommonApproachCount()

int sf::DefaultScanBinder::GetCommonApproachCount	(	int	scan1,
		int	scan2
	)

Gets the common amount of approach stages between the passed two scans.

Parameters

scan1
scan2

Returns: On error the return value is -1.

◆ GetFrame()

QWidget * sf::DefaultScanBinder::GetFrame ( )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ getGenericInfoList()

bool sf::DefaultScanBinder::getGenericInfoList ( StringList & )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ getIndex()

int sf::DefaultScanBinder::getIndex ( )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ getInfo()

const IdInfo * sf::DefaultScanBinder::getInfo ( const std::string & name ) const

overridevirtual

Overridden from base class.

Implements sf::ScriptObject.

◆ getNextStep()

bool sf::DefaultScanBinder::getNextStep	(	StagePosition &	next,
		const StagePosition &	sp1,
		const StagePosition &	sp2,
		StagePositions &	traject
	)

Calculate the atomic next step to move from point 1 to point 2.

Parameters

next
sp1
sp2
traject

Returns

◆ getOffset()

Vector3D sf::DefaultScanBinder::getOffset ( ) const

overridevirtual

Overridden from base class.

Reimplemented from sf::ScanBinder.

◆ getScanInfo() [1/2]

DefaultScanBinder::ScanInfo & sf::DefaultScanBinder::getScanInfo ( int scan )

inline

Gets the cast scan info structure of the base class.

Parameters

scan	Index of scan in the project.

Returns: Scan information reference.

◆ getScanInfo() [2/2]

const DefaultScanBinder::ScanInfo & sf::DefaultScanBinder::getScanInfo ( int scan ) const

inline

Gets the constant cast scan info structure of the base class.

Parameters

scan	Index of scan in the project.

Returns: Scan information reference.

◆ getScanPos()

bool sf::DefaultScanBinder::getScanPos	(	gmi::AxesCoord &	pos,
		int	index,
		bool	begin
	)

Gets the scan index position.

Parameters

pos
index
begin

Returns: True on success.

◆ GetSetValue()

virtual bool sf::DefaultScanBinder::GetSetValue	(	const IdInfo *	info,
		Value *	value,
		Value::vector_type *	params,
		bool	flag_set
	)

virtual

Overridden from base class.

◆ GetSourceName()

static std::string sf::DefaultScanBinder::GetSourceName ( int value )

static

Gets the name of the given enumerate value.

◆ GetSourceValue()

static EPositionSource sf::DefaultScanBinder::GetSourceValue ( const std::string & name )

static

Gets enumerate value.

Parameters

name

Returns

◆ getStageName()

static std::string sf::DefaultScanBinder::getStageName ( int stage )

static

Gets the name of the given stage.

◆ getStagePos()

bool sf::DefaultScanBinder::getStagePos	(	gmi::AxesCoord &	pos,
		const StagePosition &	stage_pos
	)		const

Gets the position for the given stage at given coordinate reference.

Parameters

pos
stage_pos

Returns: True on succes of retrieving.

◆ handleVariableEventImport()

void sf::DefaultScanBinder::handleVariableEventImport	(	Variable::EEvent	event,
		const Variable &	caller,
		Variable &	link,
		bool	same_inst
	)

Event handler for imported variables.

◆ initialize()

bool sf::DefaultScanBinder::initialize ( )

overridevirtual

Initializes the instance for action.

Returns: True on success.

Implements sf::ScanBinder.

◆ moveTo() [1/2]

bool sf::DefaultScanBinder::moveTo	(	int	scan,
		int	index,
		double	frac,
		bool	perp
	)

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ moveTo() [2/2]

bool sf::DefaultScanBinder::moveTo	(	int	scan,
		int	index,
		double	frac,
		bool	perp,
		bool	chk
	)

Same as the overridden function allowing to skip the position check.

Parameters

scan
index
frac
perp
chk

Returns: True on successful start.

◆ MoveToCheckPosition() [1/3]

bool sf::DefaultScanBinder::MoveToCheckPosition ( const CheckPosition & check_pos )

Moves to the check position of the active scan by default.

Parameters

check_pos

Returns: True on success.

◆ MoveToCheckPosition() [2/3]

bool sf::DefaultScanBinder::MoveToCheckPosition ( int check_index )

Mostly called by the binder frame to execute checks.

Parameters

check_index

Returns: True on success.

◆ MoveToCheckPosition() [3/3]

bool sf::DefaultScanBinder::MoveToCheckPosition	(	int	scan,
		const CheckPosition &	,
		bool	confirm
	)

Moves to the check position of the given scan.

Parameters

scan	Index of the scan in the project.
confirm	Asks for confirmation before the move.

Returns: True on success.

◆ moveToStage()

bool sf::DefaultScanBinder::moveToStage ( const StagePosition & stage_pos )

Moves the given stage_pos.

Parameters

stage_pos

Returns: True on successfully starting the controller to move.

◆ queryCheckPosition()

bool sf::DefaultScanBinder::queryCheckPosition ( CheckPosition & check_pos )

Reads a check position from user input.

◆ readProfile()

void sf::DefaultScanBinder::readProfile ( IniProfile & inifile )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ resume()

bool sf::DefaultScanBinder::resume ( )

overridevirtual

Resumes a suspended action.

Returns: True on success.

Implements sf::ScanBinder.

◆ rotate()

bool sf::DefaultScanBinder::rotate	(	int	scan,
		int	index
	)

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ scanMoveTo()

bool sf::DefaultScanBinder::scanMoveTo	(	int	index,
		bool	begin,
		bool	trace
	)

Starts movement to the passed scan index.

Parameters

index
begin
trace

Returns: True when successful.

◆ SetCheckOffset()

bool sf::DefaultScanBinder::SetCheckOffset ( const Vector3D & chk_ofs )

Applies a new check offset if in the range of allowed displacement otherwise it returns false.

Parameters

chk_ofs

Returns: True on success.

◆ setCurrentStage()

void sf::DefaultScanBinder::setCurrentStage ( const StagePosition & stage_pos )

Sets a new stage.

Parameters

stage_pos

◆ setScanAxes()

bool sf::DefaultScanBinder::setScanAxes ( bool )

Sets the axes according to the active scan mode.

Returns

◆ setTrigger()

bool sf::DefaultScanBinder::setTrigger ( int scan )

Sets the trigger to frequency or density according the axis value.

Parameters

scan	Index of scn in the project.

Returns: TRue on success.

◆ startScan()

bool sf::DefaultScanBinder::startScan ( int scan )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ stateChange()

void sf::DefaultScanBinder::stateChange	(	EState	prev,
		EState	cur
	)

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ stop()

bool sf::DefaultScanBinder::stop ( )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ suspend()

bool sf::DefaultScanBinder::suspend ( bool immediate )

overridevirtual

Suspends action at a convenient position.

Parameters

immediate Do not wait until a positon move has finished.

Returns: True on succes.

Implements sf::ScanBinder.

◆ sustain()

void sf::DefaultScanBinder::sustain ( const timespec & ts )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

◆ writeProfile()

void sf::DefaultScanBinder::writeProfile ( IniProfile & inifile )

overridevirtual

Overridden from base class.

Implements sf::ScanBinder.

Friends And Related Symbol Documentation

◆ BinderCommonPropertyPage

friend class BinderCommonPropertyPage

friend

◆ CheckPositionsPropertyPage

friend class CheckPositionsPropertyPage

friend

◆ DefaultBinderConfigPropertyPage

friend class DefaultBinderConfigPropertyPage

friend

◆ DefaultBinderProjectPropertyPage

friend class DefaultBinderProjectPropertyPage

friend

◆ DefaultBinderPropertyPage

friend class DefaultBinderPropertyPage

friend

◆ SelectCurrentPositionDialog

friend class SelectCurrentPositionDialog

friend

◆ StagePosition

friend class StagePosition

friend

Member Data Documentation

◆ _afterStopState

EState sf::DefaultScanBinder::_afterStopState

State to set when motion stops.

◆ _balanceState

EBalance sf::DefaultScanBinder::_balanceState

Holds the balance state.

◆ _binderFrame

DefaultBinderFrame* sf::DefaultScanBinder::_binderFrame

Holds the special binder frame when it is created.

◆ _checkMoveConfirm

bool sf::DefaultScanBinder::_checkMoveConfirm

When enabled each position move wil be asked for7 confirmation.

◆ _checkOffset

Vector3D sf::DefaultScanBinder::_checkOffset

Holds the check offset for the project established during checking.

◆ _checkOffsetScanIndex

int sf::DefaultScanBinder::_checkOffsetScanIndex

Holds the scan index used for the last check offset.

◆ _clearCheckOffset

bool sf::DefaultScanBinder::_clearCheckOffset

When enabled a change in scan index will clear the offset.

◆ _current

const StagePosition sf::DefaultScanBinder::_current

Holds the current stage position when the scan binder is active.

◆ _handlerVariableEventImport

TVariableHandler<DefaultScanBinder> sf::DefaultScanBinder::_handlerVariableEventImport {this, &DefaultScanBinder::handleVariableEventImport}

Variable handler callback hook.

◆ _listenerList

ListenerList sf::DefaultScanBinder::_listenerList

Holds the listeners for this instance to auto removed at destruction.

◆ _manualPosition

CheckPosition sf::DefaultScanBinder::_manualPosition

Holds the last manual entered check position.

◆ _move

StagePosition sf::DefaultScanBinder::_move

Holds the step movement position when moving.

◆ _resume

StagePosition sf::DefaultScanBinder::_resume

Holds the coordinates where the controller was heading for.

◆ _resumeState

EState sf::DefaultScanBinder::_resumeState

State to set when motion stops.

◆ _scanning

struct sf::DefaultScanBinder::Scanning sf::DefaultScanBinder::_scanning

◆ _stopCoord

gmi::AxesCoord sf::DefaultScanBinder::_stopCoord

Holds the coordinates where the controller stopped.

◆ _target

StagePosition sf::DefaultScanBinder::_target

Holds the targeted stage position information.

◆ _traject

StagePositions sf::DefaultScanBinder::_traject

Holds the current trajectory of movements of the applied command.

◆ _trajectIndex

int sf::DefaultScanBinder::_trajectIndex

Holds the current traject index. Movement is enabled when set other than -1.

◆ _varsImport

Variable::PtrVector sf::DefaultScanBinder::_varsImport

Holds the imported variable pointers for iterations.

◆ FPositions

PositionList sf::DefaultScanBinder::FPositions

Holds the list of position.

◆ MAX_POSITIONS

constexpr int sf::DefaultScanBinder::MAX_POSITIONS {30}

staticconstexpr

Maximum amount of positions.

◆ Scanning

friend sf::DefaultScanBinder::Scanning

◆ vBalance

Variable sf::DefaultScanBinder::vBalance

For switching on balance and to detect when it is ready when it is reset.

◆ vBidirectional

Variable sf::DefaultScanBinder::vBidirectional

To signal bidirectional was switched on.

◆ vScanGainActive

Variable sf::DefaultScanBinder::vScanGainActive

To signal scan gain must be active.

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

DefaultScanBinder.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ StagePositions

Member Enumeration Documentation

◆ EBalance

◆ EBinderStage

◆ EMoveMode

◆ EPositionSource

◆ EScanningStage

Constructor & Destructor Documentation

◆ DefaultScanBinder()

◆ ~DefaultScanBinder()

Member Function Documentation

◆ abort()

◆ activate()

◆ addCalculatedTraject()

◆ addPropertyPages() [1/2]

◆ addPropertyPages() [2/2]

◆ CalcCheckOffset()

◆ CanMoveToCheckPosition()

◆ check()

◆ checkPos()

◆ checkScanPos()

◆ checkStagePos()

◆ clear()

◆ ControllerEventHandler()

◆ createScanInfo()

◆ doStoreConfig()

◆ evaluate()

◆ GetCheckOffset()

◆ GetCommonApproachCount()

◆ GetFrame()

◆ getGenericInfoList()

◆ getIndex()

◆ getInfo()

◆ getNextStep()

◆ getOffset()

◆ getScanInfo() [1/2]

◆ getScanInfo() [2/2]

◆ getScanPos()

◆ GetSetValue()

◆ GetSourceName()

◆ GetSourceValue()

◆ getStageName()

◆ getStagePos()

◆ handleVariableEventImport()

◆ initialize()

◆ moveTo() [1/2]

◆ moveTo() [2/2]

◆ MoveToCheckPosition() [1/3]

◆ MoveToCheckPosition() [2/3]

◆ MoveToCheckPosition() [3/3]

◆ moveToStage()

◆ queryCheckPosition()

◆ readProfile()

◆ resume()

◆ rotate()

◆ scanMoveTo()

◆ SetCheckOffset()

◆ setCurrentStage()

◆ setScanAxes()

◆ setTrigger()

◆ startScan()

◆ stateChange()

◆ stop()

◆ suspend()

◆ sustain()

◆ writeProfile()

Friends And Related Symbol Documentation

◆ BinderCommonPropertyPage

◆ CheckPositionsPropertyPage

◆ DefaultBinderConfigPropertyPage

◆ DefaultBinderProjectPropertyPage