#include <ScanMethod.h>

Inheritance diagram for sf::ScanMethod:

[legend]

Collaboration diagram for sf::ScanMethod:

[legend]

Classes
struct	Parameters
	Mandatory structure for initialization of derived class. More...

Public Types
enum	EDefaultParamIndex { dpiINDEXCOUNT = 0 , dpiINDEXDENS = 1 , dpiSCANDENS = 2 , dpiSCANLEN = 3 , dpiDENSMODE = 4 , dpiANGLE_A = 5 , dpiANGLE_B = 6 , dpiSURFACEANGLE_A = 7 , dpiSURFACEANGLE_B = 8 , dpiGATEMODE = 10 , dpiDEPTH = 23 , dpiDEPTHFACTOR = 24 , dpiLAST = 0x100 }
	Default parameter ID indices for derived scan methods. More...

enum	ECommand : int { smcINIT , smcACTIVATE , smcDEACTIVATE , smcCHECK , smcSCAN , smcEVALUATE , smcSTOP , smcOFFSETCHANGE }
	Available commands. More...

enum	EState { smsCFGERR = -2 , smsERROR = -1 , smsNOINIT = 0 , smsREADY , smsACTIVE , smsCHECKING , smsSCANNING , smsEVALUATING , smsLASTENTRY }
	States of operation. 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
	ScanMethod (const Parameters &)
	Constructor for passing general structure for derived classes create by the class factory.

	~ScanMethod () override
	Virtual destructor for derived classes.

void	SetAreaName (const QString &name)
	Changes the area name so it is saved by the project under this new name.

QString	GetAreaName () const
	Gets the area name of the scan entry.

bool	DoInitialize ()
	Initializes the class after the constructor is called. Final virtual functions are only valid after full construction of a scan method. This function actually calls virtual function Initialize.

virtual void	DestroyViewer ()
	Called before a scan method is deleted.

virtual std::ostream &	cout ()
	Gets an output stream to print error or no error information to std::cout. Which can be overridden to a local one.

bool	Execute (ECommand cmd)
	Calls HandleCommand() after several checks.

ECommand	GetCommand ()
	Gets the last Issued command.

void	DoAddPropertyPages (PropertySheetDialog *sheet)
	Calls AddPropertyPages if the state allows it.

void	SetIndexFracRange (double start, double stop)
	Sets the new scan range for a defined surface.

int	GetIndexCount () const
	Gets the number of indices in the scan method.

int	GetIndexStart () const
	Gets the clipped start value of the set range.

int	GetIndexStop () const
	Gets the clipped stop value of the set range.

int	GetScanListIndex () const
	Returns the scan list index of this instance in the project.

bool	Reinitialize ()
	When the state is ready, the scan method can be reinitialize. For example, after changes are made to settings.

void	DoRead (IniEnvelope ini)
	Reads the settings of the scan method. Calls eventually the overridden Read() method.

void	DoWrite (IniEnvelope ini)
	Writes the settings of the scan method. Calls eventually the overridden Write() method.

void	LoadSystemSettings (const QString &settings={})
	Loads the system setting associated with the scan method overriding the settings from the selected calibration set.

bool	SaveSystemSettings (const QString &settings)
	Saves the system setting associated with the scan method.

bool	IsActivated () const
	Check if the scan method was activated.

bool	DoSustain (const timespec &)
	Called by the inspection project to enable the derived class to do some background processing.

bool	DoCreateFrame ()
	Creates a scan method UI frame if possible. Calls the overridden createViewer() method.

bool	DoConvertPosition (gmi::AxesCoord &dest, const gmi::AxesCoord &src, bool to_focus) const
	Converts a physical position to or from a focus position using the scan's configuration. Actually calls the overridden ConvertPosition() method.

bool	DoGetIndexPos (gmi::AxesCoord &pos, int index, double frac, bool perp) const
	Gets the axes' position calculated by the derived scan mode. Actually calls the overridden GetIndexPos() method.

bool	DoGetFocusPos (gmi::AxesCoord &dest, int index, double frac) const
	Gets the focus position calculated by the derived scan mode. Actually calls the overridden GetFocusPos() method.

bool	DoGetIndexVel (gmi::AxesCoord &dest, int index) const
	Gets the velocity calculated by the derived scan mode.

bool	DoGetMeasureOffset (Vector3D &vector, int index, double frac, bool perp) const
	Gets the vector caused by changing measurement offsets. This means the offset caused by the A-scan delay change.

bool	DoSetAcqParams (int index, double frac)
	Calls the overridden SetAcqParams() method on the derived class.

bool	DoGetTriggerValue (gmi::AxisValue &value) const
	Gets the axis used for triggering measurements or when the axis location is gmi::EAxisLocation::alNA the internal generation is to be used. Calls the overridden GetTriggerValue() method.

gmi::EAxisLocation	DoGetScanAxis () const
	Gets the scan and index axis for position calculations. Calls the overridden GetScanAxis() method.

bool	GetScanStart (gmi::AxesCoord &ac) const
	Gets the position coordinate where the project passes control to the scan method.

