NorMIT-nav  18.04
An IGT application
cx::ToolFileParser::ToolInternalStructure Struct Reference

A tools internal structure. More...

#include <cxToolFileParser.h>

Public Member Functions

Transform3D getCalibrationAsSSC () const
 
void setCalibration (const Transform3D &cal)
 
void saveCalibrationToFile ()
 
bool verify ()
 
 ToolInternalStructure ()
 sets up default values for all the members More...
 

Public Attributes

bool mIsReference
 
bool mIsPointer
 
bool mIsProbe
 
QString mName
 the tools name More...
 
QString mUid
 the tools unique id More...
 
std::vector< QString > mClinicalApplications
 the tools clinical application applications More...
 
TRACKING_SYSTEM mTrackerType
 what product the tool belongs to More...
 
QString mSROMFilename
 path to the tools SROM file More...
 
unsigned int mPortNumber
 the port number the tool is connected to More...
 
unsigned int mChannelNumber
 the channel the tool is connected to More...
 
std::map< int, Vector3DmReferencePoints
 optional point on the frame, specifying a known reference point, 0,0,0 is default, in sensor space More...
 
bool mWireless
 whether or not the tool is wireless More...
 
bool m5DOF
 whether or not the tool have 5 DOF More...
 
Transform3D mCalibration
 transform read from mCalibrationFilename More...
 
QString mCalibrationFilename
 path to the tools calibration file More...
 
QString mGraphicsFileName
 path to this tools graphics file More...
 
QString mPictureFileName
 path to picture of the tool More...
 
QString mTransformSaveFileName
 path to where transforms should be saved More...
 
QString mLoggingFolderName
 path to where log should be saved More...
 
QString mInstrumentId
 The instruments id. More...
 
QString mInstrumentScannerId
 The id of the ultrasound scanner if the instrument is a probe. More...
 

Detailed Description

A tools internal structure.

Warning
make sure you set all the members to an appropriate value.

Definition at line 50 of file cxToolFileParser.h.

Constructor & Destructor Documentation

cx::ToolFileParser::ToolInternalStructure::ToolInternalStructure ( )
inline

sets up default values for all the members

Definition at line 80 of file cxToolFileParser.h.

Member Function Documentation

Transform3D cx::ToolFileParser::ToolInternalStructure::getCalibrationAsSSC ( ) const

Definition at line 13 of file cxToolFileParser.cpp.

void cx::ToolFileParser::ToolInternalStructure::saveCalibrationToFile ( )

Definition at line 28 of file cxToolFileParser.cpp.

void cx::ToolFileParser::ToolInternalStructure::setCalibration ( const Transform3D cal)

Definition at line 22 of file cxToolFileParser.cpp.

bool cx::ToolFileParser::ToolInternalStructure::verify ( )

Definition at line 69 of file cxToolFileParser.cpp.

Member Data Documentation

bool cx::ToolFileParser::ToolInternalStructure::m5DOF

whether or not the tool have 5 DOF

Definition at line 70 of file cxToolFileParser.h.

Transform3D cx::ToolFileParser::ToolInternalStructure::mCalibration

transform read from mCalibrationFilename

Definition at line 72 of file cxToolFileParser.h.

QString cx::ToolFileParser::ToolInternalStructure::mCalibrationFilename

path to the tools calibration file

Definition at line 73 of file cxToolFileParser.h.

unsigned int cx::ToolFileParser::ToolInternalStructure::mChannelNumber

the channel the tool is connected to

Definition at line 67 of file cxToolFileParser.h.

std::vector<QString> cx::ToolFileParser::ToolInternalStructure::mClinicalApplications

the tools clinical application applications

Definition at line 63 of file cxToolFileParser.h.

QString cx::ToolFileParser::ToolInternalStructure::mGraphicsFileName

path to this tools graphics file

Definition at line 74 of file cxToolFileParser.h.

QString cx::ToolFileParser::ToolInternalStructure::mInstrumentId

The instruments id.

Definition at line 78 of file cxToolFileParser.h.

QString cx::ToolFileParser::ToolInternalStructure::mInstrumentScannerId

The id of the ultrasound scanner if the instrument is a probe.

Definition at line 79 of file cxToolFileParser.h.

bool cx::ToolFileParser::ToolInternalStructure::mIsPointer

Definition at line 58 of file cxToolFileParser.h.

bool cx::ToolFileParser::ToolInternalStructure::mIsProbe

Definition at line 59 of file cxToolFileParser.h.

bool cx::ToolFileParser::ToolInternalStructure::mIsReference

Definition at line 57 of file cxToolFileParser.h.

QString cx::ToolFileParser::ToolInternalStructure::mLoggingFolderName

path to where log should be saved

Definition at line 77 of file cxToolFileParser.h.

QString cx::ToolFileParser::ToolInternalStructure::mName

the tools name

Definition at line 61 of file cxToolFileParser.h.

QString cx::ToolFileParser::ToolInternalStructure::mPictureFileName

path to picture of the tool

Definition at line 75 of file cxToolFileParser.h.

unsigned int cx::ToolFileParser::ToolInternalStructure::mPortNumber

the port number the tool is connected to

Definition at line 66 of file cxToolFileParser.h.

std::map<int, Vector3D> cx::ToolFileParser::ToolInternalStructure::mReferencePoints

optional point on the frame, specifying a known reference point, 0,0,0 is default, in sensor space

Definition at line 68 of file cxToolFileParser.h.

QString cx::ToolFileParser::ToolInternalStructure::mSROMFilename

path to the tools SROM file

Definition at line 65 of file cxToolFileParser.h.

TRACKING_SYSTEM cx::ToolFileParser::ToolInternalStructure::mTrackerType

what product the tool belongs to

Definition at line 64 of file cxToolFileParser.h.

QString cx::ToolFileParser::ToolInternalStructure::mTransformSaveFileName

path to where transforms should be saved

Definition at line 76 of file cxToolFileParser.h.

QString cx::ToolFileParser::ToolInternalStructure::mUid

the tools unique id

Definition at line 62 of file cxToolFileParser.h.

bool cx::ToolFileParser::ToolInternalStructure::mWireless

whether or not the tool is wireless

Definition at line 69 of file cxToolFileParser.h.


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