Keeps the project and all scan areas to inspect. More...

#include <ProjectData.h>

Inheritance diagram for sf::ProjectData:

[legend]

Collaboration diagram for sf::ProjectData:

[legend]

Public Types
enum	EState { psNONE , psABORTED , psERROR , psDISABLED , psUNINITIALIZED , psINITIALIZING , psINITIALIZED , psINITFAILED , psREADY , psPREPARING , psPREPARED , psTOOLCHANGING , psTOOLCHANGED , psAPPROACHING , psAPPROACHED , psCHECKING , psCHECKED , psSCANNING , psSCANNED , psDATASAVING , psDATASAVED , psEVALUATING , psEVALUATED , psREPORTING , psREPORTED , psRETREATING , psRETREATED , psFINISHING , psFINISHED , psSUSPENDING , psSUSPENDED , psSTOPPING , psSTOPPED , psMOVING , psMOVED , psRESETTING , psRESUMING , psACCOMMODATING , psACCOMMODATED , psLASTENTRY }
	Project states in the machine. More...

enum	Color : int { cFrontWall = 0 , cBackWall , cFocusArea , cLastEntry }
	Available project colors for displaying inspection areas. 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
	ProjectData ()
	Default constructor.

	~ProjectData () override
	Virtual overridden destructor.

void	debug ()
	Just for development and debugging.

void	addPropertyPages (PropertySheetDialog *sheet)
	Adds the project property pages to the given property sheet.

void	addModulePropertyPages (PropertySheetDialog *sheet)
	Add the module property pages from this project to the given property sheet.

bool	read (std::istream &is)
	Reads the project from the stream.

bool	write (std::ostream &os)
	Writes the project information to the output stream.

bool	isValidPart ()
	Check if the part this project data is referring to is valid.

QString	getStateName ()
	Gets the name of the current state the project is in.

ScanEntry *	addScan ()
	Gets a pointer to a newly created scan entry instance.

bool	initialize ()
	Initializes or reinitializes the project binder and all its scans.

bool	start (unsigned index)
	Start scanning at the specified index in the list of scans.

bool	evaluate (unsigned index, int file_index=-1)
	Starts evaluating.

bool	moveToSysPos (ESystemPosition sp)
	Makes the manipulator move to a predefined system position.

bool	moveToQuery (int scan)
	Queries for a surface position by the user.

bool	moveTo (int scan, int index, double frac=0.0, bool perp=false)
	Moves controller to the location on the surface of a scan area.

bool	activate (unsigned index)
	Activates the scan method. This makes the mode export its variables. Only one scan method is activated at a time.

bool	suspend ()
	Tries to signal the current scan to hold.

bool	stop ()
	Signals a stop to the current active scan method.

bool	abort ()
	Aborts the current active scan method immediately.

bool	rotate (int scan_entry)
	Starts rotating the scan axis if possible.

bool	isRotating ()
	Checks iof the rotating axis is rotating currently.

bool	finalize (int lock=0)
	Finalizes the project so it is locked for changes. When the argument lock is non-zero, regardless force is used. When the argument lock is -1, the inspection is unlocked and 1 to lock.

bool	isFinalized () const
	Checks if the project is finalized.

bool	canInitialize ()
	Checks if it is possible to 'Initialize' at the current time.

bool	canStart (int scan_entry)
	Checks if it is possible to 'Start' at the current time.

bool	canStop ()
	Checks if it is possible to 'Stop' at the current time.

bool	canAbort ()
	Checks if it is possible to 'Abort' at the current time.

bool	canSuspend ()
	Checks if it is possible to 'Suspend' at the current time.

bool	canRotate (int scan_entry)
	Checks if it is possible to 'Rotate' at the current time.

bool	canEvaluate (int scan_entry)
	Checks if it is possible to 'Evaluate' at the current time.

bool	canFinalize (int lock=0)
	Checks if it is possible to 'finalize' at the current time. When the lock argument is non-zero, regardless force is used.

bool	canMoveTo ()
	Checks if the MoveTo function can be executed successfully.

void	clear ()
	Clears the all scan entries of the current project.

IniEnvelope	getScanIni (const QString &scan_area)
	Gets an ini file descendant with information about the scan area configuration.