bool	GetScanStop (gmi::AxesCoord &ac) const
	Gets the position where the scan method passes control to the project.

const gmi::AxesCoord &	GetScanVelocity () const
	Gets the velocity for the scan method to move. Actually calls the scan binder method sf::ScanBinder::GetVelocity().

const gmi::AxesCoord &	GetScanAcceleration () const
	Gets the acceleration for the scan method to move. Actually calls the scan binder method sf::ScanBinder::GetVelocity().

const ScanBinder::InfoBase *	GetScanInfo () const
	Gets the binder information of this scan method instance.

const Vector3D &	GetScanOffset () const
	Gets the offset of the part to its programmed position.

Vector3D	GetOffset () const
	Gets the total offsets added.

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

const Variable &	GetMaterialVelocity () const
	Gets the material sound velocity system variable.

bool	GetRefractionAngle (double &dest, double src, bool to_medium=true)
	Gets the refracted angle.

TDataFilterLinks &	GetFilterLinks ()
	Gets the analysis filter links.

bool	ExecuteFilters (TDataFilterEntry::EAction action=TDataFilterEntry::feaSTART)
	Execute the referenced filters.

const std::vector< int > &	GetUsedDevices () const
	Gets the acquisition devices used.

bool	IsCalibReady ()
	Checks if the calibration is complete.

void	SetAcqState (InformationServer::EState sel_state, InformationServer::EState unsel_state=InformationServer::issOff)
	Sets the state on all acquisition devices.

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

virtual void	HandleCursorEvent (bool btn_down, Qt::KeyboardModifiers shift, int index, double frac)
	Can be overridden to handle cursor events when the scan is selected in the project.

ProjectData *	GetProjectData ()
	Gets the project this instance is part of.

const std::string &	GetMethodName () const
	Gets this method's name.

QString	GetDirectiveText () const
	Gets the directive text.

bool	GetDirectiveEnabled () const
	Gets the flag weather the directive is enabled.

ESystemPosition	GetDirectivePosition ()
	??

QString	GetElementName ()
	Gets the element name.

QString	GetToolName ()
	Gets the tool name.

QString	GetMaterialName ()
	Gets the material name.

QString	GetSettingsName () const
	Gets the settings name.

std::string	GetNamePrefix () const
	Gets the name prefix.

ECalibrationType	GetCalibrationType ()
	Gets the calibration type name.

QString	GetCalibrationSetName () const
	Gets the calibration set name.

InformationTypes::IdVector &	GetCalibrationIds ()
	Gets the calibration ids.

std::string	GetFilterConfigs ()
	Gets the comma-separated string of filter configuration names.

Variable::PtrVector &	GetLocalVars ()
	Gets the local variables in a pointer vector.

QWidget *	getViewer ()
	Called by a derived class to get its UI widget pointer.

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 const char *	GetStateName (EState)
	Gets the state name of the given state value.

static const char *	GetCommandName (ECommand)
	Gets the command name of the given command value.

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

Protected Member Functions
ConfigStore &	GetSaveState ()
	Gets the config store for saving and restoring the state of a frame. It is probably in the projects ini-profile.

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

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

virtual bool	createViewer ()
	Creates a scan method UI frame if possible. Can be overridden by a derived class.

virtual bool	ConvertPosition (gmi::AxesCoord &dest, const gmi::AxesCoord &src, bool to_focus) const =0
	Converts a physical position to or from a focus position using the scan's configuration.

virtual ScriptLink *	GetScriptLink ()
	Gets the script link when one is associated. Can be overridden by a derived class.

virtual void	StateChange (EState prev, EState cur)=0
	Is called when the current state changes for a derived class to act up on. Must be overridden by a derived class.

virtual bool	Initialize ()=0
	Initializes the scan method. Must be overridden by a derived class.

virtual void	Read (IniProfile *inifile)=0
	Reads the settings from the passed inifile.

virtual void	Write (IniProfile *inifile)=0
	Writes the settings to the passed inifile.

virtual bool	GetGenericInfoList (StringList &)=0
	Gets the list of linked variables or results. Must be overridden in a derived class.

virtual bool	Sustain (const timespec &ts)
	Can be overridden to do background processing.

virtual bool	HandleCommand (ECommand cmd)=0
	Handles the command given by Execute(). Must be overridden in a derived class.

virtual bool	GetIndexPos (gmi::AxesCoord &pos, int index, double frac, bool perp)=0
	Gets the axes' position of specified index and scan fraction. Must be overridden in a derived class.

virtual bool	GetFocusPos (gmi::AxesCoord &dest, int index, double frac)=0
	Gets the focus position of the specified index and scan fraction. Must be overridden in a derived class.

virtual bool	GetIndexVel (gmi::AxesCoord &dest, int index)=0
	Gets the velocity calculated by the derived scan mode. Must be overridden in a derived class.

virtual bool	GetTriggerValue (gmi::AxisValue &value)=0
	Gets the axis used for triggering measurements or when the axis location is gmi::EAxisLocation::alNA the internal generation is to be used. Must be overridden in a derived class.

