Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
igtl::TrajectoryElement Class Reference

#include <igtlTrajectoryMessage.h>

Inheritance diagram for igtl::TrajectoryElement:
Inheritance graph
[legend]
Collaboration diagram for igtl::TrajectoryElement:
Collaboration graph
[legend]

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 *position)
 
void GetEntryPosition (igtlFloat32 &x, igtlFloat32 &y, igtlFloat32 &z)
 
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 position[3])
 
void SetEntryPosition (igtlFloat32 x, igtlFloat32 y, igtlFloat32 z)
 
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 rgba[4])
 
void SetRGBA (igtlUint8 r, igtlUint8 g, igtlUint8 b, igtlUint8 a)
 
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

TrajectoryElement class is used to manage a trajectory in TrajectoryMessage class.

Definition at line 32 of file igtlTrajectoryMessage.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 38 of file igtlTrajectoryMessage.h.

◆ Pointer

Definition at line 37 of file igtlTrajectoryMessage.h.

◆ Self

Definition at line 35 of file igtlTrajectoryMessage.h.

◆ Superclass

Definition at line 36 of file igtlTrajectoryMessage.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Types of trajectory.

Enumerator
TYPE_ENTRY_ONLY 
TYPE_TARGET_ONLY 
TYPE_ENTRY_TARGET 

Definition at line 44 of file igtlTrajectoryMessage.h.

Constructor & Destructor Documentation

◆ TrajectoryElement()

igtl::TrajectoryElement::TrajectoryElement ( )
protected

◆ ~TrajectoryElement()

igtl::TrajectoryElement::~TrajectoryElement ( )
protected

Member Function Documentation

◆ BreakOnError()

static void igtl::LightObject::BreakOnError ( )
staticinherited

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

◆ CreateAnother()

virtual LightObject::Pointer igtl::Object::CreateAnother ( ) const
virtualinherited

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.

◆ DebugOff()

virtual void igtl::Object::DebugOff ( ) const
virtualinherited

Turn debugging output off.

◆ DebugOn()

virtual void igtl::Object::DebugOn ( ) const
virtualinherited

Turn debugging output on.

◆ Delete()

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.

◆ GetDebug()

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

Get the value of the debug flag.

◆ GetEntryPosition() [1/2]

void igtl::TrajectoryElement::GetEntryPosition ( igtlFloat32 *  position)

Sets the entry position using an array of x, y, and z coordinates.

◆ GetEntryPosition() [2/2]

void igtl::TrajectoryElement::GetEntryPosition ( igtlFloat32 &  x,
igtlFloat32 &  y,
igtlFloat32 &  z 
)

Gets the entry position.

◆ GetGlobalWarningDisplay()

static bool igtl::Object::GetGlobalWarningDisplay ( )
staticinherited

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

◆ GetGroupName()

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

Gets the group name.

Definition at line 62 of file igtlTrajectoryMessage.h.

◆ GetName()

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

Gets the name of the trajectory.

Definition at line 56 of file igtlTrajectoryMessage.h.

◆ GetNameOfClass()

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.

◆ GetOwner()

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

Gets the owner of the trajectory.

Definition at line 115 of file igtlTrajectoryMessage.h.

◆ GetRadius()

igtlFloat32 igtl::TrajectoryElement::GetRadius ( )
inline

Gets the radius.

Definition at line 109 of file igtlTrajectoryMessage.h.

◆ GetReferenceCount()

virtual int igtl::LightObject::GetReferenceCount ( ) const
inlinevirtualinherited

Gets the reference count on this object.

Definition at line 110 of file igtlLightObject.h.

◆ GetRGBA() [1/2]

void igtl::TrajectoryElement::GetRGBA ( igtlUint8 *  rgba)

Gets the color of the trajectory. An array of r, g, b and alpha is stored in 'rgba'.

◆ GetRGBA() [2/2]

void igtl::TrajectoryElement::GetRGBA ( igtlUint8 &  r,
igtlUint8 &  g,
igtlUint8 &  b,
igtlUint8 &  a 
)

Gets the color of the trajectory.

◆ GetTargetPosition() [1/2]

void igtl::TrajectoryElement::GetTargetPosition ( igtlFloat32 *  position)

Gets the target position. Stores an array of x, y, and z coordinates in 'position'.

◆ GetTargetPosition() [2/2]

void igtl::TrajectoryElement::GetTargetPosition ( igtlFloat32 &  x,
igtlFloat32 &  y,
igtlFloat32 &  z 
)

Gets the target position.

◆ GetType()

igtlUint8 igtl::TrajectoryElement::GetType ( )
inline

Gets the trajectory type. The returned value is either TYPE_ENTRY_ONLY, TYPE_TARGET_ONLY, or TYPE_ENTRY_TARGET.

Definition at line 67 of file igtlTrajectoryMessage.h.

◆ GlobalWarningDisplayOff()

static void igtl::Object::GlobalWarningDisplayOff ( )
inlinestaticinherited

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

◆ GlobalWarningDisplayOn()

static void igtl::Object::GlobalWarningDisplayOn ( )
inlinestaticinherited

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

Definition at line 114 of file igtlObject.h.

References igtl::Object::SetGlobalWarningDisplay().

◆ igtlNewMacro()

igtl::TrajectoryElement::igtlNewMacro ( igtl::TrajectoryElement  )

◆ igtlTypeMacro() [1/2]

igtl::TrajectoryElement::igtlTypeMacro ( igtl::TrajectoryElement  ,
igtl::Object   
)

◆ igtlTypeMacro() [2/2]

