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

#include <mitkIGTLMessage.h>

Inheritance diagram for mitk::IGTLMessage:

Public Types
typedef double	TimeStampType
	type that holds the time at which the data was recorded in milliseconds

Public Member Functions
	mitkClassMacroItkParent (IGTLMessage, itk::DataObject)

	itkFactorylessNewMacro (Self)

	itkCloneMacro (Self)

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

void	SetMessage (igtl::MessageBase::Pointer msg)
	Sets the OpenIGTLink message.

	itkGetConstMacro (Message, igtl::MessageBase::Pointer)
	returns the OpenIGTLink message

virtual bool	IsDataValid () const
	returns true if the object contains valid data

	itkSetMacro (DataValid, bool)
	sets the dataValid flag of the IGTLMessage object indicating if the object contains valid data

	itkGetConstMacro (IGTTimeStamp, TimeStampType)
	gets the IGT timestamp of the IGTLMessage object

	itkSetStringMacro (Name)
	set the name of the IGTLMessage object

	itkGetStringMacro (Name)
	returns the name of the IGTLMessage object

void	Graft (const DataObject *data) override
	Graft the data and information from one IGTLMessage to another.

void	CopyInformation (const DataObject *data) override
	copy meta data of a IGTLMessage object

void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	Prints the object information to the given stream os.

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

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

bool	m_DataValid
	defines if the object contains valid values

TimeStampType	m_IGTTimeStamp
	contains the time at which the tracking data was recorded

std::string	m_Name
	name of the navigation data

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

double mitk::IGTLMessage::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

Definition at line 17 of file mitkIGTLMessage.cpp.

◆ IGTLMessage() [2/3]

mitk::IGTLMessage::IGTLMessage ( const mitk::IGTLMessage & toCopy )

protected

Copy constructor internally used.

Definition at line 24 of file mitkIGTLMessage.cpp.

◆ IGTLMessage() [3/3]

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

protected

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

Definition at line 36 of file mitkIGTLMessage.cpp.

◆ ~IGTLMessage()

mitk::IGTLMessage::~IGTLMessage ( )

overrideprotected

Definition at line 32 of file mitkIGTLMessage.cpp.

Member Function Documentation

◆ 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

Definition at line 109 of file mitkIGTLMessage.cpp.

◆ GetIGTLMessageType()

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

Returns the OpenIGTL Message type

Definition at line 166 of file mitkIGTLMessage.cpp.

◆ GetMessage()

template<typename IGTLMessageType >

IGTLMessageType * mitk::IGTLMessage::GetMessage ( ) const

Definition at line 172 of file mitkIGTLMessage.cpp.

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

Definition at line 42 of file mitkIGTLMessage.cpp.

◆ IsDataValid()

bool mitk::IGTLMessage::IsDataValid ( ) const

virtual

returns true if the object contains valid data

Definition at line 84 of file mitkIGTLMessage.cpp.

◆ itkCloneMacro()

mitk::IGTLMessage::itkCloneMacro ( Self )

◆ itkFactorylessNewMacro()

mitk::IGTLMessage::itkFactorylessNewMacro ( Self )

◆ itkGetConstMacro() [1/2]

mitk::IGTLMessage::itkGetConstMacro	(	IGTTimeStamp	,
		TimeStampType	)

gets the IGT timestamp of the IGTLMessage object

◆ itkGetConstMacro() [2/2]

mitk::IGTLMessage::itkGetConstMacro	(	Message	,
		igtl::MessageBase::Pointer	)

returns the OpenIGTLink message

◆ itkGetStringMacro()

mitk::IGTLMessage::itkGetStringMacro ( Name )

returns the name of the IGTLMessage object

◆ itkSetMacro()

mitk::IGTLMessage::itkSetMacro	(	DataValid	,
		bool	)

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

◆ itkSetStringMacro()

mitk::IGTLMessage::itkSetStringMacro ( Name )

set the name of the IGTLMessage object

◆ mitkClassMacroItkParent()

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

◆ mitkCloneMacro()

mitk::IGTLMessage::mitkCloneMacro ( Self )

protected

◆ mitkNewMacro1Param()

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

◆ PrintSelf()

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

override

Prints the object information to the given stream os.

Parameters

os	The stream which is used to print the output.
indent	Defines the indentation of the output.

Definition at line 90 of file mitkIGTLMessage.cpp.

◆ SetMessage()

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

Sets the OpenIGTLink message.

Definition at line 72 of file mitkIGTLMessage.cpp.

◆ ToString()

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

Definition at line 101 of file mitkIGTLMessage.cpp.

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 files:

Modules/OpenIGTLink/mitkIGTLMessage.h
Modules/OpenIGTLink/mitkIGTLMessage.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ TimeStampType

Constructor & Destructor Documentation

◆ IGTLMessage() [1/3]

◆ IGTLMessage() [2/3]

◆ IGTLMessage() [3/3]

◆ ~IGTLMessage()

Member Function Documentation

◆ Compose()

◆ CopyInformation()

◆ GetIGTLMessageType()

◆ GetMessage()

◆ Graft()

◆ IsDataValid()

◆ itkCloneMacro()

◆ itkFactorylessNewMacro()

◆ itkGetConstMacro() [1/2]

◆ itkGetConstMacro() [2/2]

◆ itkGetStringMacro()

◆ itkSetMacro()

◆ itkSetStringMacro()

◆ mitkClassMacroItkParent()

◆ mitkCloneMacro()

◆ mitkNewMacro1Param()

◆ PrintSelf()

◆ SetMessage()

◆ ToString()

Member Data Documentation

◆ m_DataValid

◆ m_IGTTimeStamp

◆ m_Message

◆ m_Name