virtual gmi::EAxisLocation	GetScanAxis ()=0
	Gets the scan and index axis for position calculations. Must be overridden by a derived class.

virtual bool	SetAcqParams (int index, double frac)=0
	Sets the project acquisition parameters/variables based on the passed index. Must be overridden by a derived class.

virtual void	AddPropertyPages (PropertySheetDialog *sheet)
	Adds scan method-specific property pages to the passed sheet. Can be overridden by a derived class.

virtual bool	GetMeasureOffset (Vector3D &vector, int index, double frac, bool perp)
	Gets the vector caused by changing measurement offsets. This means the offset caused by the A-scan delay change. Can be overridden by a derived class.

bool	FilterHandler (TDataFilterLink *, EFilterNotifyCode fnc)
	Event handler for filter events which are passed to the scan method script.

bool	UpdatePositionsData ()
	Refills the positions result.

bool	SetState (EState state)
	Sets the state.

void	setViewer (QWidget *viewer)
	Called by a derived class to set its frame pointer.

gmi::Controller *	GetController ()
	Gets the allocated controller.

bool	ClipTriggerValue (gmi::AxisValue &trigger_value)
	Clips a trigger value to a value which is allowed by the controller. Is to be used by property pages to fill in the correct values.

void	SetIndexCount (int idx_count)
	A derived classes uses this function to set the index count for the scan method initialization.

InformationTypes::id_type	GetIdOffset ()
	Gets the offset used to create the local ID's with for exporting.

OpenGLRenderer *	getModelRenderer () const
	Gets the OpenGL renderer which renders the model.

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.

Friends
class	ScanMethodPositionPropertyPage

class	ScanMethodConfigurationPropertyPage

class	ParamMappingPropertyPage

class	ProjectAnalysisPropertyPage

class	ScanMethodCalibrationPropertyPage

class	ScanMethodAcquisitionPropertyPage

class	ScanDirectivePropertyPage

Member Enumeration Documentation

◆ ECommand

enum sf::ScanMethod::ECommand : int

Available commands.

Enumerator
smcINIT	Initialize the scan method instance after properties have been set.
smcACTIVATE	Activate the scan method.
smcDEACTIVATE	Deactivate the scan method.
smcCHECK	Start checking by setting running mode.
smcSCAN	Start scan recording.
smcEVALUATE	Start scan evaluation by setting running mode.
smcSTOP	Stop scan recording.
smcOFFSETCHANGE	Handle the binder offset has changed.

◆ EDefaultParamIndex

enum sf::ScanMethod::EDefaultParamIndex

Default parameter ID indices for derived scan methods.

Enumerator
dpiINDEXCOUNT	Number of index steps.
dpiINDEXDENS	Index density.
dpiSCANDENS	Scan width or length.
dpiSCANLEN	Scan width or length.
dpiDENSMODE	Density mode where 0 = Static and 1 = Dynamic.
dpiANGLE_A	Angle A in the material.
dpiANGLE_B	Angle B in the material.
dpiSURFACEANGLE_A	Angle A on the surface.
dpiSURFACEANGLE_B	Angle B on the surface.
dpiGATEMODE	Positioning of the gates.
dpiDEPTH	Actual depth into to the material perpendicular to the surface.
dpiDEPTHFACTOR	Factor between depth and material distance.
dpiLAST	First index to use in derived classes for their parameters.

◆ EState

enum sf::ScanMethod::EState

States of operation.

Enumerator
smsCFGERR	Scan a configuration error.
smsERROR	Execution resulted in an error.
smsNOINIT	Scan has not been initialized.
smsREADY	Execution has finished successfully or can be activated.
smsACTIVE	Scan is activated.
smsCHECKING	Instance is in checking mode.
smsSCANNING	Instance is in scanning mode.
smsEVALUATING	Instance is in evaluation mode.
smsLASTENTRY	For proframming iterations.

Constructor & Destructor Documentation

◆ ScanMethod()

sf::ScanMethod::ScanMethod ( const Parameters & )

explicit

Constructor for passing general structure for derived classes create by the class factory.

◆ ~ScanMethod()

sf::ScanMethod::~ScanMethod ( )

override

Virtual destructor for derived classes.

Member Function Documentation

◆ AddPropertyPages()

virtual void sf::ScanMethod::AddPropertyPages ( PropertySheetDialog * sheet )

protectedvirtual

Adds scan method-specific property pages to the passed sheet. Can be overridden by a derived class.

Parameters

sheet

Todo:: make this method pure virtual by adding the page addition to AddPropertyPages() method.

Reimplemented in sf::ipj::CircleScanMethod, sf::ipj::LineScanMethod, sf::ipj::MeanderScanMethod, and sf::ipj::ToolBaseScanMethod.

◆ ClipTriggerValue()

bool sf::ScanMethod::ClipTriggerValue ( gmi::AxisValue & trigger_value )

protected

Clips a trigger value to a value which is allowed by the controller. Is to be used by property pages to fill in the correct values.

Parameters

trigger_value

Returns: True on success.

◆ ConvertPosition()

