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 | List of all members
igtl::PolyDataAttribute Class Reference

#include <igtlPolyDataMessage.h>

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

Public Types

enum  {
  POINT_SCALAR = 0x00 ,
  POINT_VECTOR = 0x01 ,
  POINT_NORMAL = 0x02 ,
  POINT_TENSOR = 0x03 ,
  POINT_RGBA = 0x04 ,
  CELL_SCALAR = 0x10 ,
  CELL_VECTOR = 0x11 ,
  CELL_NORMAL = 0x12 ,
  CELL_TENSOR = 0x13 ,
  CELL_RGBA = 0x14
}
 
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef PolyDataAttribute Self
 
typedef Object Superclass
 

Public Member Functions

void Clear ()
 
virtual LightObject::Pointer CreateAnother () const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
virtual void Delete ()
 
int GetData (igtlFloat32 *data)
 
bool GetDebug () const
 
const charGetName ()
 
virtual const charGetNameOfClass () const
 
int GetNthData (unsigned int n, igtlFloat32 *data)
 
igtlUint32 GetNumberOfComponents ()
 
virtual int GetReferenceCount () const
 
igtlUint32 GetSize ()
 
igtlUint8 GetType ()
 
 igtlNewMacro (igtl::PolyDataAttribute)
 
 igtlTypeMacro (igtl::PolyDataAttribute, igtl::Object)
 
 igtlTypeMacro (Object, LightObject)
 
void Print (std::ostream &os) const
 
virtual void Register () const
 
int SetData (igtlFloat32 *data)
 
void SetDebug (bool debugFlag) const
 
void SetName (const char *name)
 
int SetNthData (unsigned int n, igtlFloat32 *data)
 
virtual void SetReferenceCount (int)
 
igtlUint32 SetSize (igtlUint32 size)
 
int SetType (int t, int n=1)
 
virtual void UnRegister () const
 

Static Public Member Functions

static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 PolyDataAttribute ()
 
 ~PolyDataAttribute ()
 
virtual void PrintSelf (std::ostream &os) const
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
virtual void PrintHeader (std::ostream &os) const
 
virtual void PrintTrailer (std::ostream &os) const
 
volatile int m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Detailed Description

Attribute class used for passing attribute data.

Definition at line 172 of file igtlPolyDataMessage.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 193 of file igtlPolyDataMessage.h.

◆ Pointer

Definition at line 192 of file igtlPolyDataMessage.h.

◆ Self

Definition at line 190 of file igtlPolyDataMessage.h.

◆ Superclass

Definition at line 191 of file igtlPolyDataMessage.h.

Member Enumeration Documentation

◆ anonymous enum

Point and cell types.

Enumerator
POINT_SCALAR 
POINT_VECTOR 
POINT_NORMAL 
POINT_TENSOR 
POINT_RGBA 
CELL_SCALAR 
CELL_VECTOR 
CELL_NORMAL 
CELL_TENSOR 
CELL_RGBA 

Definition at line 176 of file igtlPolyDataMessage.h.

Constructor & Destructor Documentation

◆ PolyDataAttribute()

igtl::PolyDataAttribute::PolyDataAttribute ( )
protected

◆ ~PolyDataAttribute()

igtl::PolyDataAttribute::~PolyDataAttribute ( )
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.

◆ Clear()

void igtl::PolyDataAttribute::Clear ( )

Clears the attributes.

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

◆ GetData()

int igtl::PolyDataAttribute::GetData ( igtlFloat32 data)

Gets the attribute as a byte array.

◆ GetDebug()

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

Get the value of the debug flag.

◆ GetGlobalWarningDisplay()

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

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.

◆ GetName()

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

Gets the name of the attribute.

Definition at line 233 of file igtlPolyDataMessage.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.

◆ GetNthData()

int igtl::PolyDataAttribute::GetNthData ( unsigned int  n,
igtlFloat32 data 
)

Gets the Nth data.

◆ GetNumberOfComponents()

igtlUint32 igtl::PolyDataAttribute::GetNumberOfComponents ( )

Gets the number of components. The number depends on the type of the points/cells e.g. 3 in case of POINT_VECTOR.

◆ GetReferenceCount()

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

Gets the reference count on this object.

Definition at line 110 of file igtlLightObject.h.

◆ GetSize()

igtlUint32 igtl::PolyDataAttribute::GetSize ( )

Gets the size of the attribute.

◆ GetType()

igtlUint8 igtl::PolyDataAttribute::GetType ( )
inline

Gets the attribute type.

Definition at line 217 of file igtlPolyDataMessage.h.

◆ GlobalWarningDisplayOff()

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

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.

Definition at line 116 of file igtlObject.h.

◆ GlobalWarningDisplayOn()

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

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.

Definition at line 114 of file igtlObject.h.

◆ igtlNewMacro()

igtl::PolyDataAttribute::igtlNewMacro ( igtl::PolyDataAttribute  )

◆ igtlTypeMacro() [1/2]

igtl::PolyDataAttribute::igtlTypeMacro ( igtl::PolyDataAttribute  ,
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

Number of uses of this object by other objects.

◆ 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::ClientSocket, igtl::FastMutexLock, igtl::MultiThreader, igtl::MutexLock, igtl::ObjectFactoryBase, igtl::ServerSocket, igtl::Socket, and igtl::TimeStamp.

◆ PrintTrailer()

virtual void igtl::LightObject::PrintTrailer ( std::ostream &  os) const
protectedvirtualinherited

Number of uses of this object by other objects.

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

◆ SetData()

int igtl::PolyDataAttribute::SetData ( igtlFloat32 data)

Sets the attribute by byte array.

◆ SetDebug()

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

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

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

◆ SetName()

void igtl::PolyDataAttribute::SetName ( const char name)

Sets the name of the attribute.

◆ SetNthData()

int igtl::PolyDataAttribute::SetNthData ( unsigned int  n,
igtlFloat32 data 
)

Sets the Nth data.

◆ SetReferenceCount()

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

Sets the reference count (use with care)

Reimplemented from igtl::LightObject.

◆ SetSize()

igtlUint32 igtl::PolyDataAttribute::SetSize ( igtlUint32  size)

Sets the size of the attribute.

◆ SetType()

int igtl::PolyDataAttribute::SetType ( int  t,
int  n = 1 
)

SetType() is used to set the attribute type. If the attribute is set properly, the function returns the type value (POINT_* or CELL_*). Otherwise the function returns negative value. The second argument will be ignored if 't' is neither POINT_SCALAR nor CELL_SCALAR. If the POINT_SCALAR and CELL_SCALAR is specified as 't', the number of components can be specified as the second argument. The number of components must be 0 < n < 128.

◆ UnRegister()

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

Decrease the reference count (release by another object).

Reimplemented from igtl::LightObject.

Member Data Documentation

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


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

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