mitkIGTLMessageProvider.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 IGTLMESSAGEPROVIDER_H_HEADER_INCLUDED_
#define IGTLMESSAGEPROVIDER_H_HEADER_INCLUDED_

#include "mitkIGTLDevice.h"
#include "mitkIGTLDeviceSource.h"

//itk
#include "itkCommand.h"

namespace mitk {
  class MITKOPENIGTLINK_EXPORT IGTLMessageProvider : public IGTLDeviceSource
  {
  public:
    mitkClassMacro(IGTLMessageProvider, IGTLDeviceSource);
    itkFactorylessNewMacro(Self)
    itkCloneMacro(Self)

    typedef itk::SimpleMemberCommand<mitk::IGTLMessageProvider> ProviderCommand;

    void Send(const IGTLMessage* msg);

    void StartStreamingOfSource(mitk::IGTLMessageSource* src,
                                unsigned int fps);

    void StopStreamingOfSource(mitk::IGTLMessageSource* src);

    void StopStreamingOfAllSources();

    bool IsStreaming();

    itkGetMacro(StreamingTime, unsigned int);

    virtual void Update() override;

  protected:
    IGTLMessageProvider();
    virtual ~IGTLMessageProvider();

    virtual void GenerateData() override;

    void CreateOutputs();

    virtual void OnIncomingMessage() override;

    virtual void OnIncomingCommand() override;

    virtual void OnLostConnection() override;

    void ConnectTo( mitk::IGTLMessageSource* UpstreamFilter );

    void DisconnectFrom( mitk::IGTLMessageSource* UpstreamFilter );

    mitk::IGTLMessageSource::Pointer GetFittingSource(const char* requestedType);

    void InvokeStartStreamingEvent();

    void InvokeStopStreamingEvent();

  private:
    ProviderCommand::Pointer m_StreamingCommand;

    ProviderCommand::Pointer m_StopStreamingCommand;

    // * \brief Timer thread for generating a continuous time signal for the stream
    // *
    // * Everyt time the time is passed a time signal is invoked.
    // *
    // * \param pInfoStruct pointer to the mitkIGTLMessageProvider object
    // * \return
    // */
    //static ITK_THREAD_RETURN_TYPE TimerThread(void* pInfoStruct);

    //int                                       m_ThreadId;

    //bool                                      m_StopStreamingThread;

    //itk::SmartPointer<itk::MultiThreader>     m_MultiThreader;

    unsigned int                              m_StreamingTime;

    itk::SmartPointer<itk::FastMutexLock>     m_StreamingTimeMutex;

    //itk::SmartPointer<itk::FastMutexLock>     m_StopStreamingThreadMutex;

    bool                                      m_IsStreaming;

    unsigned long m_LostConnectionObserverTag;
  };

  itkEventMacro(StreamingStartRequiredEvent, itk::AnyEvent);

  itkEventMacro(StreamingStopRequiredEvent, itk::AnyEvent);

} // namespace mitk
#endif /* MITKIGTLMESSAGEPROVIDER_H_HEADER_INCLUDED_ */