virtual bool sf::ScanMethod::ConvertPosition	(	gmi::AxesCoord &	dest,
		const gmi::AxesCoord &	src,
		bool	to_focus
	)		const

protectedpure virtual

Converts a physical position to or from a focus position using the scan's configuration.

Parameters

dest	Returns the focus coordinate.
src	Source physical coordinate.
to_focus	Direction focus or physical.

Returns: True on a succes.

Implemented in sf::ipj::MeanderScanMethod, and sf::ipj::ToolBaseScanMethod.

◆ cout()

virtual std::ostream & sf::ScanMethod::cout ( )

virtual

Gets an output stream to print error or no error information to std::cout. Which can be overridden to a local one.

Reimplemented in sf::ipj::MeanderScanMethod, sf::ipj::CircleScanMethod, and sf::ipj::LineScanMethod.

◆ createViewer()

virtual bool sf::ScanMethod::createViewer ( )

protectedvirtual

Creates a scan method UI frame if possible. Can be overridden by a derived class.

Returns: True when successful.

Reimplemented in sf::ipj::CircleScanMethod, sf::ipj::LineScanMethod, and sf::ipj::MeanderScanMethod.

◆ DestroyViewer()

virtual void sf::ScanMethod::DestroyViewer ( )

virtual

Called before a scan method is deleted.

◆ DoAddPropertyPages()

void sf::ScanMethod::DoAddPropertyPages ( PropertySheetDialog * sheet )

Calls AddPropertyPages if the state allows it.

Parameters

sheet Sheet to attach the pages to.

◆ DoConvertPosition()

bool sf::ScanMethod::DoConvertPosition	(	gmi::AxesCoord &	dest,
		const gmi::AxesCoord &	src,
		bool	to_focus
	)		const

Converts a physical position to or from a focus position using the scan's configuration. Actually calls the overridden ConvertPosition() method.

Parameters

dest	Returns the focus/physical coordinate.
src	Source physical/focus coordinate.
to_focus	Direction focus or physical.

Returns: True on a succes.

◆ DoCreateFrame()

bool sf::ScanMethod::DoCreateFrame ( )

Creates a scan method UI frame if possible. Calls the overridden createViewer() method.

◆ DoGetFocusPos()

bool sf::ScanMethod::DoGetFocusPos	(	gmi::AxesCoord &	dest,
		int	index,
		double	frac
	)		const

Gets the focus position calculated by the derived scan mode. Actually calls the overridden GetFocusPos() method.

Parameters

dest	Returns the position coordinate.
index	Measurement indexed position.
frac	Scan line fraction.

Returns: True on success.

◆ DoGetIndexPos()

bool sf::ScanMethod::DoGetIndexPos	(	gmi::AxesCoord &	pos,
		int	index,
		double	frac,
		bool	perp
	)		const

Gets the axes' position calculated by the derived scan mode. Actually calls the overridden GetIndexPos() method.

Parameters

pos	Returns the axes coordinated.
index	Measurement indexed position.
frac	Scan line fraction.
perp	When true, the perpendicular position, if possible, is returned.

Returns: True on success.

◆ DoGetIndexVel()

bool sf::ScanMethod::DoGetIndexVel	(	gmi::AxesCoord &	dest,
		int	index
	)		const

Gets the velocity calculated by the derived scan mode.

Parameters

dest	Returns the velocity coordinate.
index	Measurement indexed position.

Returns: True on success.

◆ DoGetMeasureOffset()

bool sf::ScanMethod::DoGetMeasureOffset	(	Vector3D &	vector,
		int	index,
		double	frac,
		bool	perp
	)		const

Gets the vector caused by changing measurement offsets. This means the offset caused by the A-scan delay change.

Parameters

vector
index	Measurement indexed position.
frac	Scan line fraction.
perp	When true, the perpendicular position, if possible, is returned.

Returns: True on success.

◆ DoGetScanAxis()

gmi::EAxisLocation sf::ScanMethod::DoGetScanAxis ( ) const

Gets the scan and index axis for position calculations. Calls the overridden GetScanAxis() method.

Returns: Scan axis location.

◆ DoGetTriggerValue()

bool sf::ScanMethod::DoGetTriggerValue ( gmi::AxisValue & value ) const

Gets the axis used for triggering measurements or when the axis location is gmi::EAxisLocation::alNA the internal generation is to be used. Calls the overridden GetTriggerValue() method.

Parameters

value Axis value.

Returns: True on success.

◆ DoInitialize()

bool sf::ScanMethod::DoInitialize ( )

Initializes the class after the constructor is called. Final virtual functions are only valid after full construction of a scan method. This function actually calls virtual function Initialize.

Returns: True on success.

◆ DoRead()

void sf::ScanMethod::DoRead ( IniEnvelope ini )

Reads the settings of the scan method. Calls eventually the overridden Read() method.

◆ DoSetAcqParams()

bool sf::ScanMethod::DoSetAcqParams	(	int	index,
		double	frac
	)

Calls the overridden SetAcqParams() method on the derived class.

Parameters

index	Measurement indexed position.
frac	Scan line fraction.

