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

#include <igtlTrajectoryMessage.h>

Inheritance diagram for igtl::TrajectoryElement:
igtl::Object igtl::LightObject

List of all members.

Public Types

enum  {
  TYPE_ENTRY_ONLY = 1,
  TYPE_TARGET_ONLY = 2,
  TYPE_ENTRY_TARGET = 3
}
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef TrajectoryElement 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 GetEntryPosition (igtlFloat32 &x, igtlFloat32 &y, igtlFloat32 &z)
void GetEntryPosition (igtlFloat32 *position)
const char * GetGroupName ()
const char * GetName ()
virtual const char * GetNameOfClass () const
const char * GetOwner ()
igtlFloat32 GetRadius ()
virtual int GetReferenceCount () const
void GetRGBA (igtlUint8 *rgba)
void GetRGBA (igtlUint8 &r, igtlUint8 &g, igtlUint8 &b, igtlUint8 &a)
void GetTargetPosition (igtlFloat32 *position)
void GetTargetPosition (igtlFloat32 &x, igtlFloat32 &y, igtlFloat32 &z)
igtlUint8 GetType ()
 igtlNewMacro (igtl::TrajectoryElement)
 igtlTypeMacro (igtl::TrajectoryElement, igtl::Object)
 igtlTypeMacro (Object, LightObject)
void Print (std::ostream &os) const
virtual void Register () const
void SetDebug (bool debugFlag) const
void SetEntryPosition (igtlFloat32 x, igtlFloat32 y, igtlFloat32 z)
void SetEntryPosition (igtlFloat32 position[3])
int SetGroupName (const char *grpname)
int SetName (const char *name)
int SetOwner (const char *owner)
void SetRadius (igtlFloat32 radius)
virtual void SetReferenceCount (int)
void SetRGBA (igtlUint8 r, igtlUint8 g, igtlUint8 b, igtlUint8 a)
void SetRGBA (igtlUint8 rgba[4])
void SetTargetPosition (igtlFloat32 position[3])
void SetTargetPosition (igtlFloat32 x, igtlFloat32 y, igtlFloat32 z)
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
 TrajectoryElement ()
 ~TrajectoryElement ()
virtual void PrintHeader (std::ostream &os) const
virtual void PrintTrailer (std::ostream &os) const

Protected Attributes

igtlFloat32 m_EntryPosition [3]
std::string m_GroupName
std::string m_Name
std::string m_Owner
igtlFloat32 m_Radius
volatile int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
igtlUint8 m_RGBA [4]
igtlFloat32 m_TargetPosition [3]
igtlUint8 m_Type

Detailed Description

Definition at line 34 of file igtlTrajectoryMessage.h.


Member Typedef Documentation

Reimplemented from igtl::Object.

Definition at line 40 of file igtlTrajectoryMessage.h.

Reimplemented from igtl::Object.

Definition at line 39 of file igtlTrajectoryMessage.h.

Smart pointer typedef support.

Reimplemented from igtl::Object.

Definition at line 37 of file igtlTrajectoryMessage.h.

Reimplemented from igtl::Object.

Definition at line 38 of file igtlTrajectoryMessage.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
TYPE_ENTRY_ONLY 
TYPE_TARGET_ONLY 
TYPE_ENTRY_TARGET 

Definition at line 45 of file igtlTrajectoryMessage.h.


Constructor & Destructor Documentation

igtl::TrajectoryElement::TrajectoryElement ( ) [protected]
igtl::TrajectoryElement::~TrajectoryElement ( ) [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.

void igtl::TrajectoryElement::GetEntryPosition ( igtlFloat32 &  x,
igtlFloat32 &  y,
igtlFloat32 &  z 
)
void igtl::TrajectoryElement::GetEntryPosition ( igtlFloat32 *  position)
static bool igtl::Object::GetGlobalWarningDisplay ( ) [static, inherited]

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

const char* igtl::TrajectoryElement::GetGroupName ( ) [inline]

Definition at line 56 of file igtlTrajectoryMessage.h.

const char* igtl::TrajectoryElement::GetName ( ) [inline]

Definition at line 53 of file igtlTrajectoryMessage.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.

const char* igtl::TrajectoryElement::GetOwner ( ) [inline]

Definition at line 80 of file igtlTrajectoryMessage.h.

igtlFloat32 igtl::TrajectoryElement::GetRadius ( ) [inline]

Definition at line 77 of file igtlTrajectoryMessage.h.

virtual int igtl::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 112 of file igtlLightObject.h.

void igtl::TrajectoryElement::GetRGBA ( igtlUint8 *  rgba)
void igtl::TrajectoryElement::GetRGBA ( igtlUint8 &  r,
igtlUint8 &  g,
igtlUint8 &  b,
igtlUint8 &  a 
)
void igtl::TrajectoryElement::GetTargetPosition ( igtlFloat32 *  position)
void igtl::TrajectoryElement::GetTargetPosition ( igtlFloat32 &  x,
igtlFloat32 &  y,
igtlFloat32 &  z 
)
igtlUint8 igtl::TrajectoryElement::GetType ( ) [inline]

Definition at line 59 of file igtlTrajectoryMessage.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::TrajectoryElement::igtlNewMacro ( igtl::TrajectoryElement  )
igtl::TrajectoryElement::igtlTypeMacro ( igtl::TrajectoryElement  ,
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.

void igtl::TrajectoryElement::SetEntryPosition ( igtlFloat32  x,
igtlFloat32  y,
igtlFloat32  z 
)
void igtl::TrajectoryElement::SetEntryPosition ( igtlFloat32  position[3])
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::TrajectoryElement::SetGroupName ( const char *  grpname)
int igtl::TrajectoryElement::SetName ( const char *  name)
int igtl::TrajectoryElement::SetOwner ( const char *  owner)
void igtl::TrajectoryElement::SetRadius ( igtlFloat32  radius) [inline]

Definition at line 76 of file igtlTrajectoryMessage.h.

virtual void igtl::Object::SetReferenceCount ( int  ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from igtl::LightObject.

void igtl::TrajectoryElement::SetRGBA ( igtlUint8  rgba[4])
void igtl::TrajectoryElement::SetRGBA ( igtlUint8  r,
igtlUint8  g,
igtlUint8  b,
igtlUint8  a 
)
void igtl::TrajectoryElement::SetTargetPosition ( igtlFloat32  position[3])
void igtl::TrajectoryElement::SetTargetPosition ( igtlFloat32  x,
igtlFloat32  y,
igtlFloat32  z 
)
int igtl::TrajectoryElement::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

igtlFloat32 igtl::TrajectoryElement::m_EntryPosition[3] [protected]

Definition at line 92 of file igtlTrajectoryMessage.h.

std::string igtl::TrajectoryElement::m_GroupName [protected]

Definition at line 89 of file igtlTrajectoryMessage.h.

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

Definition at line 88 of file igtlTrajectoryMessage.h.

std::string igtl::TrajectoryElement::m_Owner [protected]

Definition at line 95 of file igtlTrajectoryMessage.h.

igtlFloat32 igtl::TrajectoryElement::m_Radius [protected]

Definition at line 94 of file igtlTrajectoryMessage.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::TrajectoryElement::m_RGBA[4] [protected]

Definition at line 91 of file igtlTrajectoryMessage.h.

igtlFloat32 igtl::TrajectoryElement::m_TargetPosition[3] [protected]

Definition at line 93 of file igtlTrajectoryMessage.h.

igtlUint8 igtl::TrajectoryElement::m_Type [protected]

Definition at line 90 of file igtlTrajectoryMessage.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