mitkIGTLMessageQueue.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 IGTLMessageQueue_H
#define IGTLMessageQueue_H

#include "MitkOpenIGTLinkExports.h"

#include "itkObject.h"
#include "itkFastMutexLock.h"
#include "mitkCommon.h"

#include <deque>

//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(igtl::MessageBase::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();
    igtl::MessageBase::Pointer PullSendMessage();

    int GetSize();

    std::string GetNextMsgInformationString();

    std::string GetNextMsgDeviceType();

    std::string GetLatestMsgInformationString();

    std::string GetLatestMsgDeviceType();

    void EnableInfiniteBuffering(bool enable);

  protected:
    IGTLMessageQueue();
    virtual ~IGTLMessageQueue();

  protected:
    itk::FastMutexLock::Pointer 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< igtl::MessageBase::Pointer> m_SendQueue;

    igtl::MessageBase::Pointer m_Latest_Message;

    BufferingType m_BufferingType;
  };
}

#endif