ConfigStore	getPartStateIni ()
	Gets an ini file descendant with screen position information.

bool	isScanArea (const QString &name)
	Gets if the given scan area name exists.

void	removeScan (unsigned index)
	Removes the scan at the given index.

void	moveScan (unsigned src, unsigned dest)
	Moves the scan area in the list from the given source to a destination index.

void	swapScan (unsigned idx1, unsigned idx2)
	Swaps to scan entries in the list between the 3 given indices.

int	indexOf (ScanEntry *) const
	Gets the index in the scan entry in the list.

int	getScanListIndex (const ScanMethod *sm) const
	Gets scan method entry index in the scan list.

bool	disableProject (bool disable)
	Disables or enables a project when other is running.

bool	storeFilterList (bool rd)
	Read or writes the filter list file.

const TCalibrationSets &	getCalibrationSets ()
	Gets the calibration sets.

bool	shouldWaitForEvent ()
	Allows state machines to wait for a user event.

ScanEntry *	getActiveScan ()
	Gets the active scan.

int	getActiveScanIndex ()
	Gets the active scan entry index.

int	getSelectedScanIndex ()
	Gets the selected scan entry index.

void	setSelectedScanIndex (int index)
	Sets the selected scan entry index enter -1 for none.

ScanEntry *	getSelectedScan ()
	Gets the selected scan entry pointer.

double	getScanProgress ()
	Gets the progress of the current active scan.

QString	getScanBinderName ()
	Gets current scan-binder name.

void	setScanBinderName (const QString &name)
	Sets scan-binder name and so change the implementation.

ScanBinder *	getScanBinder ()
	Gets the Scan binder derived instance pointer of the implementation.

InformationTypes::id_type	getScanMethodIdOffset ()
	Gets the scan method id-offset for derived scan methods. Scan methods use the id-offset to determine the actual ids.

InformationTypes::id_type	getScanBinderIdOffset ()
	Gets the scan method ID offset for the derived scan binder. The scan binder uses the id-offset to determine the actual ids.

std::string	getNamePrefix ()
	Gets the name prefix of the exported parameters.

QString	getErrorText ()
	Gets the last error text set.

DataFilterList *	getFilterList ()
	Gets the selected or used filter list. (same as global for now)

QString	getMediumName ()
	Gets the medium name of the project like 'water'.

void	SetReportOptions (ReportOptions options)
	Sets the report options of the project.

ReportOptions	getReportOptions ()
	Gets the report options of the project.

QString	getReportTemplate ()
	Gets the report template file.

void	setReportTemplate (const QString &templ)
	Sets the report template file.

void	setPartProject (const PartProject *part_project)
	Assigment clears the scan list and sets the part name. This must be done before this instance can be used. Otherwise, the class cannot locate its resources.

PartProject *	getPartProject () const
	Gets the part-project pointer of the current project.

void	setPartInspection (const PartInspection *part_inspection)
	Sets the part-inspection of this project.

PartInspection *	getPartInspection () const
	Gets the part-inspection of this project.

void	setWidget (ProjectWidget *project_widget)
	Sets the frame.

ProjectWidget *	getWidget ()
	Gets the project's frame.

QWidget *	getViewerParent ()
	Gets the parent for the scan method viewers.

ScanEntry *	getScan (ssize_t index)
	Gets the scan entry pointer of the given index.

ssize_t	getScanCount ()
	Gets the number of scans in the current scan plan list.

EState	getState ()
	Gets the current state of the project data state machine.

QString	getStateName (int state)
	Gets the state-machine's name of the given state.

QString	getPart () const
	Gets the part name of the loaded project.

void	setDirty (bool tf=true)
	Set or resets the dirty flag. Calls attached method of the onDirty closure. When dirty, the project can be saved.

bool	isDirty () const
	Get the dirty flag.

ssize_t	getScanMethodCount ()
	Gets the number of available scan methods.

std::string	getScanMethodName (ssize_t index)
	Gets the name of the scan method at the given index.

const QColor &	getColor (Color color) const
	Gets the color corresponding with the given value.

const ConfigStore &	getConfigStore () const
	Gets a fresh copy of the config store.

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.

Public Attributes
TClosure< void, void * >	onDirty
	Closure method to notify changes on the dirty flag. The attached handler is called when a scan of the project has been modified.