Returns: True on success.

◆ DoSustain()

bool sf::ScanMethod::DoSustain ( const timespec & )

Called by the inspection project to enable the derived class to do some background processing.

Returns: False when an exception is intercepted.

◆ DoWrite()

void sf::ScanMethod::DoWrite ( IniEnvelope ini )

Writes the settings of the scan method. Calls eventually the overridden Write() method.

◆ Execute()

bool sf::ScanMethod::Execute ( ECommand cmd )

Calls HandleCommand() after several checks.

Parameters

cmd	Command to handle.

Returns: True when successful.

◆ ExecuteFilters()

bool sf::ScanMethod::ExecuteFilters ( TDataFilterEntry::EAction action = TDataFilterEntry::feaSTART )

Execute the referenced filters.

Parameters

action Action to perform by the filter list.

Returns: True when successful.

◆ FilterHandler()

bool sf::ScanMethod::FilterHandler	(	TDataFilterLink *	,
		EFilterNotifyCode	fnc
	)

protected

Event handler for filter events which are passed to the scan method script.

Parameters

fnc	Notification code.

Returns: True on success.

◆ GetAreaName()

QString sf::ScanMethod::GetAreaName ( ) const

Gets the area name of the scan entry.

◆ GetCalibrationIds()

InformationTypes::IdVector & sf::ScanMethod::GetCalibrationIds ( )

inline

Gets the calibration ids.

◆ GetCalibrationSetName()

QString sf::ScanMethod::GetCalibrationSetName ( ) const

Gets the calibration set name.

◆ GetCalibrationType()

ECalibrationType sf::ScanMethod::GetCalibrationType ( )

Gets the calibration type name.

◆ GetCommand()

ECommand sf::ScanMethod::GetCommand ( )

Gets the last Issued command.

Returns: Command last issued.

◆ GetCommandName()

static const char * sf::ScanMethod::GetCommandName ( ECommand )

static

Gets the command name of the given command value.

◆ GetController()

gmi::Controller * sf::ScanMethod::GetController ( )

protected

Gets the allocated controller.

◆ GetDirectiveEnabled()

bool sf::ScanMethod::GetDirectiveEnabled ( ) const

Gets the flag weather the directive is enabled.

◆ GetDirectivePosition()

ESystemPosition sf::ScanMethod::GetDirectivePosition ( )

??

Todo:: Add comment what this function does.

◆ GetDirectiveText()

QString sf::ScanMethod::GetDirectiveText ( ) const

Gets the directive text.

◆ GetElementName()

QString sf::ScanMethod::GetElementName ( )

Gets the element name.

◆ GetFilterConfigs()

std::string sf::ScanMethod::GetFilterConfigs ( )

inline

Gets the comma-separated string of filter configuration names.

◆ GetFilterLinks()

TDataFilterLinks & sf::ScanMethod::GetFilterLinks ( )

inline

Gets the analysis filter links.

◆ GetFocusPos()

virtual bool sf::ScanMethod::GetFocusPos	(	gmi::AxesCoord &	dest,
		int	index,
		double	frac
	)

protectedpure virtual

Gets the focus position of the specified index and scan fraction. Must be overridden in a derived class.

Parameters

dest	Returns the position coordinate.
index	Measurement indexed position.
frac	Scan line fraction.

Returns: True when successful.

Implemented in sf::ipj::MeanderScanMethod, and sf::ipj::ToolBaseScanMethod.

◆ GetGenericInfoList()

virtual bool sf::ScanMethod::GetGenericInfoList ( StringList & )

protectedpure virtual

Gets the list of linked variables or results. Must be overridden in a derived class.

Implemented in sf::ipj::CircleScanMethod, sf::ipj::LineScanMethod, sf::ipj::MeanderScanMethod, and sf::ipj::ToolBaseScanMethod.

◆ GetIdOffset()

InformationTypes::id_type sf::ScanMethod::GetIdOffset ( )

protected

Gets the offset used to create the local ID's with for exporting.

◆ GetIndexCount()

int sf::ScanMethod::GetIndexCount ( ) const

Gets the number of indices in the scan method.

◆ GetIndexPos()

virtual bool sf::ScanMethod::GetIndexPos	(	gmi::AxesCoord &	pos,
		int	index,
		double	frac,
		bool	perp
	)

protectedpure virtual

Gets the axes' position of specified index and scan fraction. Must be overridden in a derived class.

Parameters

pos	Returns the axes coordinated.
index	Measurement indexed position.
frac	Scan line fraction.
perp	When true, the perpendicular position, if possible, is returned.

Returns: True ion success.

Implemented in sf::ipj::MeanderScanMethod, and sf::ipj::ToolBaseScanMethod.

◆ GetIndexStart()

int sf::ScanMethod::GetIndexStart ( ) const

Gets the clipped start value of the set range.

◆ GetIndexStop()

int sf::ScanMethod::GetIndexStop ( ) const

Gets the clipped stop value of the set range.

◆ GetIndexVel()

virtual bool sf::ScanMethod::GetIndexVel	(	gmi::AxesCoord &	dest,
		int	index
	)

