#include <igtlSensorMessage.h>
Public Types | |
enum | { UNPACK_UNDEF = 0x0000, UNPACK_HEADER = 0x0001, UNPACK_BODY = 0x0002 } |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef SensorMessage | Self |
typedef MessageBase | Superclass |
Public Member Functions | |
void | AllocatePack () |
int | Copy (const MessageBase *mb) |
virtual LightObject::Pointer | CreateAnother () const |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
virtual void | Delete () |
int | GetBodySizeToRead () |
const char * | GetBodyType () |
bool | GetDebug () const |
const char * | GetDeviceName () |
const char * | GetDeviceType () |
unsigned int | GetLength () |
virtual const char * | GetNameOfClass () const |
void * | GetPackBodyPointer () |
int | GetPackBodySize () |
void * | GetPackPointer () |
int | GetPackSize () |
virtual int | GetReferenceCount () const |
void | GetTimeStamp (igtl::TimeStamp::Pointer &ts) |
int | GetTimeStamp (unsigned int *sec, unsigned int *frac) |
int | GetUnit (igtl::Unit *unit) |
igtlUnit | GetUnit () |
igtlFloat64 | GetValue (unsigned int i) |
igtlNewMacro (igtl::SensorMessage) | |
igtlTypeMacro (Object, LightObject) | |
igtlTypeMacro (igtl::SensorMessage, igtl::MessageBase) | |
void | InitPack () |
int | Pack () |
void | Print (std::ostream &os) const |
virtual void | Register () const |
void | SetDebug (bool debugFlag) const |
void | SetDeviceName (const char *name) |
int | SetLength (unsigned int n) |
virtual int | SetMessageHeader (const MessageHeader *mb) |
virtual void | SetReferenceCount (int) |
int | SetTimeStamp (unsigned int sec, unsigned int frac) |
void | SetTimeStamp (igtl::TimeStamp::Pointer &ts) |
int | SetUnit (igtlUnit unit) |
int | SetUnit (igtl::Unit *unit) |
int | SetValue (unsigned int i, igtlFloat64 value) |
int | SetValue (igtlFloat64 *data) |
int | Unpack (int crccheck=0) |
virtual void | UnRegister () const |
Static Public Member Functions | |
static void | BreakOnError () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
Protected Member Functions | |
void | AllocatePack (int bodySize) |
int | CopyBody (const MessageBase *mb) |
int | CopyHeader (const MessageBase *mb) |
virtual int | GetBodyPackSize () |
virtual int | PackBody () |
virtual void | PrintSelf (std::ostream &os) const |
SensorMessage () | |
virtual int | UnpackBody () |
~SensorMessage () | |
virtual void | PrintHeader (std::ostream &os) const |
virtual void | PrintTrailer (std::ostream &os) const |
Protected Attributes | |
std::vector< igtlFloat64 > | m_Array |
unsigned char * | m_Body |
int | m_BodySizeToRead |
std::string | m_BodyType |
std::string | m_DefaultBodyType |
std::string | m_DeviceName |
unsigned char * | m_Header |
int | m_IsBodyUnpacked |
int | m_IsHeaderUnpacked |
igtlUint8 | m_Length |
int | m_PackSize |
volatile int | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
igtlUint8 | m_Status |
unsigned int | m_TimeStampSec |
unsigned int | m_TimeStampSecFraction |
igtlUnit | m_Unit |
Definition at line 32 of file igtlSensorMessage.h.
typedef SmartPointer<const Self> igtl::SensorMessage::ConstPointer |
Reimplemented from igtl::MessageBase.
Definition at line 38 of file igtlSensorMessage.h.
typedef SmartPointer<Self> igtl::SensorMessage::Pointer |
Reimplemented from igtl::MessageBase.
Definition at line 37 of file igtlSensorMessage.h.
Smart pointer typedef support.
Reimplemented from igtl::MessageBase.
Definition at line 35 of file igtlSensorMessage.h.
Reimplemented from igtl::MessageBase.
Definition at line 36 of file igtlSensorMessage.h.
anonymous enum [inherited] |
Definition at line 72 of file igtlMessageBase.h.
igtl::SensorMessage::SensorMessage | ( | ) | [protected] |
igtl::SensorMessage::~SensorMessage | ( | ) | [protected] |
void igtl::MessageBase::AllocatePack | ( | ) | [inherited] |
void igtl::MessageBase::AllocatePack | ( | int | bodySize | ) | [protected, inherited] |
static void igtl::LightObject::BreakOnError | ( | ) | [static, inherited] |
This method is called when igtlExceptionMacro executes. It allows the debugger to break on error.
int igtl::MessageBase::Copy | ( | const MessageBase * | mb | ) | [inherited] |
int igtl::MessageBase::CopyBody | ( | const MessageBase * | mb | ) | [protected, inherited] |
int igtl::MessageBase::CopyHeader | ( | const MessageBase * | mb | ) | [protected, inherited] |
virtual LightObject::Pointer igtl::Object::CreateAnother | ( | ) | const [virtual, inherited] |
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 [virtual, inherited] |
Turn debugging output off.
virtual void igtl::Object::DebugOn | ( | ) | const [virtual, inherited] |
Turn debugging output on.
virtual void igtl::LightObject::Delete | ( | ) | [virtual, inherited] |
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::SensorMessage::GetBodyPackSize | ( | ) | [protected, virtual] |
Reimplemented from igtl::MessageBase.
int igtl::MessageBase::GetBodySizeToRead | ( | ) | [inline, inherited] |
Definition at line 131 of file igtlMessageBase.h.
const char* igtl::MessageBase::GetBodyType | ( | ) | [inline, inherited] |
Definition at line 114 of file igtlMessageBase.h.
bool igtl::Object::GetDebug | ( | ) | const [inherited] |
Get the value of the debug flag.
const char* igtl::MessageBase::GetDeviceName | ( | ) | [inherited] |
const char* igtl::MessageBase::GetDeviceType | ( | ) | [inherited] |
static bool igtl::Object::GetGlobalWarningDisplay | ( | ) | [static, inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
unsigned int igtl::SensorMessage::GetLength | ( | ) |
virtual const char* igtl::LightObject::GetNameOfClass | ( | ) | const [inline, virtual, inherited] |
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 86 of file igtlLightObject.h.
void* igtl::MessageBase::GetPackBodyPointer | ( | ) | [inherited] |
int igtl::MessageBase::GetPackBodySize | ( | ) | [inherited] |
void* igtl::MessageBase::GetPackPointer | ( | ) | [inherited] |
int igtl::MessageBase::GetPackSize | ( | ) | [inherited] |
virtual int igtl::LightObject::GetReferenceCount | ( | ) | const [inline, virtual, inherited] |
Gets the reference count on this object.
Definition at line 112 of file igtlLightObject.h.
int igtl::MessageBase::GetTimeStamp | ( | unsigned int * | sec, |
unsigned int * | frac | ||
) | [inherited] |
void igtl::MessageBase::GetTimeStamp | ( | igtl::TimeStamp::Pointer & | ts | ) | [inherited] |
int igtl::SensorMessage::GetUnit | ( | igtl::Unit * | unit | ) |
igtlUnit igtl::SensorMessage::GetUnit | ( | ) |
igtlFloat64 igtl::SensorMessage::GetValue | ( | unsigned int | i | ) |
static void igtl::Object::GlobalWarningDisplayOff | ( | ) | [inline, static, inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
Definition at line 118 of file igtlObject.h.
References igtl::Object::SetGlobalWarningDisplay().
static void igtl::Object::GlobalWarningDisplayOn | ( | ) | [inline, static, inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
Definition at line 116 of file igtlObject.h.
References igtl::Object::SetGlobalWarningDisplay().
igtl::SensorMessage::igtlNewMacro | ( | igtl::SensorMessage | ) |
igtl::SensorMessage::igtlTypeMacro | ( | igtl::SensorMessage | , |
igtl::MessageBase | |||
) |
igtl::Object::igtlTypeMacro | ( | Object | , |
LightObject | |||
) | [inherited] |
Standard part of all igtl objects.
void igtl::MessageBase::InitPack | ( | ) | [inherited] |
static Pointer igtl::Object::New | ( | ) | [static, inherited] |
Method for creation through the object factory.
Reimplemented from igtl::LightObject.
Referenced by igtl::CreateObjectFunction< T >::CreateObject().
int igtl::MessageBase::Pack | ( | ) | [inherited] |
virtual int igtl::SensorMessage::PackBody | ( | ) | [protected, virtual] |
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 [protected, virtual, inherited] |
virtual void igtl::Object::PrintSelf | ( | std::ostream & | os | ) | const [protected, virtual, inherited] |
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.
Reimplemented from igtl::LightObject.
Reimplemented in igtl::ClientSocket, igtl::FastMutexLock, igtl::MultiThreader, igtl::MutexLock, igtl::ObjectFactoryBase, igtl::ServerSocket, igtl::Socket, and igtl::TimeStamp.
virtual void igtl::LightObject::PrintTrailer | ( | std::ostream & | os | ) | const [protected, virtual, inherited] |
virtual void igtl::Object::Register | ( | ) | const [virtual, inherited] |
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] |
static void igtl::Object::SetGlobalWarningDisplay | ( | bool | flag | ) | [static, inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
Referenced by igtl::Object::GlobalWarningDisplayOff(), and igtl::Object::GlobalWarningDisplayOn().
int igtl::SensorMessage::SetLength | ( | unsigned int | n | ) |
virtual int igtl::MessageBase::SetMessageHeader | ( | const MessageHeader * | mb | ) | [inline, virtual, inherited] |
Reimplemented in igtl::PositionMessage.
Definition at line 130 of file igtlMessageBase.h.
virtual void igtl::Object::SetReferenceCount | ( | int | ) | [virtual, inherited] |
Sets the reference count (use with care)
Reimplemented from igtl::LightObject.
int igtl::MessageBase::SetTimeStamp | ( | unsigned int | sec, |
unsigned int | frac | ||
) | [inherited] |
void igtl::MessageBase::SetTimeStamp | ( | igtl::TimeStamp::Pointer & | ts | ) | [inherited] |
int igtl::SensorMessage::SetUnit | ( | igtl::Unit * | unit | ) |
int igtl::SensorMessage::SetUnit | ( | igtlUnit | unit | ) |
int igtl::SensorMessage::SetValue | ( | igtlFloat64 * | data | ) |
int igtl::SensorMessage::SetValue | ( | unsigned int | i, |
igtlFloat64 | value | ||
) |
int igtl::MessageBase::Unpack | ( | int | crccheck = 0 | ) | [inherited] |
virtual int igtl::SensorMessage::UnpackBody | ( | ) | [protected, virtual] |
Reimplemented from igtl::MessageBase.
virtual void igtl::Object::UnRegister | ( | ) | const [virtual, inherited] |
Decrease the reference count (release by another object).
Reimplemented from igtl::LightObject.
std::vector<igtlFloat64> igtl::SensorMessage::m_Array [protected] |
Definition at line 72 of file igtlSensorMessage.h.
unsigned char* igtl::MessageBase::m_Body [protected, inherited] |
Definition at line 161 of file igtlMessageBase.h.
int igtl::MessageBase::m_BodySizeToRead [protected, inherited] |
Definition at line 163 of file igtlMessageBase.h.
std::string igtl::MessageBase::m_BodyType [protected, inherited] |
Definition at line 167 of file igtlMessageBase.h.
std::string igtl::MessageBase::m_DefaultBodyType [protected, inherited] |
Definition at line 166 of file igtlMessageBase.h.
std::string igtl::MessageBase::m_DeviceName [protected, inherited] |
Definition at line 168 of file igtlMessageBase.h.
unsigned char* igtl::MessageBase::m_Header [protected, inherited] |
Definition at line 160 of file igtlMessageBase.h.
int igtl::MessageBase::m_IsBodyUnpacked [protected, inherited] |
Definition at line 175 of file igtlMessageBase.h.
int igtl::MessageBase::m_IsHeaderUnpacked [protected, inherited] |
Definition at line 174 of file igtlMessageBase.h.
igtlUint8 igtl::SensorMessage::m_Length [protected] |
Definition at line 68 of file igtlSensorMessage.h.
int igtl::MessageBase::m_PackSize [protected, inherited] |
Definition at line 159 of file igtlMessageBase.h.
volatile int igtl::LightObject::m_ReferenceCount [mutable, protected, inherited] |
Number of uses of this object by other objects.
Definition at line 133 of file igtlLightObject.h.
SimpleFastMutexLock igtl::LightObject::m_ReferenceCountLock [mutable, protected, inherited] |
Mutex lock to protect modification to the reference count
Definition at line 136 of file igtlLightObject.h.
igtlUint8 igtl::SensorMessage::m_Status [protected] |
Definition at line 69 of file igtlSensorMessage.h.
unsigned int igtl::MessageBase::m_TimeStampSec [protected, inherited] |
Definition at line 170 of file igtlMessageBase.h.
unsigned int igtl::MessageBase::m_TimeStampSecFraction [protected, inherited] |
Definition at line 171 of file igtlMessageBase.h.
igtlUnit igtl::SensorMessage::m_Unit [protected] |
Definition at line 70 of file igtlSensorMessage.h.