#include <igtlUnit.h>
Public Member Functions | |
int | Append (int unit, int exp) |
virtual LightObject::Pointer | CreateAnother () const |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
virtual void | Delete () |
bool | GetDebug () const |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
igtlNewMacro (Self) | |
igtlTypeMacro (Object, LightObject) | |
igtlTypeMacro (Unit, Object) | |
void | Init () |
igtlUnit | Pack () |
void | Print (std::ostream &os) const |
virtual void | Register () const |
void | SetDebug (bool debugFlag) const |
int | SetPrefix (int prefix) |
virtual void | SetReferenceCount (int) |
int | Unpack (igtlUnit unit) |
virtual void | UnRegister () const |
Static Public Member Functions | |
static void | BreakOnError () |
static Pointer | New () |
Protected Member Functions | |
Unit () | |
virtual | ~Unit () |
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 |
The Unit class provides a general way to describe unites defined in International System of Unites (SI) in its 8-byte (or 64-bit) field. The field is designed to specifiy a unit consisting of SI-prefix (e.g. milli, micro, kilo etc...) and combination of SI-base and/or SI-derived unites. The bites in the field are assigned as follows:
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-... |PREFIX | UNIT0 | EXP0 | UNIT1 | EXP1 | UNIT2 | EXP2 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-... 0 1 2 3 4
...-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ EXP2 | UNIT3 | EXP3 | UNIT4 | EXP4 | UNIT5 | EXP5 | ...-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 4 5 6 7
Definition at line 44 of file igtlUnit.h.
Definition at line 110 of file igtlUnit.h.
Definition at line 109 of file igtlUnit.h.
Definition at line 107 of file igtlUnit.h.
Definition at line 108 of file igtlUnit.h.
SI Prefix.
Definition at line 49 of file igtlUnit.h.
SI Units.
Definition at line 68 of file igtlUnit.h.
|
protected |
constructor
|
protectedvirtual |
destructor
This method is called when igtlExceptionMacro executes. It allows the debugger to break on error.
|
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.
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.
|
inherited |
Get the value of the debug flag.
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.
Gets the reference count on this object.
Definition at line 110 of file igtlLightObject.h.
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.
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.
igtl::Unit::igtlNewMacro | ( | Self | ) |
|
inherited |
Standard part of all igtl objects.
void igtl::Unit::Init | ( | ) |
Initializes the class.
Method for creation through the object factory.
igtlUnit igtl::Unit::Pack | ( | ) |
Packs (or serializes) the unit into a 64-bit value.
|
inherited |
Cause the object to print itself out.
Number of uses of this object by other objects.
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.
Number of uses of this object by other objects.
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.
Set the value of the debug flag. A non-zero value turns debugging on.
This is a global flag that controls whether any debug, warning or error messages are displayed.
Sets the reference count (use with care)
Reimplemented from igtl::LightObject.
Decrease the reference count (release by another object).
Reimplemented from igtl::LightObject.
Number of uses of this object by other objects.
Definition at line 131 of file igtlLightObject.h.
|
mutableprotectedinherited |
Mutex lock to protect modification to the reference count
Definition at line 134 of file igtlLightObject.h.