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::PointElement Class Reference

#include <igtlPointMessage.h>

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

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef PointElement 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
 
const char * GetGroupName ()
 
const char * GetName ()
 
virtual const char * GetNameOfClass () const
 
const char * GetOwner ()
 
void GetPosition (igtlFloat32 *position)
 
void GetPosition (igtlFloat32 &x, igtlFloat32 &y, igtlFloat32 &z)
 
igtlFloat32 GetRadius ()
 
virtual int GetReferenceCount () const
 
void GetRGBA (igtlUint8 *rgba)
 
void GetRGBA (igtlUint8 &r, igtlUint8 &g, igtlUint8 &b, igtlUint8 &a)
 
 igtlNewMacro (igtl::PointElement)
 
 igtlTypeMacro (igtl::PointElement, igtl::Object)
 
 igtlTypeMacro (Object, LightObject)
 
void Print (std::ostream &os) const
 
virtual void Register () const
 
void SetDebug (bool debugFlag) const
 
int SetGroupName (const char *grpname)
 
int SetName (const char *name)
 
int SetOwner (const char *owner)
 
void SetPosition (igtlFloat32 position[3])
 
void SetPosition (igtlFloat32 x, igtlFloat32 y, igtlFloat32 z)
 
void SetRadius (igtlFloat32 radius)
 
virtual void SetReferenceCount (int)
 
void SetRGBA (igtlUint8 rgba[4])
 
void SetRGBA (igtlUint8 r, igtlUint8 g, igtlUint8 b, igtlUint8 a)
 
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

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

Protected Attributes

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

Detailed Description

A class to manage point information.

Definition at line 33 of file igtlPointMessage.h.

Member Typedef Documentation

Definition at line 39 of file igtlPointMessage.h.

Definition at line 38 of file igtlPointMessage.h.

Definition at line 36 of file igtlPointMessage.h.

Definition at line 37 of file igtlPointMessage.h.

Constructor & Destructor Documentation

igtl::PointElement::PointElement ( )
protected
igtl::PointElement::~PointElement ( )
protected

Member Function Documentation

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

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

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.

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.

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

Get the value of the debug flag.

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

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

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

Gets the group name.

Definition at line 56 of file igtlPointMessage.h.

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

Gets the name/description of the point.

Definition at line 50 of file igtlPointMessage.h.

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.

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

Gets the name of the image that owns this label map.

Definition at line 92 of file igtlPointMessage.h.

void igtl::PointElement::GetPosition ( igtlFloat32 *  position)

Gets the position of the point using an array of x, y and z coordinates.

void igtl::PointElement::GetPosition ( igtlFloat32 &  x,
igtlFloat32 &  y,
igtlFloat32 &  z 
)

Gets the position of the point using x, y and z coordinates.

igtlFloat32 igtl::PointElement::GetRadius ( )
inline

Gets the radius of the point.

Definition at line 86 of file igtlPointMessage.h.

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

Gets the reference count on this object.

Definition at line 110 of file igtlLightObject.h.

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

Gets the color of the point using an array of R, G, B and A.

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

Gets the color of the point using values of R, G, B and A.

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

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

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

Standard part of all igtl objects.

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

Method for creation through the object factory.

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

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.

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.

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

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

Sets the group name e.g. "Labeled Point", "Landmark", "Fiducial", etc.

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

Sets the name/description of the point. The string 'name' must not exceed 64 characters.

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

Sets the name of the image that owns this label map.

void igtl::PointElement::SetPosition ( igtlFloat32  position[3])

Sets the position of the point by an array of x, y and z coordinates.

void igtl::PointElement::SetPosition ( igtlFloat32  x,
igtlFloat32  y,
igtlFloat32  z 
)

Sets the position of the point by x, y and z coordinates.

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

Sets the radius of the point.

Definition at line 83 of file igtlPointMessage.h.

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

Sets the reference count (use with care)

Reimplemented from igtl::LightObject.

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

Sets the color of the point specified by an array of R, G, B and A.

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

Sets the color of the point specified by values of R, G, B and A.

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

Decrease the reference count (release by another object).

Reimplemented from igtl::LightObject.

Member Data Documentation

std::string igtl::PointElement::m_GroupName
protected

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

Definition at line 104 of file igtlPointMessage.h.

std::string igtl::PointElement::m_Name
protected

name / description (< 64 bytes)

Definition at line 101 of file igtlPointMessage.h.

std::string igtl::PointElement::m_Owner
protected

Device name of the ower image.

Definition at line 116 of file igtlPointMessage.h.

igtlFloat32 igtl::PointElement::m_Position[3]
protected

Position.

Definition at line 110 of file igtlPointMessage.h.

igtlFloat32 igtl::PointElement::m_Radius
protected

Radius of the point. Can be 0.

Definition at line 113 of file igtlPointMessage.h.

volatile int igtl::LightObject::m_ReferenceCount
mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 131 of file igtlLightObject.h.

SimpleFastMutexLock igtl::LightObject::m_ReferenceCountLock
mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 134 of file igtlLightObject.h.

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

Color in R/G/B/A.

Definition at line 107 of file igtlPointMessage.h.


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

Generated at Wed Dec 4 2013 03:48:29 for OpenIGTLink by doxygen 1.8.5 written by Dimitri van Heesch, © 1997-2012