Loading...
Searching...
No Matches
NDIProtocolTestClass Class Reference
Inheritance diagram for NDIProtocolTestClass:
Public Member Functions | |
| mitkClassMacro (NDIProtocolTestClass, NDIProtocol) | |
| itkFactorylessNewMacro (Self) itkCloneMacro(Self) protected | |
 Public Member Functions inherited from mitk::NDIProtocol | |
| mitkClassMacroItkParent (NDIProtocol, itk::Object) | |
| itkFactorylessNewMacro (Self) | |
| itkCloneMacro (Self) | |
| itkSetObjectMacro (TrackingDevice, NDITrackingDevice) | |
| NDIErrorCode | APIREV (std::string *revision) |
| Gives information about the tool which is assosiated with the port handle. Writes portInfo to the string. | |
| NDIErrorCode | PHINF (std::string portHandle, std::string *portInfo) |
| NDIErrorCode | PSOUT (std::string portHandle, std::string state) |
| Set GPIO Output (Aurora) | |
| NDIErrorCode | COMM (mitk::SerialCommunication::BaudRate baudRate, mitk::SerialCommunication::DataBits dataBits, mitk::SerialCommunication::Parity parity, mitk::SerialCommunication::StopBits stopBits, mitk::SerialCommunication::HardwareHandshake hardwareHandshake) |
| Change Serial Communication Parameters. | |
| NDIErrorCode | INIT () |
| Initialize the Measurement System. | |
| NDIErrorCode | DSTART () |
| Start the Diagnostic Mode. | |
| NDIErrorCode | DSTOP () |
| Stop the Diagnostic Mode. | |
| NDIErrorCode | IRINIT () |
| Initialize the System to Check for Infrared. | |
| NDIErrorCode | IRCHK (bool *IRdetected) |
| This version of IRCHK uses only the simple "presence of infrared light" call, that returns a binary "IR detected/no IR detected" answer. | |
| NDIErrorCode | PHSR (PHSRQueryType queryType, std::string *portHandles) |
| Port Handle Search. Will write returned port handles to the string portHandles. | |
| NDIErrorCode | PHF (std::string *portHandle) |
| Port Handle Free. Frees the port handle. | |
| NDIErrorCode | PHRQ (std::string *portHandle) |
| Port Handle Request. Will request a Port Handle for a wireless tool and return it in the string portHandle. | |
| NDIErrorCode | PVWR (std::string *portHandle, const unsigned char *sromData, unsigned int sromDataLength) |
| Port Virtual Write. Writes an SROM Image data to a tool. | |
| NDIErrorCode | PINIT (std::string *portHandle) |
| Port Initialize. Will initialize a Port that has been acquired with PHRQ and has been assigned a SROM File with PVWR. | |
| NDIErrorCode | PENA (std::string *portHandle, TrackingPriority prio) |
| Port Enable. Will enable a port that has been initialized with PINIT. | |
| NDIErrorCode | PDIS (std::string *portHandle) |
| Port Disable. Will disable a port that has been enabled with PENA. | |
| NDIErrorCode | IRATE (IlluminationActivationRate rate) |
| Setting the illuminator rate. Will set the refresh rate for the illuminator for wireless tools. | |
| NDIErrorCode | BEEP (unsigned char count) |
| Sounding the measurement system beeper. The tracking system will beep one to nine times. | |
| NDIErrorCode | SFLIST (std::string *info) |
| Returns information about the supported feature of the tracking system. | |
| NDIErrorCode | TSTART (bool resetFrameCounter=false) |
| Start Tracking Mode. The tracking system must be in setup mode and must be initialized. | |
| NDIErrorCode | TSTOP () |
| Stop Tracking Mode. The tracking system must be in Tracking mode. | |
| NDIErrorCode | TX (bool trackIndividualMarkers=false, MarkerPointContainerType *markerPositions=nullptr) |
| Report transformations in text mode. Optionally, individual markers can be tracked. | |
| NDIErrorCode | BX () |
| Report transformations in binary mode. | |
| NDIErrorCode | POS3D (MarkerPointContainerType *markerPositions) |
| Report 3D Positions of single markers. can only be used in diagnostics mode. | |
| NDIErrorCode | VER (mitk::TrackingDeviceType &t) |
| returns if the tracking device is a Polaris or an Aurora system | |
| NDIErrorCode | VSEL (mitk::TrackingDeviceData deviceData) |
| Sets the tracking volume to the given type. Check available tracking volumes with SFLIST first. | |
| NDIErrorCode | TX1000 (MarkerPointContainerType *markerPositions) |
| Report transformations in text mode. | |
| unsigned int | ByteToNbBitsOn (char &c) const |
| itkGetConstMacro (UseCRC, bool) | |
| Get whether to append a CRC16 checksum to each message. | |
| itkSetMacro (UseCRC, bool) | |
| Set whether to append a CRC16 checksum to each message. | |
| itkBooleanMacro (UseCRC) | |
| Set whether to append a CRC16 checksum to each message. | |
Additional Inherited Members | |
| Public Types inherited from mitk::NDIProtocol | |
| typedef mitk::SerialCommunication::PortNumber | PortNumber |
| Port number of the serial connection. | |
| typedef mitk::SerialCommunication::BaudRate | BaudRate |
| Baud rate of the serial connection. | |
| typedef mitk::SerialCommunication::DataBits | DataBits |
| Number of data bits used in the serial connection. | |
| typedef mitk::SerialCommunication::Parity | Parity |
| Parity mode used in the serial connection. | |
| typedef mitk::SerialCommunication::StopBits | StopBits |
| Number of stop bits used in the serial connection. | |
| typedef mitk::SerialCommunication::HardwareHandshake | HardwareHandshake |
| Hardware handshake mode of the serial connection. | |
| typedef mitk::NDIPassiveTool::TrackingPriority | TrackingPriority |
| Tracking priority used for tracking a tool. | |
| Protected Member Functions inherited from mitk::NDIProtocol | |
| NDIProtocol () | |
| ~NDIProtocol () override | |
| NDIErrorCode | ParseOkayError () |
| NDIErrorCode | GenericCommand (const std::string command, const std::string *parameter=nullptr) |
| NDIErrorCode | GetErrorCode (const std::string *input) |
| returns the error code for an Error String returned from the NDI tracking device | |
| Protected Attributes inherited from mitk::NDIProtocol | |
| NDITrackingDevice * | m_TrackingDevice |
| tracking device to which the commands will be send | |
| bool | m_UseCRC |
| whether to append a CRC16 checksum to each message | |
Detailed Description
Documentation NDIProtocol has a protected constructor and a protected itkFactorylessNewMacro so that only it's friend class NDITrackingDevice is able to instantiate tool objects. Therefore, we derive from NDIPassiveTool and add a public itkFactorylessNewMacro, so that we can instantiate and test the class
Definition at line 25 of file mitkNDIProtocolTest.cpp.
Member Function Documentation
◆ itkFactorylessNewMacro()
|
inline |
make a public constructor, so that the test is able to instantiate NDIPassiveTool
Definition at line 32 of file mitkNDIProtocolTest.cpp.
◆ mitkClassMacro()
| NDIProtocolTestClass::mitkClassMacro | ( | NDIProtocolTestClass | , |
| NDIProtocol | ) |
The documentation for this class was generated from the following file:
- Modules/IGT/Testing/mitkNDIProtocolTest.cpp