igtl::Object::igtlTypeMacro ( Object  ,
LightObject   
)
inherited

Standard part of all igtl objects.

◆ New()

static Pointer igtl::Object::New ( )
staticinherited

Method for creation through the object factory.

◆ Print()

void igtl::LightObject::Print ( std::ostream &  os) const
inherited

Cause the object to print itself out.

◆ PrintHeader()

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.

◆ PrintSelf()

virtual void igtl::Object::PrintSelf ( 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.

Reimplemented from igtl::LightObject.

Reimplemented in igtl::MultiThreader, igtl::MutexLock, igtl::ObjectFactoryBase, igtl::Socket, igtl::FastMutexLock, igtl::TimeStamp, igtl::ServerSocket, and igtl::ClientSocket.

◆ PrintTrailer()

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.

◆ Register()

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.

◆ SetDebug()

void igtl::Object::SetDebug ( bool  debugFlag) const
inherited

Set the value of the debug flag. A non-zero value turns debugging on.

◆ SetEntryPosition() [1/2]

void igtl::TrajectoryElement::SetEntryPosition ( igtlFloat32  position[3])

Sets the entry position using an array.

◆ SetEntryPosition() [2/2]

void igtl::TrajectoryElement::SetEntryPosition ( igtlFloat32  x,
igtlFloat32  y,
igtlFloat32  z 
)

Sets the entry position.

◆ SetGlobalWarningDisplay()

static void igtl::Object::SetGlobalWarningDisplay ( bool  flag)
staticinherited

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

◆ SetGroupName()

int igtl::TrajectoryElement::SetGroupName ( const char *  grpname)

Sets the group name e.g. "Trajectory".

◆ SetName()

int igtl::TrajectoryElement::SetName ( const char *  name)

Sets the name of the trajectory.

◆ SetOwner()

int igtl::TrajectoryElement::SetOwner ( const char *  owner)

Sets the owner of the trajectory. 'owner' must be a name of image.

◆ SetRadius()

void igtl::TrajectoryElement::SetRadius ( igtlFloat32  radius)
inline

Sets the radius.

Definition at line 106 of file igtlTrajectoryMessage.h.

◆ SetReferenceCount()

virtual void igtl::Object::SetReferenceCount ( int  )
virtualinherited

Sets the reference count (use with care)

Reimplemented from igtl::LightObject.

◆ SetRGBA() [1/2]

void igtl::TrajectoryElement::SetRGBA ( igtlUint8  rgba[4])

Sets the color of the trajectory using an array of r, g, b and alpha.

◆ SetRGBA() [2/2]

void igtl::TrajectoryElement::SetRGBA ( igtlUint8  r,
igtlUint8  g,
igtlUint8  b,
igtlUint8  a 
)

Sets the color of the trajectory by r, g, b and alpha.

◆ SetTargetPosition() [1/2]

void igtl::TrajectoryElement::SetTargetPosition ( igtlFloat32  position[3])

Sets the target position using an array of x, y, and z coordinates.

◆ SetTargetPosition() [2/2]

void igtl::TrajectoryElement::SetTargetPosition ( igtlFloat32  x,
igtlFloat32  y,
igtlFloat32  z 
)

Sets the target position.

◆ SetType()

int igtl::TrajectoryElement::SetType ( igtlUint8  type)

Sets the trajectory type. 'type' must be either TYPE_ENTRY_ONLY, TYPE_TARGET_ONLY, or TYPE_ENTRY_TARGET.

◆ UnRegister()

virtual void igtl::Object::UnRegister ( ) const
virtualinherited

Decrease the reference count (release by another object).

Reimplemented from igtl::LightObject.

Member Data Documentation

◆ m_EntryPosition

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

Coordinate of the entry point.

Definition at line 136 of file igtlTrajectoryMessage.h.

◆ m_GroupName

std::string igtl::TrajectoryElement::m_GroupName
protected

Can be "Labeled Trajectory", "Landmark", Fiducial", ...

Definition at line 127 of file igtlTrajectoryMessage.h.

◆ m_Name

std::string igtl::TrajectoryElement::m_Name
protected

name / description (< 64 bytes)

Definition at line 124 of file igtlTrajectoryMessage.h.

◆ m_Owner

std::string igtl::TrajectoryElement::m_Owner
protected

Device name of the ower image.

Definition at line 145 of file igtlTrajectoryMessage.h.

◆ m_Radius

igtlFloat32 igtl::TrajectoryElement::m_Radius
protected

Radius of the trajectory. Can be 0.

Definition at line 142 of file igtlTrajectoryMessage.h.

◆ m_ReferenceCount

volatile int igtl::LightObject::m_ReferenceCount
mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 131 of file igtlLightObject.h.

◆ m_ReferenceCountLock

SimpleFastMutexLock igtl::LightObject::m_ReferenceCountLock
mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 134 of file igtlLightObject.h.

◆ m_RGBA

igtlUint8 igtl::TrajectoryElement::m_RGBA[4]
protected

Color in R/G/B/A.

Definition at line 133 of file igtlTrajectoryMessage.h.

◆ m_TargetPosition

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

Coordinate of the target point.

Definition at line 139 of file igtlTrajectoryMessage.h.

◆ m_Type

igtlUint8 igtl::TrajectoryElement::m_Type
protected

Trajectory type (see TYPE_* constants)

Definition at line 130 of file igtlTrajectoryMessage.h.


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

Generated for OpenIGTLink by Doxygen 1.8.13 written by Dimitri van Heesch, © 1997-2012