Protected Member Functions
bool	sustain (const timespec &ts)
	Handler set using the _sustainEntry.

bool	process (const timespec &ts)
	Called from sustain.

bool	setError (const QString &error_text)
	Sets the error state and the SetState function to set the psERROR state. Called from process() to allow immediate returns.

bool	setState (EState state)
	Sets the new state.

void	attach (ScanEntry *entry)
	Called from the ScanEntry instance to attach itself to this project.

void	detach (ScanEntry *entry)
	Called from the ScanEntry instance to detach itself to this project.

bool	storeProfile (IniProfile &ini_profile, bool rd)
	Reads or writes all project data to or from the given ini-profile instance.

void	storeConfig (bool rd)
	Reads or writes the module configuration information.

bool	initializeScans ()
	Initializes all scan methods.

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

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

bool	startDataSaving ()
	Initiates the start of storing data.

bool	isDataSavingReady () const
	Checks is saving data is completed.

Protected Member Functions inherited from sf::ProjectScriptObject
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.

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.

Protected Attributes
TSustain< ProjectData >	_sustainEntry
	Hooks the sustain function into the sustain interface.

Friends
class	ScanEntry

class	ProjectDataPropertyPage

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

Detailed Description

Keeps the project and all scan areas to inspect.

Todo:: Move private data and functions into a private class so future changes do not break depended code.

Member Enumeration Documentation

◆ Color

enum sf::ProjectData::Color : int

Available project colors for displaying inspection areas.

Enumerator
cFrontWall
cBackWall
cFocusArea
cLastEntry

◆ EState

enum sf::ProjectData::EState

Project states in the machine.

Enumerator
psNONE	Used to indicate it was not set. Project is an aborted project.
psABORTED	Error occurred somewhere down the line.
psERROR
psDISABLED	When another project is running.
psUNINITIALIZED	Start of the state at project creation.
psINITIALIZING	Initializing scan methods.
psINITIALIZED	Initializing scan methods succeeded.
psINITFAILED	Project failed to initialize.
psREADY	Project is ready for action.
psPREPARING	Prepare a project for the next scan area.
psPREPARED	Project is prepared for the next scan area.
psTOOLCHANGING	Project is moving to the tool change tool position.
psTOOLCHANGED
psAPPROACHING	Binder is approaching to scan the start position.
psAPPROACHED
psCHECKING	Scan method is in check positions mode.
psCHECKED
psSCANNING	Scan method is scanning.
psSCANNED
psDATASAVING	Scan data is being saved.
psDATASAVED	Scan data has been saved. Scan method is evaluating.
psEVALUATING
psEVALUATED
psREPORTING	Scan method is reporting.
psREPORTED	finished reporting.
psRETREATING	Binder is retreating from the stop position.
psRETREATED
psFINISHING	Project is finishing on the scan area.
psFINISHED
psSUSPENDING	Project is waiting for scan to go into suspend state.
psSUSPENDED	Project is suspended.
psSTOPPING	Project is stopping prematurely.
psSTOPPED
psMOVING	Project is doing a system move.
psMOVED
psRESETTING	Resetting the manipulator and scan binder.
psRESUMING	Project is trying to resume from a stop.
psACCOMMODATING	Project is moving to the programmed system position.
psACCOMMODATED	Project arrived at the programmed system position.
psLASTENTRY

Constructor & Destructor Documentation

◆ ProjectData()

sf::ProjectData::ProjectData ( )

Default constructor.

◆ ~ProjectData()

sf::ProjectData::~ProjectData ( )

override

Virtual overridden destructor.

Member Function Documentation

◆ abort()

bool sf::ProjectData::abort ( )

Aborts the current active scan method immediately.

◆ activate()

bool sf::ProjectData::activate ( unsigned index )

Activates the scan method. This makes the mode export its variables. Only one scan method is activated at a time.

Parameters

index Scan entry by index/row to activate.

Returns: True on success.

◆ addModulePropertyPages()

void sf::ProjectData::addModulePropertyPages ( PropertySheetDialog * sheet )

Add the module property pages from this project to the given property sheet.

◆ addPropertyPages()

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

Adds the project property pages to the given property sheet.

◆ addScan()

ScanEntry * sf::ProjectData::addScan ( )

