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

#include <igtlImageMetaMessage.h>

Inheritance diagram for igtl::ImageMetaElement:
igtl::Object igtl::LightObject

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef ImageMetaElement 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 * GetDeviceName ()
const char * GetModality ()
const char * GetName ()
virtual const char * GetNameOfClass () const
const char * GetPatientID ()
const char * GetPatientName ()
virtual int GetReferenceCount () const
igtlUint8 GetScalarType ()
void GetSize (igtlUint16 *size)
void GetSize (igtlUint16 &sx, igtlUint16 &sy, igtlUint16 &sz)
void GetTimeStamp (igtl::TimeStamp::Pointer &time)
 igtlNewMacro (igtl::ImageMetaElement)
 igtlTypeMacro (igtl::ImageMetaElement, igtl::Object)
 igtlTypeMacro (Object, LightObject)
void Print (std::ostream &os) const
virtual void Register () const
void SetDebug (bool debugFlag) const
int SetDeviceName (const char *devname)
int SetModality (const char *modality)
int SetName (const char *name)
int SetPatientID (const char *patid)
int SetPatientName (const char *patname)
virtual void SetReferenceCount (int)
void SetScalarType (igtlUint8 type)
void SetSize (igtlUint16 size[3])
void SetSize (igtlUint16 sx, igtlUint16 sy, igtlUint16 sz)
void SetTimeStamp (igtl::TimeStamp::Pointer &time)
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

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

Protected Attributes

std::string m_DeviceName
std::string m_Modality
std::string m_Name
std::string m_PatientID
std::string m_PatientName
volatile int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
igtlUint8 m_ScalarType
igtlUint16 m_Size [3]
TimeStamp::Pointer m_TimeStamp

Detailed Description

Definition at line 34 of file igtlImageMetaMessage.h.


Member Typedef Documentation

Reimplemented from igtl::Object.

Definition at line 40 of file igtlImageMetaMessage.h.

Reimplemented from igtl::Object.

Definition at line 39 of file igtlImageMetaMessage.h.

Smart pointer typedef support.

Reimplemented from igtl::Object.

Definition at line 37 of file igtlImageMetaMessage.h.

Reimplemented from igtl::Object.

Definition at line 38 of file igtlImageMetaMessage.h.


Constructor & Destructor Documentation

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

const char* igtl::ImageMetaElement::GetDeviceName ( ) [inline]

Definition at line 50 of file igtlImageMetaMessage.h.

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::ImageMetaElement::GetModality ( ) [inline]

Definition at line 53 of file igtlImageMetaMessage.h.

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

Definition at line 47 of file igtlImageMetaMessage.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::ImageMetaElement::GetPatientID ( ) [inline]

Definition at line 59 of file igtlImageMetaMessage.h.

const char* igtl::ImageMetaElement::GetPatientName ( ) [inline]

Definition at line 56 of file igtlImageMetaMessage.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.

igtlUint8 igtl::ImageMetaElement::GetScalarType ( )
void igtl::ImageMetaElement::GetSize ( igtlUint16 *  size)
void igtl::ImageMetaElement::GetSize ( igtlUint16 &  sx,
igtlUint16 &  sy,
igtlUint16 &  sz 
)
void igtl::ImageMetaElement::GetTimeStamp ( igtl::TimeStamp::Pointer time)
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::ImageMetaElement::igtlNewMacro ( igtl::ImageMetaElement  )
igtl::ImageMetaElement::igtlTypeMacro ( igtl::ImageMetaElement  ,
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.

int igtl::ImageMetaElement::SetDeviceName ( const char *  devname)
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::ImageMetaElement::SetModality ( const char *  modality)
int igtl::ImageMetaElement::SetName ( const char *  name)
int igtl::ImageMetaElement::SetPatientID ( const char *  patid)
int igtl::ImageMetaElement::SetPatientName ( const char *  patname)
virtual void igtl::Object::SetReferenceCount ( int  ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from igtl::LightObject.

void igtl::ImageMetaElement::SetScalarType ( igtlUint8  type)
void igtl::ImageMetaElement::SetSize ( igtlUint16  size[3])
void igtl::ImageMetaElement::SetSize ( igtlUint16  sx,
igtlUint16  sy,
igtlUint16  sz 
)
void igtl::ImageMetaElement::SetTimeStamp ( igtl::TimeStamp::Pointer time)
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::ImageMetaElement::m_DeviceName [protected]

Definition at line 79 of file igtlImageMetaMessage.h.

std::string igtl::ImageMetaElement::m_Modality [protected]

Definition at line 80 of file igtlImageMetaMessage.h.

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

Definition at line 78 of file igtlImageMetaMessage.h.

std::string igtl::ImageMetaElement::m_PatientID [protected]

Definition at line 82 of file igtlImageMetaMessage.h.

std::string igtl::ImageMetaElement::m_PatientName [protected]

Definition at line 81 of file igtlImageMetaMessage.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::ImageMetaElement::m_ScalarType [protected]

Definition at line 85 of file igtlImageMetaMessage.h.

igtlUint16 igtl::ImageMetaElement::m_Size[3] [protected]

Definition at line 84 of file igtlImageMetaMessage.h.


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

Generated at Wed Apr 27 2011 00:08:08 for OpenIGTLink by doxygen 1.7.4 written by Dimitri van Heesch, © 1997-2000