Medical Imaging Interaction Toolkit  2018.4.99-701c8286
Medical Imaging Interaction Toolkit
mitk::IGTLMessage Class Reference

A wrapper for the OpenIGTLink message type. More...

#include <mitkIGTLMessage.h>

Inheritance diagram for mitk::IGTLMessage:
Collaboration diagram for mitk::IGTLMessage:

Public Types

typedef double TimeStampType
 type that holds the time at which the data was recorded in milliseconds More...
 

Public Member Functions

 mitkClassMacroItkParent (IGTLMessage, itk::DataObject)
 
Pointer Clone () const
 
 mitkNewMacro1Param (Self, igtl::MessageBase::Pointer)
 
void SetMessage (igtl::MessageBase::Pointer msg)
 Sets the OpenIGTLink message. More...
 
virtual igtl::MessageBase::Pointer GetMessage () const
 returns the OpenIGTLink message More...
 
virtual bool IsDataValid () const
 returns true if the object contains valid data More...
 
virtual void SetDataValid (bool _arg)
 sets the dataValid flag of the IGTLMessage object indicating if the object contains valid data More...
 
virtual TimeStampType GetIGTTimeStamp () const
 gets the IGT timestamp of the IGTLMessage object More...
 
virtual void SetName (const char *_arg)
 set the name of the IGTLMessage object More...
 
virtual const char * GetName () const
 returns the name of the IGTLMessage object More...
 
void Graft (const DataObject *data) override
 Graft the data and information from one IGTLMessage to another. More...
 
void CopyInformation (const DataObject *data) override
 copy meta data of a IGTLMessage object More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 Prints the object information to the given stream os. More...
 
std::string ToString () const
 
void Compose (const mitk::IGTLMessage::Pointer n, const bool pre=false)
 
const char * GetIGTLMessageType () const
 
template<typename IGTLMessageType >
IGTLMessageType * GetMessage () const
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 mitkCloneMacro (Self)
 
 IGTLMessage ()
 
 IGTLMessage (const mitk::IGTLMessage &toCopy)
 
 IGTLMessage (igtl::MessageBase::Pointer message)
 
 ~IGTLMessage () override
 

Protected Attributes

igtl::MessageBase::Pointer m_Message
 holds the actual OpenIGTLink message More...
 
bool m_DataValid
 defines if the object contains valid values More...
 
TimeStampType m_IGTTimeStamp
 contains the time at which the tracking data was recorded More...
 
std::string m_Name
 name of the navigation data More...
 

Detailed Description

A wrapper for the OpenIGTLink message type.

Documentation This class represents the data object that is passed through the MITK-OpenIGTLink filter pipeline. It wraps the OpenIGTLink message type. Additionally, it contains a data structure that contains error/plausibility information.

Definition at line 35 of file mitkIGTLMessage.h.

Member Typedef Documentation

◆ TimeStampType

type that holds the time at which the data was recorded in milliseconds

Definition at line 46 of file mitkIGTLMessage.h.

Constructor & Destructor Documentation

◆ IGTLMessage() [1/3]

mitk::IGTLMessage::IGTLMessage ( )
protected

◆ IGTLMessage() [2/3]

mitk::IGTLMessage::IGTLMessage ( const mitk::IGTLMessage toCopy)
protected

Copy constructor internally used.

◆ IGTLMessage() [3/3]

mitk::IGTLMessage::IGTLMessage ( igtl::MessageBase::Pointer  message)
protected

Creates a IGTLMessage object from an igtl::MessageBase and a given name.

◆ ~IGTLMessage()

mitk::IGTLMessage::~IGTLMessage ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::IGTLMessage::Clone ( ) const

◆ Compose()

void mitk::IGTLMessage::Compose ( const mitk::IGTLMessage::Pointer  n,
const bool  pre = false 
)

Compose with another IGTLMessage

