Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  
igtl::TrackingDataElement Class Reference

#include <igtlTrackingDataMessage.h>

Inheritance diagram for igtl::TrackingDataElement:
igtl::Object igtl::LightObject

List of all members.

Public Types

enum  {
  TYPE_TRACKER = 1,
  TYPE_6D = 2,
  TYPE_3D = 3,
  TYPE_5D = 4
}
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef TrackingDataElement Self
typedef Object Superclass

Public Member Functions

virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
bool GetDebug () const
void GetMatrix (Matrix4x4 &mat)
const char * GetName ()
virtual const char * GetNameOfClass () const
void GetPosition (float p[3])
void GetPosition (float *px, float *py, float *pz)
virtual int GetReferenceCount () const
igtlUint8 GetType ()
 igtlNewMacro (igtl::TrackingDataElement)
 igtlTypeMacro (igtl::TrackingDataElement, igtl::Object)
 igtlTypeMacro (Object, LightObject)
void Print (std::ostream &os) const
virtual void Register () const
void SetDebug (bool debugFlag) const
void SetMatrix (Matrix4x4 &mat)
int SetName (const char *name)
void SetPosition (float p[3])
void SetPosition (float px, float py, float pz)
virtual void SetReferenceCount (int)
int SetType (igtlUint8 type)
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

virtual void PrintSelf (std::ostream &os) const
 TrackingDataElement ()
 ~TrackingDataElement ()
virtual void PrintHeader (std::ostream &os) const
virtual void PrintTrailer (std::ostream &os) const

Protected Attributes

Matrix4x4 m_Matrix
std::string m_Name
volatile int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
igtlUint8 m_Type

Detailed Description

Definition at line 33 of file igtlTrackingDataMessage.h.


Member Typedef Documentation

Reimplemented from igtl::Object.

Definition at line 39 of file igtlTrackingDataMessage.h.

Reimplemented from igtl::Object.

Definition at line 38 of file igtlTrackingDataMessage.h.

Smart pointer typedef support.

Reimplemented from igtl::Object.

Definition at line 36 of file igtlTrackingDataMessage.h.

Reimplemented from igtl::Object.

Definition at line 37 of file igtlTrackingDataMessage.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
TYPE_TRACKER 
TYPE_6D 
TYPE_3D 
TYPE_5D 

Definition at line 45 of file igtlTrackingDataMessage.h.


Constructor & Destructor Documentation

igtl::TrackingDataElement::TrackingDataElement ( ) [protected]
igtl::TrackingDataElement::~TrackingDataElement ( ) [protected]

Member Function Documentation

static void igtl::LightObject::BreakOnError ( ) [static, inherited]

This method is called when igtlExceptionMacro executes. It allows the debugger to break on error.

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.

bool igtl::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

static bool igtl::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

void igtl::TrackingDataElement::GetMatrix ( Matrix4x4 mat)
const char* igtl::TrackingDataElement::GetName ( ) [inline]

Definition at line 55 of file igtlTrackingDataMessage.h.

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::TrackingDataElement::GetPosition ( float  p[3])
void igtl::TrackingDataElement::GetPosition ( float *  px,
float *  py,
float *  pz 
)
virtual int igtl::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 112 of file igtlLightObject.h.

igtlUint8 igtl::TrackingDataElement::GetType ( ) [inline]

Definition at line 58 of file igtlTrackingDataMessage.h.

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::TrackingDataElement::igtlNewMacro ( igtl::TrackingDataElement  )
igtl::TrackingDataElement::igtlTypeMacro ( igtl::TrackingDataElement  ,
igtl::Object   
)
igtl::Object::igtlTypeMacro ( Object  ,
LightObject   
) [inherited]

Standard part of all igtl objects.

static Pointer igtl::Object::New ( ) [static, inherited]

Method for creation through the object factory.

Reimplemented from igtl::LightObject.

Referenced by igtl::CreateObjectFunction< T >::CreateObject().

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]

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 [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]

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 [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.

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().

void igtl::TrackingDataElement::SetMatrix ( Matrix4x4 mat)
int igtl::TrackingDataElement::SetName ( const char *  name)
void igtl::TrackingDataElement::SetPosition ( float  px,
float  py,
float  pz 
)
void igtl::TrackingDataElement::SetPosition ( float  p[3])
virtual void igtl::Object::SetReferenceCount ( int  ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from igtl::LightObject.

int igtl::TrackingDataElement::SetType ( igtlUint8  type)
virtual void igtl::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from igtl::LightObject.


Member Data Documentation

std::string igtl::TrackingDataElement::m_Name [protected]

Definition at line 75 of file igtlTrackingDataMessage.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.

Mutex lock to protect modification to the reference count

Definition at line 136 of file igtlLightObject.h.

igtlUint8 igtl::TrackingDataElement::m_Type [protected]

Definition at line 76 of file igtlTrackingDataMessage.h.


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

Generated at Sat Dec 3 2011 08:54:22 for OpenIGTLink by doxygen 1.7.4 written by Dimitri van Heesch, © 1997-2000