#include <igtlQuaternionTrackingDataMessage.h>
A class for the RTS_QTDATA message type.
Definition at line 184 of file igtlQuaternionTrackingDataMessage.h.
Unpack status. They are returned by the Unpack() function.
Enumerator |
---|
UNPACK_UNDEF |
|
UNPACK_HEADER |
|
UNPACK_BODY |
|
Definition at line 68 of file igtlMessageBase.h.
igtl::RTSQuaternionTrackingDataMessage::RTSQuaternionTrackingDataMessage |
( |
| ) |
|
|
inlineprotected |
igtl::RTSQuaternionTrackingDataMessage::~RTSQuaternionTrackingDataMessage |
( |
| ) |
|
|
inlineprotected |
void igtl::MessageBase::AllocatePack |
( |
| ) |
|
|
inherited |
virtual void igtl::MessageBase::AllocatePack |
( |
int |
bodySize | ) |
|
|
protectedvirtualinherited |
Allocates memory specifying the body size. This function is used when creating a brank package to receive data)
Reimplemented in igtl::ImageMessage2.
static void igtl::LightObject::BreakOnError |
( |
| ) |
|
|
staticinherited |
This method is called when igtlExceptionMacro executes. It allows the debugger to break on error.
Copy() copies contents from the specified Massage class. If the type of the specified class is the same as this class, both general header and body are copied. Otherwise, only general header is copied.
int igtl::MessageBase::CopyBody |
( |
const MessageBase * |
mb | ) |
|
|
protectedinherited |
Copies the serialized body data.
int igtl::MessageBase::CopyHeader |
( |
const MessageBase * |
mb | ) |
|
|
protectedinherited |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from igtl::LightObject.
virtual void igtl::Object::DebugOff |
( |
| ) |
const |
|
virtualinherited |
Turn debugging output off.
virtual void igtl::Object::DebugOn |
( |
| ) |
const |
|
virtualinherited |
Turn debugging output on.
virtual void igtl::LightObject::Delete |
( |
| ) |
|
|
virtualinherited |
Delete an igtl object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.
virtual int igtl::RTSQuaternionTrackingDataMessage::GetBodyPackSize |
( |
| ) |
|
|
protectedvirtual |
int igtl::MessageBase::GetBodySizeToRead |
( |
| ) |
|
|
inlineinherited |
const char* igtl::MessageBase::GetBodyType |
( |
| ) |
|
|
inlineinherited |
bool igtl::Object::GetDebug |
( |
| ) |
const |
|
inherited |
Get the value of the debug flag.
const char* igtl::MessageBase::GetDeviceName |
( |
| ) |
|
|
inherited |
Gets the device (message) name.
const char* igtl::MessageBase::GetDeviceType |
( |
| ) |
|
|
inherited |
Gets the device (message) type.
static bool igtl::Object::GetGlobalWarningDisplay |
( |
| ) |
|
|
staticinherited |
This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual const char* igtl::LightObject::GetNameOfClass |
( |
| ) |
const |
|
inlinevirtualinherited |
Return the name of this class as a string. Used by the object factory (implemented in New()) to instantiate objects of a named type. Also used for debugging and other output information.
Definition at line 84 of file igtlLightObject.h.
void* igtl::MessageBase::GetPackBodyPointer |
( |
| ) |
|
|
inherited |
Gets a pointer to the raw byte array for the serialized body data.
int igtl::MessageBase::GetPackBodySize |
( |
| ) |
|
|
inherited |
Gets the size of the serialized body data.
void* igtl::MessageBase::GetPackPointer |
( |
| ) |
|
|
inherited |
Gets a pointer to the raw byte array for the serialized data including the header and the body.
int igtl::MessageBase::GetPackSize |
( |
| ) |
|
|
inherited |
Gets the size of the serialized data.
virtual int igtl::LightObject::GetReferenceCount |
( |
| ) |
const |
|
inlinevirtualinherited |
igtlUint8 igtl::RTSQuaternionTrackingDataMessage::GetStatus |
( |
| ) |
|
|
inline |
int igtl::MessageBase::GetTimeStamp |
( |
unsigned int * |
sec, |
|
|
unsigned int * |
frac |
|
) |
| |
|
inherited |
Gets time of message creation. 'sec' and 'frac' are seconds and fractions of a second respectively.
Gets time of message creation.
static void igtl::Object::GlobalWarningDisplayOff |
( |
| ) |
|
|
inlinestaticinherited |
static void igtl::Object::GlobalWarningDisplayOn |
( |
| ) |
|
|
inlinestaticinherited |
Standard part of all igtl objects.
void igtl::MessageBase::InitPack |
( |
| ) |
|
|
inherited |
Call InitPack() before receive header. This function simply resets the Unpacked flag for both the header and body pack.
static Pointer igtl::Object::New |
( |
| ) |
|
|
staticinherited |
Method for creation through the object factory.
virtual int igtl::MessageBase::Pack |
( |
| ) |
|
|
virtualinherited |
virtual int igtl::RTSQuaternionTrackingDataMessage::PackBody |
( |
| ) |
|
|
protectedvirtual |
Packs (serialize) the body. Must be implemented in a child class.
Reimplemented from igtl::MessageBase.
void igtl::LightObject::Print |
( |
std::ostream & |
os | ) |
const |
|
inherited |
Cause the object to print itself out.
virtual void igtl::LightObject::PrintHeader |
( |
std::ostream & |
os | ) |
const |
|
protectedvirtualinherited |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
virtual void igtl::Object::PrintSelf |
( |
std::ostream & |
os | ) |
const |
|
protectedvirtualinherited |
virtual void igtl::LightObject::PrintTrailer |
( |
std::ostream & |
os | ) |
const |
|
protectedvirtualinherited |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
virtual void igtl::Object::Register |
( |
| ) |
const |
|
virtualinherited |
Return this objects modified time. Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Increase the reference count (mark as used by another object).
Reimplemented from igtl::LightObject.
void igtl::Object::SetDebug |
( |
bool |
debugFlag | ) |
const |
|
inherited |
Set the value of the debug flag. A non-zero value turns debugging on.
void igtl::MessageBase::SetDeviceName |
( |
const char * |
name | ) |
|
|
inherited |
Sets the device (message) name.
static void igtl::Object::SetGlobalWarningDisplay |
( |
bool |
flag | ) |
|
|
staticinherited |
virtual int igtl::MessageBase::SetMessageHeader |
( |
const MessageHeader * |
mb | ) |
|
|
inlinevirtualinherited |
virtual void igtl::Object::SetReferenceCount |
( |
int |
| ) |
|
|
virtualinherited |
void igtl::RTSQuaternionTrackingDataMessage::SetStatus |
( |
igtlUint8 |
status | ) |
|
|
inline |
int igtl::MessageBase::SetTimeStamp |
( |
unsigned int |
sec, |
|
|
unsigned int |
frac |
|
) |
| |
|
inherited |
Sets time of message creation. 'sec' and 'frac' are seconds and fractions of a second respectively.
Sets time of message creation.
int igtl::MessageBase::Unpack |
( |
int |
crccheck = 0 | ) |
|
|
inherited |
Unpack() deserializes the header and/or body, extracting data from the byte stream. If the header has already been deserilized, Unpack() deserializes only the body part. UnpackBody() must be implemented to deserialize the body part. Unpack() performs 64-bit CRC check, when crccheck = 1. It returns:
UNPACK_UNDEF : Nothing deserialized UNPACK_HEADER : The header has been deserialized. UNPACK_BODY : The body has been deserialized. If CRC check fails, Unpack() doesn't deserialize the body, thus it doesn't return UNPACK_BODY flag. UNPACK_HEADER|UNPACK_BODY: Both the header and body have been deserialized
virtual int igtl::RTSQuaternionTrackingDataMessage::UnpackBody |
( |
| ) |
|
|
protectedvirtual |
Unpacks (deserialize) the body. Must be implemented in a child class.
Reimplemented from igtl::MessageBase.
virtual void igtl::Object::UnRegister |
( |
| ) |
const |
|
virtualinherited |
Decrease the reference count (release by another object).
Reimplemented from igtl::LightObject.
unsigned char* igtl::MessageBase::m_Body |
|
protectedinherited |
A pointer to the byte array for the serialized body. To prevent large copy of the byte array in the Pack() function, header byte array is concatinated to the byte array for the header.
Definition at line 187 of file igtlMessageBase.h.
int igtl::MessageBase::m_BodySizeToRead |
|
protectedinherited |
The size of the body to be read. This function must be called after the message header is set.
Definition at line 191 of file igtlMessageBase.h.
std::string igtl::MessageBase::m_BodyType |
|
protectedinherited |
A character string for the device type (message type). This will be used when the header is desrialized from a byte stream received from the network.
Definition at line 198 of file igtlMessageBase.h.
std::string igtl::MessageBase::m_DefaultBodyType |
|
protectedinherited |
A character string for the default device type (message type).
Definition at line 194 of file igtlMessageBase.h.
std::string igtl::MessageBase::m_DeviceName |
|
protectedinherited |
A character string for the device name (message name).
Definition at line 201 of file igtlMessageBase.h.
unsigned char* igtl::MessageBase::m_Header |
|
protectedinherited |
A pointer to the byte array for the serialized header. To prevent large copy of the byte array in the Pack() function, header byte array is concatinated to the byte array for the body.
Definition at line 182 of file igtlMessageBase.h.
int igtl::MessageBase::m_IsBodyUnpacked |
|
protectedinherited |
Unpacking (desrialization) status for the body (0: – 1: unpacked).
Definition at line 215 of file igtlMessageBase.h.
int igtl::MessageBase::m_IsHeaderUnpacked |
|
protectedinherited |
Unpacking (desrialization) status for the header (0: – 1: unpacked).
Definition at line 212 of file igtlMessageBase.h.
int igtl::MessageBase::m_PackSize |
|
protectedinherited |
volatile int igtl::LightObject::m_ReferenceCount |
|
mutableprotectedinherited |
|
mutableprotectedinherited |
Mutex lock to protect modification to the reference count
Definition at line 134 of file igtlLightObject.h.
igtlUint8 igtl::RTSQuaternionTrackingDataMessage::m_Status |
|
protected |
unsigned int igtl::MessageBase::m_TimeStampSec |
|
protectedinherited |
A time stamp (second) for message creation. It consists of fields for seconds (m_TimeStampSec)and franctions of a second (m_TimeStampSecFraction).
Definition at line 205 of file igtlMessageBase.h.
unsigned int igtl::MessageBase::m_TimeStampSecFraction |
|
protectedinherited |
A time stamp (second) for message creation. It consists of fields for seconds (m_TimeStampSec)and franctions of a second (m_TimeStampSecFraction).
Definition at line 209 of file igtlMessageBase.h.
The documentation for this class was generated from the following file: