Scanframe Modular Application 0.1.0
Loading...
Searching...
No Matches
sf::DefaultScanBinder::ScanInfo Struct Referencefinal

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

#include <DefaultScanBinder.h>

Inheritance diagram for sf::DefaultScanBinder::ScanInfo:
Collaboration diagram for sf::DefaultScanBinder::ScanInfo:

Public Member Functions

 ScanInfo ()
 
 ScanInfo (const ScanInfo &si)
 
void ReadWrite (IniProfile *inifile, bool rd) override
 Read or writes the scan scan-binder information to profile. Derived classes need to inherit this member structure to write their added fields to profile.
 
- Public Member Functions inherited from sf::ScanBinder::InfoBase
 InfoBase ()=default
 Default constructor.
 
virtual ~InfoBase ()=default
 Virtual constructor so the memory management can be done in the scan binders base class.
 

Public Attributes

gmi::AxesCoord _safePosition
 Holds the scan safe position.
 
CheckPositionList _checkPositions
 Holds the list of position.
 
bool _straightMove
 True when straight index moves are allowed.
 
bool _balance
 True when balancing is required for th acquisition device.
 
bool _bidirectional
 True when bidirectional scanning is allowed for line scans.
 
bool _scanGainActive
 True when a scan gain needs to be added.
 
- Public Attributes inherited from sf::ScanBinder::InfoBase
bool IgnoreFixtureOffset {false}
 True when the project fixture offset should be ignored.
 

Detailed Description

Holds the safe position of all scan area in the project.

Constructor & Destructor Documentation

◆ ScanInfo() [1/2]

sf::DefaultScanBinder::ScanInfo::ScanInfo ( )
inline

◆ ScanInfo() [2/2]

sf::DefaultScanBinder::ScanInfo::ScanInfo ( const ScanInfo si)
inline

Member Function Documentation

◆ ReadWrite()

void sf::DefaultScanBinder::ScanInfo::ReadWrite ( IniProfile ini,
bool  rd 
)
overridevirtual

Read or writes the scan scan-binder information to profile. Derived classes need to inherit this member structure to write their added fields to profile.

Parameters
ini
rdTrue when reading.
Todo:
Method must be renamed to 'store()'

Reimplemented from sf::ScanBinder::InfoBase.

Member Data Documentation

◆ _balance

bool sf::DefaultScanBinder::ScanInfo::_balance

True when balancing is required for th acquisition device.

◆ _bidirectional

bool sf::DefaultScanBinder::ScanInfo::_bidirectional

True when bidirectional scanning is allowed for line scans.

◆ _checkPositions

CheckPositionList sf::DefaultScanBinder::ScanInfo::_checkPositions

Holds the list of position.

◆ _safePosition

gmi::AxesCoord sf::DefaultScanBinder::ScanInfo::_safePosition

Holds the scan safe position.

◆ _scanGainActive

bool sf::DefaultScanBinder::ScanInfo::_scanGainActive

True when a scan gain needs to be added.

◆ _straightMove

bool sf::DefaultScanBinder::ScanInfo::_straightMove

True when straight index moves are allowed.


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