This method composes self with another IGTLMessage of the same dimension, modifying self to be the composition of self and other. If the argument pre is true, then other is precomposed with self; that is, the resulting transformation consists of first applying other to the source, followed by self. If pre is false or omitted, then other is post-composed with self; that is the resulting transformation consists of first applying self to the source, followed by other.

◆ CopyInformation()

void mitk::IGTLMessage::CopyInformation ( const DataObject *  data)
override

copy meta data of a IGTLMessage object

copies all meta data from IGTLMessage data to this object

◆ GetIGTLMessageType()

const char* mitk::IGTLMessage::GetIGTLMessageType ( ) const

Returns the OpenIGTL Message type

◆ GetIGTTimeStamp()

virtual TimeStampType mitk::IGTLMessage::GetIGTTimeStamp ( ) const
virtual

gets the IGT timestamp of the IGTLMessage object

◆ GetMessage() [1/2]

virtual igtl::MessageBase::Pointer mitk::IGTLMessage::GetMessage ( ) const
virtual

returns the OpenIGTLink message

◆ GetMessage() [2/2]

template<typename IGTLMessageType >
IGTLMessageType* mitk::IGTLMessage::GetMessage ( ) const

◆ GetName()

virtual const char* mitk::IGTLMessage::GetName ( ) const
virtual

returns the name of the IGTLMessage object

◆ Graft()

void mitk::IGTLMessage::Graft ( const DataObject *  data)
override

Graft the data and information from one IGTLMessage to another.

Copies the content of data into this object. This is a convenience method to setup a second IGTLMessage object with all the meta information of another IGTLMessage object. Note that this method is different than just using two SmartPointers to the same IGTLMessage object since separate DataObjects are still maintained.

◆ IsDataValid()

virtual bool mitk::IGTLMessage::IsDataValid ( ) const
virtual

returns true if the object contains valid data

◆ mitkClassMacroItkParent()

mitk::IGTLMessage::mitkClassMacroItkParent ( IGTLMessage  ,
itk::DataObject   
)

◆ mitkCloneMacro()

mitk::IGTLMessage::mitkCloneMacro ( Self  )
protected

◆ mitkNewMacro1Param()

mitk::IGTLMessage::mitkNewMacro1Param ( Self  ,
igtl::MessageBase::Pointer   
)

◆ New()

static Pointer mitk::IGTLMessage::New ( )
static

◆ PrintSelf()

void mitk::IGTLMessage::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
override

Prints the object information to the given stream os.

Parameters
osThe stream which is used to print the output.
indentDefines the indentation of the output.

◆ SetDataValid()

virtual void mitk::IGTLMessage::SetDataValid ( bool  _arg)
virtual

sets the dataValid flag of the IGTLMessage object indicating if the object contains valid data

◆ SetMessage()

void mitk::IGTLMessage::SetMessage ( igtl::MessageBase::Pointer  msg)

Sets the OpenIGTLink message.

◆ SetName()

virtual void mitk::IGTLMessage::SetName ( const char *  _arg)
virtual

set the name of the IGTLMessage object

◆ ToString()

std::string mitk::IGTLMessage::ToString ( ) const

Member Data Documentation

◆ m_DataValid

bool mitk::IGTLMessage::m_DataValid
protected

defines if the object contains valid values

Definition at line 149 of file mitkIGTLMessage.h.

◆ m_IGTTimeStamp

TimeStampType mitk::IGTLMessage::m_IGTTimeStamp
protected

contains the time at which the tracking data was recorded

Definition at line 153 of file mitkIGTLMessage.h.

◆ m_Message

igtl::MessageBase::Pointer mitk::IGTLMessage::m_Message
protected

holds the actual OpenIGTLink message

Definition at line 144 of file mitkIGTLMessage.h.

◆ m_Name

std::string mitk::IGTLMessage::m_Name
protected

name of the navigation data

Definition at line 157 of file mitkIGTLMessage.h.


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