Gets a pointer to a newly created scan entry instance.

◆ attach()

void sf::ProjectData::attach ( ScanEntry * entry )

protected

Called from the ScanEntry instance to attach itself to this project.

Parameters

entry Scan entry.

◆ canAbort()

bool sf::ProjectData::canAbort ( )

Checks if it is possible to 'Abort' at the current time.

Returns: True when it can.

◆ canEvaluate()

bool sf::ProjectData::canEvaluate ( int scan_entry )

Checks if it is possible to 'Evaluate' at the current time.

Returns: True when it can.

◆ canFinalize()

bool sf::ProjectData::canFinalize ( int lock = 0 )

Checks if it is possible to 'finalize' at the current time. When the lock argument is non-zero, regardless force is used.

Returns: True when it can.

◆ canInitialize()

bool sf::ProjectData::canInitialize ( )

Checks if it is possible to 'Initialize' at the current time.

Returns: True when it can.

◆ canMoveTo()

bool sf::ProjectData::canMoveTo ( )

Checks if the MoveTo function can be executed successfully.

Returns: True when allowed.

◆ canRotate()

bool sf::ProjectData::canRotate ( int scan_entry )

Checks if it is possible to 'Rotate' at the current time.

Returns: True when it can.

◆ canStart()

bool sf::ProjectData::canStart ( int scan_entry )

Checks if it is possible to 'Start' at the current time.

Returns: True when it can.

◆ canStop()

bool sf::ProjectData::canStop ( )

Checks if it is possible to 'Stop' at the current time.

Returns: True when it can.

◆ canSuspend()

bool sf::ProjectData::canSuspend ( )

Checks if it is possible to 'Suspend' at the current time.

Returns: True when it can.

◆ clear()

void sf::ProjectData::clear ( )

Clears the all scan entries of the current project.

◆ debug()

void sf::ProjectData::debug ( )

Just for development and debugging.

◆ detach()

void sf::ProjectData::detach ( ScanEntry * entry )

protected

Called from the ScanEntry instance to detach itself to this project.

Parameters

entry Scan entry.

◆ disableProject()

bool sf::ProjectData::disableProject ( bool disable )

Disables or enables a project when other is running.

Parameters

disable Set true to disable.

Returns: True when successful.

◆ evaluate()

bool sf::ProjectData::evaluate	(	unsigned	index,
		int	file_index = `-1`
	)

Starts evaluating.

Parameters

index
file_index

Returns

◆ finalize()

bool sf::ProjectData::finalize ( int lock = 0 )

Finalizes the project so it is locked for changes. When the argument lock is non-zero, regardless force is used. When the argument lock is -1, the inspection is unlocked and 1 to lock.

Parameters

lock

Returns: True on success.

◆ getActiveScan()

ScanEntry * sf::ProjectData::getActiveScan ( )

Gets the active scan.

Returns: nullptr when not active.

◆ getActiveScanIndex()

int sf::ProjectData::getActiveScanIndex ( )

Gets the active scan entry index.

Returns: -1 when not active.

◆ getCalibrationSets()

const TCalibrationSets & sf::ProjectData::getCalibrationSets ( )

Gets the calibration sets.

◆ getColor()

const QColor & sf::ProjectData::getColor ( Color color ) const

Gets the color corresponding with the given value.

◆ getConfigStore()

const ConfigStore & sf::ProjectData::getConfigStore ( ) const

Gets a fresh copy of the config store.

◆ getErrorText()

QString sf::ProjectData::getErrorText ( )

Gets the last error text set.

◆ getFilterList()

DataFilterList * sf::ProjectData::getFilterList ( )

Gets the selected or used filter list. (same as global for now)

◆ getInfo()

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

overrideprotectedvirtual

Overridden from base class ProjectScriptObject.

Implements sf::ScriptObject.

◆ getMediumName()

QString sf::ProjectData::getMediumName ( )

Gets the medium name of the project like 'water'.

◆ getNamePrefix()

std::string sf::ProjectData::getNamePrefix ( )

Gets the name prefix of the exported parameters.

◆ getPart()

QString sf::ProjectData::getPart ( ) const

Gets the part name of the loaded project.

◆ getPartInspection()

PartInspection * sf::ProjectData::getPartInspection ( ) const

