IGSTK
Public Types | Public Member Functions | Public Attributes | List of all members
igstk::Ascension3DGToolEventStruct Struct Reference

Structure holding a notification event. More...

#include <igstkAscension3DGTracker.h>

Public Types

enum  ToolEvents {
  TOOL_DISCONNECTED, TOOL_CONNECTED, TOOL_SATURATED, TOOL_OUT_OF_SATURATION,
  TOOL_OUT_OF_MOTION_BOX, TOOL_IN_MOTION_BOX, TRANSMITTER_DETACHED, TRANSMITTER_ATTACHED
}
 

Public Member Functions

 Ascension3DGToolEventStruct ()
 

Public Attributes

EventHelperType::StringType ToolIdentifier
 a text descriptor of the tool the notificatrion is for More...
 
int toolID
 the id number of the tool the notification is for More...
 
ToolEvents EventType
 the type of notification More...
 

Detailed Description

Structure holding a notification event.

These can be used to monitor the state of the tracker.

Definition at line 38 of file igstkAscension3DGTracker.h.

Member Enumeration Documentation

Enumerator
TOOL_DISCONNECTED 
TOOL_CONNECTED 

a tool that was connected has been disconnected

TOOL_SATURATED 

a tool that was disconnected has been reconnected

TOOL_OUT_OF_SATURATION 

a sensor is too close to the transmitter and has saturated

TOOL_OUT_OF_MOTION_BOX 

a sensor that was saturated is no longer saturated

TOOL_IN_MOTION_BOX 

a sensor that was within the motion box is now out

TRANSMITTER_DETACHED 

a sensor that was out of the motion box is now back in

TRANSMITTER_ATTACHED 

a transmitter that was attached has been disconnected

Definition at line 39 of file igstkAscension3DGTracker.h.

Constructor & Destructor Documentation

igstk::Ascension3DGToolEventStruct::Ascension3DGToolEventStruct ( )
inline

Definition at line 50 of file igstkAscension3DGTracker.h.

Member Data Documentation

EventHelperType::StringType igstk::Ascension3DGToolEventStruct::ToolIdentifier

a text descriptor of the tool the notificatrion is for

Definition at line 50 of file igstkAscension3DGTracker.h.

int igstk::Ascension3DGToolEventStruct::toolID

the id number of the tool the notification is for

Definition at line 56 of file igstkAscension3DGTracker.h.

ToolEvents igstk::Ascension3DGToolEventStruct::EventType

the type of notification

Definition at line 59 of file igstkAscension3DGTracker.h.


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