Medical Imaging Interaction Toolkit
2016.11.0
Medical Imaging Interaction Toolkit
|
A wrapper for the OpenIGTLink message type. More...
#include <mitkIGTLMessage.h>
Public Types | |
typedef double | TimeStampType |
type that holds the time at which the data was recorded More... | |
Public Member Functions | |
mitkClassMacroItkParent (IGTLMessage, itk::DataObject) | |
Pointer | Clone () const |
mitkNewMacro2Param (Self, igtl::MessageBase::Pointer, std::string) | |
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... | |
virtual void | Graft (const DataObject *data) override |
Graft the data and information from one IGTLMessage to another. More... | |
virtual 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... | |
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, std::string name="") | |
virtual | ~IGTLMessage () |
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... | |
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 39 of file mitkIGTLMessage.h.
typedef double mitk::IGTLMessage::TimeStampType |
type that holds the time at which the data was recorded
Definition at line 50 of file mitkIGTLMessage.h.
|
protected |
Definition at line 21 of file mitkIGTLMessage.cpp.
References m_Message, and mitk::New().
|
protected |
Copy constructor internally used.
Definition at line 28 of file mitkIGTLMessage.cpp.
References Graft().
|
protected |
Creates a IGTLMessage object from an igtl::MessageBase and a given name.
Definition at line 40 of file mitkIGTLMessage.cpp.
|
protectedvirtual |
Definition at line 36 of file mitkIGTLMessage.cpp.
Pointer mitk::IGTLMessage::Clone | ( | ) | const |
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.
|
overridevirtual |
copy meta data of a IGTLMessage object
copies all meta data from IGTLMessage data to this object
Definition at line 104 of file mitkIGTLMessage.cpp.
const char * mitk::IGTLMessage::GetIGTLMessageType | ( | ) | const |
Returns the OpenIGTL Message type
Definition at line 161 of file mitkIGTLMessage.cpp.
Referenced by mitk::IGTLMessageToNavigationDataFilter::GenerateData(), and mitk::IGTLMessageToUSImageFilter::GetNextRawImage().
|
virtual |
gets the IGT timestamp of the IGTLMessage object
Referenced by mitk::Equal(), and mitk::IGTLMessageToNavigationDataFilter::GenerateTrackingDataData().
|
virtual |
returns the OpenIGTLink message
Referenced by mitk::IGTLMessageProvider::GenerateData(), mitk::IGTLMessageToNavigationDataFilter::GenerateQuaternionTrackingDataData(), mitk::IGTLMessageToNavigationDataFilter::GenerateTrackingDataData(), mitk::IGTLMessageToNavigationDataFilter::GenerateTransformData(), mitk::IGTLMessageToUSImageFilter::GetNextRawImage(), and mitk::IGTLDevice::SendMessage().
IGTLMessageType * mitk::IGTLMessage::GetMessage | ( | ) | const |
Definition at line 167 of file mitkIGTLMessage.cpp.
|
virtual |
returns the name of the IGTLMessage object
Referenced by mitk::Equal(), and mitk::IGTLMessageToNavigationDataFilter::GenerateTransformData().
|
overridevirtual |
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 47 of file mitkIGTLMessage.cpp.
Referenced by IGTLMessage().
|
virtual |
returns true if the object contains valid data
Definition at line 87 of file mitkIGTLMessage.cpp.
Referenced by mitk::IGTLMessageProvider::GenerateData(), mitk::IGTLMessageToNavigationDataFilter::GenerateData(), mitk::IGTLMessageToNavigationDataFilter::GenerateQuaternionTrackingDataData(), mitk::IGTLMessageToNavigationDataFilter::GenerateTrackingDataData(), mitk::IGTLMessageToNavigationDataFilter::GenerateTransformData(), mitk::IGTLMessageToUSImageFilter::GetNextRawImage(), and QmitkIGTLStreamingConnector::OnUpdateSource().
mitk::IGTLMessage::mitkClassMacroItkParent | ( | IGTLMessage | , |
itk::DataObject | |||
) |
|
protected |
mitk::IGTLMessage::mitkNewMacro2Param | ( | Self | , |
igtl::MessageBase::Pointer | , | ||
std::string | |||
) |
|
static |
|
override |
Prints the object information to the given stream os.
os | The stream which is used to print the output. |
indent | Defines the indentation of the output. |
Definition at line 93 of file mitkIGTLMessage.cpp.
References GetName().
|
virtual |
sets the dataValid flag of the IGTLMessage object indicating if the object contains valid data
Referenced by mitk::NavigationDataToIGTLMessageFilter::GenerateDataModeSendTDataMsg().
void mitk::IGTLMessage::SetMessage | ( | igtl::MessageBase::Pointer | msg | ) |
Sets the OpenIGTLink message.
Definition at line 77 of file mitkIGTLMessage.cpp.
Referenced by mitk::ImageToIGTLMessageFilter::GenerateData(), mitk::IGTL2DImageDeviceSource::GenerateData(), mitk::IGTLTransformDeviceSource::GenerateData(), mitk::IGTL3DImageDeviceSource::GenerateData(), mitk::IGTLDeviceSource::GenerateData(), mitk::NavigationDataToIGTLMessageFilter::GenerateDataModeSendQTDataMsg(), mitk::NavigationDataToIGTLMessageFilter::GenerateDataModeSendQTransMsg(), mitk::NavigationDataToIGTLMessageFilter::GenerateDataModeSendTDataMsg(), and mitk::NavigationDataToIGTLMessageFilter::GenerateDataModeSendTransMsg().
|
virtual |
set the name of the IGTLMessage object
Referenced by mitk::IGTL2DImageDeviceSource::GenerateData(), mitk::IGTLTransformDeviceSource::GenerateData(), mitk::IGTL3DImageDeviceSource::GenerateData(), and mitk::IGTLDeviceSource::GenerateData().
|
protected |
defines if the object contains valid values
Definition at line 151 of file mitkIGTLMessage.h.
|
protected |
contains the time at which the tracking data was recorded
Definition at line 155 of file mitkIGTLMessage.h.
|
protected |
holds the actual OpenIGTLink message
Definition at line 146 of file mitkIGTLMessage.h.
Referenced by IGTLMessage().
|
protected |
name of the navigation data
Definition at line 159 of file mitkIGTLMessage.h.