protectedpure virtual

Gets the velocity calculated by the derived scan mode. Must be overridden in a derived class.

Parameters

dest	Returns the velocity coordinate.
index	Measurement indexed position.

Returns: True on success.

Implemented in sf::ipj::CircleScanMethod, sf::ipj::LineScanMethod, and sf::ipj::MeanderScanMethod.

◆ getInfo()

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

overrideprotectedvirtual

Overridden from base class sf::ProjectScriptObject.

Reimplemented from sf::ProjectScriptObject.

◆ GetLocalVars()

Variable::PtrVector & sf::ScanMethod::GetLocalVars ( )

inline

Gets the local variables in a pointer vector.

◆ GetMaterialName()

QString sf::ScanMethod::GetMaterialName ( )

Gets the material name.

◆ GetMaterialVelocity()

const Variable & sf::ScanMethod::GetMaterialVelocity ( ) const

Gets the material sound velocity system variable.

◆ GetMeasureOffset()

bool sf::ScanMethod::GetMeasureOffset	(	Vector3D &	vector,
		int	index,
		double	frac,
		bool	perp
	)

inlineprotectedvirtual

Gets the vector caused by changing measurement offsets. This means the offset caused by the A-scan delay change. Can be overridden by a derived class.

Parameters

vector
index	Measurement indexed position.
frac	Scan line fraction.
perp	When true, the perpendicular position, if possible, is returned.

Returns: True on success.

Reimplemented in sf::ipj::ToolBaseScanMethod.

◆ GetMediumVelocity()

const Variable & sf::ScanMethod::GetMediumVelocity ( ) const

Gets the medium sound velocity system variable.

◆ GetMethodName()

const std::string & sf::ScanMethod::GetMethodName ( ) const

Gets this method's name.

◆ getModelRenderer()

OpenGLRenderer * sf::ScanMethod::getModelRenderer ( ) const

protected

Gets the OpenGL renderer which renders the model.

Returns: When not there, nullptr.

◆ GetNamePrefix()

std::string sf::ScanMethod::GetNamePrefix ( ) const

Gets the name prefix.

◆ GetOffset()

Vector3D sf::ScanMethod::GetOffset ( ) const

Gets the total offsets added.

Returns: 3D Vector.

◆ GetProjectData()

ProjectData * sf::ScanMethod::GetProjectData ( )

Gets the project this instance is part of.

◆ GetRefractionAngle()

bool sf::ScanMethod::GetRefractionAngle	(	double &	dest,
		double	src,
		bool	to_medium = `true`
	)

Gets the refracted angle.

Parameters

dest	Receives the resulting angle.
src
to_medium

Returns

◆ GetSaveState()

ConfigStore & sf::ScanMethod::GetSaveState ( )

protected

Gets the config store for saving and restoring the state of a frame. It is probably in the projects ini-profile.

Returns: Reference to the config store.

◆ GetScanAcceleration()

const gmi::AxesCoord & sf::ScanMethod::GetScanAcceleration ( ) const

Gets the acceleration for the scan method to move. Actually calls the scan binder method sf::ScanBinder::GetVelocity().

Returns: Acceleration coordinate.

◆ GetScanAxis()

virtual gmi::EAxisLocation sf::ScanMethod::GetScanAxis ( )

protectedpure virtual

Gets the scan and index axis for position calculations. Must be overridden by a derived class.

Returns: Scan axis location.

Implemented in sf::ipj::CircleScanMethod, sf::ipj::LineScanMethod, and sf::ipj::MeanderScanMethod.

◆ GetScanInfo()

const ScanBinder::InfoBase * sf::ScanMethod::GetScanInfo ( ) const

Gets the binder information of this scan method instance.

◆ GetScanListIndex()

int sf::ScanMethod::GetScanListIndex ( ) const

Returns the scan list index of this instance in the project.

◆ GetScanOffset()

const Vector3D & sf::ScanMethod::GetScanOffset ( ) const

inline

Gets the offset of the part to its programmed position.

Returns

◆ GetScanStart()

bool sf::ScanMethod::GetScanStart ( gmi::AxesCoord & ac ) const

Gets the position coordinate where the project passes control to the scan method.

Parameters

ac	Returns the axes' coordinate.

Returns: True on success.

◆ GetScanStop()

bool sf::ScanMethod::GetScanStop ( gmi::AxesCoord & ac ) const

Gets the position where the scan method passes control to the project.

Parameters

ac	Returns the axes' coordinate.

Returns: True on success.

◆ GetScanVelocity()

const gmi::AxesCoord & sf::ScanMethod::GetScanVelocity ( ) const

Gets the velocity for the scan method to move. Actually calls the scan binder method sf::ScanBinder::GetVelocity().

Returns: Velocity coordinate.

◆ GetScriptLink()

virtual ScriptLink * sf::ScanMethod::GetScriptLink ( )

protectedvirtual

Gets the script link when one is associated. Can be overridden by a derived class.

Returns: nullptr since it is not implemented.

Reimplemented in sf::ipj::MeanderScanMethod.