Gets the part-inspection of this project.

◆ getPartProject()

PartProject * sf::ProjectData::getPartProject ( ) const

Gets the part-project pointer of the current project.

◆ getPartStateIni()

ConfigStore sf::ProjectData::getPartStateIni ( )

Gets an ini file descendant with screen position information.

◆ getReportOptions()

ReportOptions sf::ProjectData::getReportOptions ( )

Gets the report options of the project.

◆ getReportTemplate()

QString sf::ProjectData::getReportTemplate ( )

Gets the report template file.

◆ getScan()

ScanEntry * sf::ProjectData::getScan ( ssize_t index )

Gets the scan entry pointer of the given index.

Parameters

index Index to retrieve.

Returns: Scan entry pointer.

◆ getScanBinder()

ScanBinder * sf::ProjectData::getScanBinder ( )

Gets the Scan binder derived instance pointer of the implementation.

◆ getScanBinderIdOffset()

InformationTypes::id_type sf::ProjectData::getScanBinderIdOffset ( )

Gets the scan method ID offset for the derived scan binder. The scan binder uses the id-offset to determine the actual ids.

◆ getScanBinderName()

QString sf::ProjectData::getScanBinderName ( )

Gets current scan-binder name.

◆ getScanCount()

ssize_t sf::ProjectData::getScanCount ( )

Gets the number of scans in the current scan plan list.

◆ getScanIni()

IniEnvelope sf::ProjectData::getScanIni ( const QString & scan_area )

Gets an ini file descendant with information about the scan area configuration.

Parameters

scan_area

Returns: Wrapper.

◆ getScanListIndex()

int sf::ProjectData::getScanListIndex ( const ScanMethod * sm ) const

Gets scan method entry index in the scan list.

Parameters

sm	Scan method pointer to find.

Returns: -1 when not found.

◆ getScanMethodCount()

ssize_t sf::ProjectData::getScanMethodCount ( )

Gets the number of available scan methods.

◆ getScanMethodIdOffset()

InformationTypes::id_type sf::ProjectData::getScanMethodIdOffset ( )

Gets the scan method id-offset for derived scan methods. Scan methods use the id-offset to determine the actual ids.

◆ getScanMethodName()

std::string sf::ProjectData::getScanMethodName ( ssize_t index )

Gets the name of the scan method at the given index.

Parameters

index Scan method list index.

Returns: Name of the scan method.

◆ getScanProgress()

double sf::ProjectData::getScanProgress ( )

Gets the progress of the current active scan.

Returns: Number between 0-1000 and when not active -1.

◆ getSelectedScan()

ScanEntry * sf::ProjectData::getSelectedScan ( )

Gets the selected scan entry pointer.

Returns: nullptr when not active.

◆ getSelectedScanIndex()

int sf::ProjectData::getSelectedScanIndex ( )

Gets the selected scan entry index.

Returns: -1 if none is selected.

◆ getSetValue()

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

overrideprotectedvirtual

Overridden from base class ProjectScriptObject.

Implements sf::ScriptObject.

◆ getState()

EState sf::ProjectData::getState ( )

Gets the current state of the project data state machine.

◆ getStateName() [1/2]

QString sf::ProjectData::getStateName ( )

Gets the name of the current state the project is in.

◆ getStateName() [2/2]

QString sf::ProjectData::getStateName ( int state )

Gets the state-machine's name of the given state.

◆ getViewerParent()

QWidget * sf::ProjectData::getViewerParent ( )

Gets the parent for the scan method viewers.

◆ getWidget()

ProjectWidget * sf::ProjectData::getWidget ( )

Gets the project's frame.

Returns: When it does not, it returns nullptr.

◆ indexOf()

int sf::ProjectData::indexOf ( ScanEntry * ) const

Gets the index in the scan entry in the list.

Returns: -1 when not found.

◆ initialize()

bool sf::ProjectData::initialize ( )

Initializes or reinitializes the project binder and all its scans.

◆ initializeScans()

bool sf::ProjectData::initializeScans ( )

protected

Initializes all scan methods.

Returns: True when it succeeded to initialize all entries.

◆ isDataSavingReady()

bool sf::ProjectData::isDataSavingReady ( ) const

protected

Checks is saving data is completed.

Returns: True when done.

