mitkIGTLMessage.h

Go to the documentation of this file.

/*===================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/


#ifndef MITKIGTLMESSAGEH_HEADER_INCLUDED_
#define MITKIGTLMESSAGEH_HEADER_INCLUDED_

#include <itkDataObject.h>
#include "MitkOpenIGTLinkExports.h"
#include <mitkNumericTypes.h>
#include <mitkCommon.h>

#include "igtlMessageBase.h"

namespace mitk {

  class MITKOPENIGTLINK_EXPORT IGTLMessage : public itk::DataObject
    {
    public:
      mitkClassMacroItkParent(IGTLMessage, itk::DataObject);
      itkFactorylessNewMacro(Self);
      itkCloneMacro(Self);
      mitkNewMacro2Param(Self, igtl::MessageBase::Pointer,std::string);

      typedef double TimeStampType;

      void SetMessage(igtl::MessageBase::Pointer msg);
      itkGetConstMacro(Message, igtl::MessageBase::Pointer);
      virtual bool IsDataValid() const;
      itkSetMacro(DataValid, bool);
      itkGetConstMacro(IGTTimeStamp, TimeStampType);
      itkSetStringMacro(Name);
      itkGetStringMacro(Name);

      virtual void Graft(const DataObject *data) override;

      virtual void CopyInformation(const DataObject* data) override;

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

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

      const char* GetIGTLMessageType() const;

      template < typename IGTLMessageType > IGTLMessageType* GetMessage() const;

    protected:
      mitkCloneMacro(Self);

      IGTLMessage();

      IGTLMessage(const mitk::IGTLMessage& toCopy);

      IGTLMessage(igtl::MessageBase::Pointer message, std::string name = "");

      virtual ~IGTLMessage();

      igtl::MessageBase::Pointer m_Message;

      bool m_DataValid;
      TimeStampType m_IGTTimeStamp;
      std::string m_Name;

    private:

      // pre = false
      static mitk::IGTLMessage::Pointer getComposition(
          const mitk::IGTLMessage::Pointer nd1,
          const mitk::IGTLMessage::Pointer nd2);

      itkSetMacro(IGTTimeStamp, TimeStampType);

    };

      MITKOPENIGTLINK_EXPORT bool Equal( const mitk::IGTLMessage& leftHandSide,
                                          const mitk::IGTLMessage& rightHandSide,
                                          ScalarType eps = mitk::eps,
                                          bool verbose = false );

} // namespace mitk
#endif /* MITKIGTLMESSAGEH_HEADER_INCLUDED_ */