◆ GetSettingsName()

QString sf::ScanMethod::GetSettingsName ( ) const

Gets the settings name.

◆ getSetValue()

bool sf::ScanMethod::getSetValue	(	const IdInfo *	info,
		Value *	value,
		Value::vector_type *	params,
		bool	flag_set
	)

overrideprotectedvirtual

Overridden from base class sf::ProjectScriptObject.

Reimplemented from sf::ProjectScriptObject.

◆ GetState()

EState sf::ScanMethod::GetState ( ) const

Gets the state of the instance.

◆ GetStateName()

static const char * sf::ScanMethod::GetStateName ( EState )

static

Gets the state name of the given state value.

◆ GetToolName()

QString sf::ScanMethod::GetToolName ( )

Gets the tool name.

◆ GetTriggerValue()

virtual bool sf::ScanMethod::GetTriggerValue ( gmi::AxisValue & value )

protectedpure virtual

Gets the axis used for triggering measurements or when the axis location is gmi::EAxisLocation::alNA the internal generation is to be used. Must be overridden in a derived class.

Parameters

value Axis value.

Returns: True on success.

Implemented in sf::ipj::MeanderScanMethod, sf::ipj::CircleScanMethod, and sf::ipj::LineScanMethod.

◆ GetUsedDevices()

const std::vector< int > & sf::ScanMethod::GetUsedDevices ( ) const

inline

Gets the acquisition devices used.

◆ getViewer()

QWidget * sf::ScanMethod::getViewer ( )

Called by a derived class to get its UI widget pointer.

◆ HandleCommand()

virtual bool sf::ScanMethod::HandleCommand ( ECommand cmd )

protectedpure virtual

Handles the command given by Execute(). Must be overridden in a derived class.

Parameters

cmd	Command to handle.

Returns: TRue on success.

Implemented in sf::ipj::CircleScanMethod, sf::ipj::LineScanMethod, and sf::ipj::MeanderScanMethod.

◆ HandleCursorEvent()

virtual void sf::ScanMethod::HandleCursorEvent	(	bool	btn_down,
		Qt::KeyboardModifiers	shift,
		int	index,
		double	frac
	)

inlinevirtual

Can be overridden to handle cursor events when the scan is selected in the project.

Parameters

btn_down	True when the button is down.
shift	Keyboard modifiers.
index	Measurement index position.
frac	Scan line fraction.

Reimplemented in sf::ipj::CircleScanMethod, and sf::ipj::LineScanMethod.

◆ Initialize()

virtual bool sf::ScanMethod::Initialize ( )

protectedpure virtual

Initializes the scan method. Must be overridden by a derived class.

Returns: True on success.

Implemented in sf::ipj::CircleScanMethod, sf::ipj::LineScanMethod, and sf::ipj::MeanderScanMethod.

◆ IsActivated()

bool sf::ScanMethod::IsActivated ( ) const

Check if the scan method was activated.

Returns: True when activated.

◆ IsCalibReady()

bool sf::ScanMethod::IsCalibReady ( )

Checks if the calibration is complete.

Returns: True when complete.

◆ LoadSystemSettings()

void sf::ScanMethod::LoadSystemSettings ( const QString & settings = {} )

Loads the system setting associated with the scan method overriding the settings from the selected calibration set.

Parameters

settings When left empty, this scan-method's assigned settings are used.

◆ Read()

virtual void sf::ScanMethod::Read ( IniProfile * inifile )

protectedpure virtual

Reads the settings from the passed inifile.

Parameters

inifile

Implemented in sf::ipj::MeanderScanMethod, sf::ipj::CircleScanMethod, sf::ipj::LineScanMethod, and sf::ipj::ToolBaseScanMethod.

◆ Reinitialize()

bool sf::ScanMethod::Reinitialize ( )

When the state is ready, the scan method can be reinitialize. For example, after changes are made to settings.

Returns: True if successful to change the state.

◆ SaveSystemSettings()

bool sf::ScanMethod::SaveSystemSettings ( const QString & settings )

Saves the system setting associated with the scan method.

Parameters

settings When left empty, this scan-method's assigned settings are used.

Returns: True on success.

◆ SetAcqParams()

virtual bool sf::ScanMethod::SetAcqParams	(	int	index,
		double	frac
	)

protectedpure virtual

Sets the project acquisition parameters/variables based on the passed index. Must be overridden by a derived class.

Parameters

index	Measurement indexed position.
frac	Scan line fraction.

Returns: True on success.

Implemented in sf::ipj::CircleScanMethod, sf::ipj::LineScanMethod, and sf::ipj::MeanderScanMethod.

◆ SetAcqState()

void sf::ScanMethod::SetAcqState	(	InformationServer::EState	sel_state,
		InformationServer::EState	unsel_state = `InformationServer::issOff`
	)

Sets the state on all acquisition devices.

Parameters

sel_state	State for the selected devices.
unsel_state	State for the unselected devices.

◆ SetAreaName()

void sf::ScanMethod::SetAreaName ( const QString & name )

Changes the area name so it is saved by the project under this new name.