◆ isDirty()

bool sf::ProjectData::isDirty ( ) const

Get the dirty flag.

Returns: True when dirty.

◆ isFinalized()

bool sf::ProjectData::isFinalized ( ) const

Checks if the project is finalized.

Returns: True when finalized.

◆ isRotating()

bool sf::ProjectData::isRotating ( )

Checks iof the rotating axis is rotating currently.

Returns: True when rotating.

◆ isScanArea()

bool sf::ProjectData::isScanArea ( const QString & name )

Gets if the given scan area name exists.

Parameters

name	Name of the scan area.

Returns: True when it exists.

◆ isValidPart()

bool sf::ProjectData::isValidPart ( )

Check if the part this project data is referring to is valid.

◆ moveScan()

void sf::ProjectData::moveScan	(	unsigned	src,
		unsigned	dest
	)

Moves the scan area in the list from the given source to a destination index.

Parameters

src	Source index.
dest	Destination index.

◆ moveTo()

bool sf::ProjectData::moveTo	(	int	scan,
		int	index,
		double	frac = `0.0`,
		bool	perp = `false`
	)

Moves controller to the location on the surface of a scan area.

Parameters

scan	Targeted scan area by list index.
index	Targeted measurement index of the scanned area.
frac	Targeted measurement fraction of the scanned area.
perp	Ignore the angle and move perpendicular to the surface.

Returns: True on succes to start moving.

◆ moveToQuery()

bool sf::ProjectData::moveToQuery ( int scan )

Queries for a surface position by the user.

Parameters

scan

Returns: True on succes to start moving.

◆ moveToSysPos()

bool sf::ProjectData::moveToSysPos ( ESystemPosition sp )

Makes the manipulator move to a predefined system position.

Parameters

sp	Designated system position.

Returns: true on success to execute.

◆ process()

bool sf::ProjectData::process ( const timespec & ts )

protected

Called from sustain.

Parameters

ts	Current time.

Returns: False when an error occurred.

◆ read()

bool sf::ProjectData::read ( std::istream & is )

Reads the project from the stream.

Parameters

is	Input stream.

Returns: True on success.

◆ removeScan()

void sf::ProjectData::removeScan ( unsigned index )

Removes the scan at the given index.

Parameters

index Scan index in the list.

◆ rotate()

bool sf::ProjectData::rotate ( int scan_entry )

Starts rotating the scan axis if possible.

Parameters

scan_entry

◆ setDirty()

void sf::ProjectData::setDirty ( bool tf = true )

Set or resets the dirty flag. Calls attached method of the onDirty closure. When dirty, the project can be saved.

Parameters

tf	Default is true.

◆ setError()

bool sf::ProjectData::setError ( const QString & error_text )

protected

Sets the error state and the SetState function to set the psERROR state. Called from process() to allow immediate returns.

Parameters

error_text Error text.

Returns: Always false.

◆ setPartInspection()

void sf::ProjectData::setPartInspection ( const PartInspection * part_inspection )

Sets the part-inspection of this project.

◆ setPartProject()

void sf::ProjectData::setPartProject ( const PartProject * part_project )

Assigment clears the scan list and sets the part name. This must be done before this instance can be used. Otherwise, the class cannot locate its resources.

Parameters

part_project

◆ SetReportOptions()

void sf::ProjectData::SetReportOptions ( ReportOptions options )

Sets the report options of the project.

Parameters

options

◆ setReportTemplate()

void sf::ProjectData::setReportTemplate ( const QString & templ )

Sets the report template file.

Parameters

templ

◆ setScanBinderName()

void sf::ProjectData::setScanBinderName ( const QString & name )

Sets scan-binder name and so change the implementation.

Parameters

name

◆ setSelectedScanIndex()

void sf::ProjectData::setSelectedScanIndex ( int index )

Sets the selected scan entry index enter -1 for none.

◆ setState()

bool sf::ProjectData::setState ( EState state )

protected

Sets the new state.

Parameters

state New state.

Returns: True if the state was set successfully.

◆ setWidget()

void sf::ProjectData::setWidget ( ProjectWidget * project_widget )

Sets the frame.

Parameters

project_widget

◆ shouldWaitForEvent()

bool sf::ProjectData::shouldWaitForEvent ( )

