mitkIGTLMessageQueue.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkIGTLMessageQueue_h
#define mitkIGTLMessageQueue_h
 
#include "MitkOpenIGTLinkExports.h"
 
#include "itkObject.h"
#include "mitkCommon.h"
 
#include <deque>
#include <mutex>
#include <mitkIGTLMessage.h>
 
//OpenIGTLink
#include "igtlMessageBase.h"
#include "igtlImageMessage.h"
#include "igtlStringMessage.h"
#include "igtlTrackingDataMessage.h"
#include "igtlTransformMessage.h"
 
namespace mitk {
  class MITKOPENIGTLINK_EXPORT IGTLMessageQueue : public itk::Object
  {
  public:
    mitkClassMacroItkParent(mitk::IGTLMessageQueue, itk::Object);
      itkFactorylessNewMacro(Self);
      itkCloneMacro(Self);
 
    enum BufferingType { Infinit, NoBuffering };
 
    void PushSendMessage(mitk::IGTLMessage::Pointer message);
 
    void PushMessage(igtl::MessageBase::Pointer message);
 
    void PushCommandMessage(igtl::MessageBase::Pointer message);
    igtl::MessageBase::Pointer PullMiscMessage();
    igtl::ImageMessage::Pointer PullImage2dMessage();
    igtl::ImageMessage::Pointer PullImage3dMessage();
    igtl::TrackingDataMessage::Pointer PullTrackingMessage();
    igtl::MessageBase::Pointer PullCommandMessage();
    igtl::StringMessage::Pointer PullStringMessage();
    igtl::TransformMessage::Pointer PullTransformMessage();
    mitk::IGTLMessage::Pointer PullSendMessage();
 
    int GetSize();
 
    std::string GetNextMsgInformationString();
 
    std::string GetNextMsgDeviceType();
 
    std::string GetLatestMsgInformationString();
 
    std::string GetLatestMsgDeviceType();
 
    void EnableNoBufferingMode(bool enable);
 
  protected:
    IGTLMessageQueue();
    ~IGTLMessageQueue() override;
 
  protected:
    std::mutex m_Mutex;
 
    std::deque< igtl::MessageBase::Pointer > m_CommandQueue;
    std::deque< igtl::ImageMessage::Pointer > m_Image2dQueue;
    std::deque< igtl::ImageMessage::Pointer > m_Image3dQueue;
    std::deque< igtl::TransformMessage::Pointer > m_TransformQueue;
    std::deque< igtl::TrackingDataMessage::Pointer > m_TrackingDataQueue;
    std::deque< igtl::StringMessage::Pointer > m_StringQueue;
    std::deque< igtl::MessageBase::Pointer > m_MiscQueue;
 
    std::deque< mitk::IGTLMessage::Pointer > m_SendQueue;
 
    igtl::MessageBase::Pointer m_Latest_Message;
 
    BufferingType m_BufferingType;
  };
}
 
#endif