Parameters

name New name.

◆ SetIndexCount()

void sf::ScanMethod::SetIndexCount ( int idx_count )

protected

A derived classes uses this function to set the index count for the scan method initialization.

Parameters

idx_count

◆ SetIndexFracRange()

void sf::ScanMethod::SetIndexFracRange	(	double	start,
		double	stop
	)

Sets the new scan range for a defined surface.

Parameters

start	Start fraction of the range.
stop	Stop fraction of the range.

◆ SetState()

bool sf::ScanMethod::SetState ( EState state )

protected

Sets the state.

Parameters

state

Returns: True when successfully set.

◆ setViewer()

void sf::ScanMethod::setViewer ( QWidget * viewer )

protected

Called by a derived class to set its frame pointer.

◆ StateChange()

virtual void sf::ScanMethod::StateChange	(	EState	prev,
		EState	cur
	)

protectedpure virtual

Is called when the current state changes for a derived class to act up on. Must be overridden by a derived class.

Parameters

prev	The previous state.
cur	The current state.

Implemented in sf::ipj::CircleScanMethod, sf::ipj::LineScanMethod, and sf::ipj::MeanderScanMethod.

◆ Sustain()

virtual bool sf::ScanMethod::Sustain ( const timespec & ts )

protectedvirtual

Can be overridden to do background processing.

Parameters

ts	Current time or time to act on.

Returns: When false is returned, the function is called no-longer.

Reimplemented in sf::ipj::CircleScanMethod, and sf::ipj::MeanderScanMethod.

◆ UpdatePositionsData()

bool sf::ScanMethod::UpdatePositionsData ( )

protected

Refills the positions result.

◆ Write()

virtual void sf::ScanMethod::Write ( IniProfile * inifile )

protectedpure virtual

Writes the settings to the passed inifile.

Parameters

inifile

Implemented in sf::ipj::MeanderScanMethod, sf::ipj::CircleScanMethod, sf::ipj::LineScanMethod, and sf::ipj::ToolBaseScanMethod.

Friends And Related Symbol Documentation

◆ ParamMappingPropertyPage

friend class ParamMappingPropertyPage

friend

◆ ProjectAnalysisPropertyPage

friend class ProjectAnalysisPropertyPage

friend

◆ ScanDirectivePropertyPage

friend class ScanDirectivePropertyPage

friend

◆ ScanMethodAcquisitionPropertyPage

friend class ScanMethodAcquisitionPropertyPage

friend

◆ ScanMethodCalibrationPropertyPage

friend class ScanMethodCalibrationPropertyPage

friend

◆ ScanMethodConfigurationPropertyPage

friend class ScanMethodConfigurationPropertyPage

friend

◆ ScanMethodPositionPropertyPage

friend class ScanMethodPositionPropertyPage

friend

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

ScanMethod.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Member Enumeration Documentation

◆ ECommand

◆ EDefaultParamIndex

◆ EState

Constructor & Destructor Documentation

◆ ScanMethod()

◆ ~ScanMethod()

Member Function Documentation

◆ AddPropertyPages()

◆ ClipTriggerValue()

◆ ConvertPosition()

◆ cout()

◆ createViewer()

◆ DestroyViewer()

◆ DoAddPropertyPages()

◆ DoConvertPosition()

◆ DoCreateFrame()

◆ DoGetFocusPos()

◆ DoGetIndexPos()

◆ DoGetIndexVel()

◆ DoGetMeasureOffset()

◆ DoGetScanAxis()

◆ DoGetTriggerValue()

◆ DoInitialize()

◆ DoRead()

◆ DoSetAcqParams()

◆ DoSustain()

◆ DoWrite()

◆ Execute()

◆ ExecuteFilters()

◆ FilterHandler()

◆ GetAreaName()

◆ GetCalibrationIds()

◆ GetCalibrationSetName()

◆ GetCalibrationType()

◆ GetCommand()

◆ GetCommandName()

◆ GetController()

◆ GetDirectiveEnabled()

◆ GetDirectivePosition()

◆ GetDirectiveText()

◆ GetElementName()

◆ GetFilterConfigs()

◆ GetFilterLinks()

◆ GetFocusPos()

◆ GetGenericInfoList()

◆ GetIdOffset()

◆ GetIndexCount()

◆ GetIndexPos()

◆ GetIndexStart()

◆ GetIndexStop()

◆ GetIndexVel()

◆ getInfo()

◆ GetLocalVars()

◆ GetMaterialName()

◆ GetMaterialVelocity()

◆ GetMeasureOffset()

◆ GetMediumVelocity()

◆ GetMethodName()

◆ getModelRenderer()

◆ GetNamePrefix()

◆ GetOffset()

◆ GetProjectData()

◆ GetRefractionAngle()

◆ GetSaveState()

◆ GetScanAcceleration()

◆ GetScanAxis()

◆ GetScanInfo()

◆ GetScanListIndex()

◆ GetScanOffset()

◆ GetScanStart()

◆ GetScanStop()

◆ GetScanVelocity()

◆ GetScriptLink()