Allows state machines to wait for a user event.

Returns: True when to wait for it.

◆ start()

bool sf::ProjectData::start ( unsigned index )

Start scanning at the specified index in the list of scans.

Parameters

index

Returns: true if the state allows it.

◆ startDataSaving()

bool sf::ProjectData::startDataSaving ( )

protected

Initiates the start of storing data.

Returns: True when successful.

◆ stop()

bool sf::ProjectData::stop ( )

Signals a stop to the current active scan method.

◆ storeConfig()

void sf::ProjectData::storeConfig ( bool rd )

protected

Reads or writes the module configuration information.

Parameters

rd	True to read and false to write.

◆ storeFilterList()

bool sf::ProjectData::storeFilterList ( bool rd )

Read or writes the filter list file.

Parameters

rd	True to read, false to write.

Returns: True on successful.

◆ storeProfile()

bool sf::ProjectData::storeProfile	(	IniProfile &	ini_profile,
		bool	rd
	)

protected

Reads or writes all project data to or from the given ini-profile instance.

Parameters

ini_profile
rd	True to read and false to write.

Returns: True on success.

◆ suspend()

bool sf::ProjectData::suspend ( )

Tries to signal the current scan to hold.

Returns: true if the current active scan method supported the function and if it successfully signaled the scan method process.

◆ sustain()

bool sf::ProjectData::sustain ( const timespec & ts )

protected

Handler set using the _sustainEntry.

Parameters

ts	Current time.

Returns: True when it needs to be called again.

◆ swapScan()

void sf::ProjectData::swapScan	(	unsigned	idx1,
		unsigned	idx2
	)

Swaps to scan entries in the list between the 3 given indices.

Parameters

idx1	Index 1
idx2	Index 2

◆ write()

bool sf::ProjectData::write ( std::ostream & os )

Writes the project information to the output stream.

Parameters

os

Returns

Friends And Related Symbol Documentation

◆ ProjectDataPropertyPage

friend class ProjectDataPropertyPage

friend

◆ ScanEntry

friend class ScanEntry

friend

Member Data Documentation

◆ _sustainEntry

TSustain<ProjectData> sf::ProjectData::_sustainEntry

protected

Hooks the sustain function into the sustain interface.

◆ onDirty

TClosure<void, void*> sf::ProjectData::onDirty

Closure method to notify changes on the dirty flag. The attached handler is called when a scan of the project has been modified.

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

ProjectData.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Color

◆ EState

Constructor & Destructor Documentation

◆ ProjectData()

◆ ~ProjectData()

Member Function Documentation

◆ abort()

◆ activate()

◆ addModulePropertyPages()

◆ addPropertyPages()

◆ addScan()

◆ attach()

◆ canAbort()

◆ canEvaluate()

◆ canFinalize()

◆ canInitialize()

◆ canMoveTo()

◆ canRotate()

◆ canStart()

◆ canStop()

◆ canSuspend()

◆ clear()

◆ debug()

◆ detach()

◆ disableProject()

◆ evaluate()

◆ finalize()

◆ getActiveScan()

◆ getActiveScanIndex()

◆ getCalibrationSets()

◆ getColor()

◆ getConfigStore()

◆ getErrorText()

◆ getFilterList()

◆ getInfo()

◆ getMediumName()

◆ getNamePrefix()

◆ getPart()

◆ getPartInspection()

◆ getPartProject()

◆ getPartStateIni()

◆ getReportOptions()

◆ getReportTemplate()

◆ getScan()

◆ getScanBinder()

◆ getScanBinderIdOffset()

◆ getScanBinderName()

◆ getScanCount()

◆ getScanIni()

◆ getScanListIndex()

◆ getScanMethodCount()

◆ getScanMethodIdOffset()

◆ getScanMethodName()

◆ getScanProgress()

◆ getSelectedScan()

◆ getSelectedScanIndex()

◆ getSetValue()

◆ getState()

◆ getStateName() [1/2]

◆ getStateName() [2/2]

◆ getViewerParent()

◆ getWidget()

◆ indexOf()

◆ initialize()

◆ initializeScans()

◆ isDataSavingReady()

◆ isDirty()

◆ isFinalized()

◆ isRotating()

◆ isScanArea()

◆ isValidPart()