mitkIGTLDeviceSource.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 IGTLDEVICESOURCE_H_HEADER_INCLUDED_
#define IGTLDEVICESOURCE_H_HEADER_INCLUDED_

#include "mitkIGTLDevice.h"
#include "mitkIGTLMessageSource.h"

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

    static const std::string US_PROPKEY_IGTLDEVICENAME;

    virtual void SetIGTLDevice(mitk::IGTLDevice* td);

    itkGetObjectMacro(IGTLDevice, mitk::IGTLDevice);

    void RegisterAsMicroservice() override;

    void Connect();

    void Disconnect();

    void StartCommunication();

    void StopCommunication();

    virtual bool IsConnected();

    virtual bool IsCommunicating();

    void UpdateOutputInformation() override;

  protected:
    IGTLDeviceSource();
    ~IGTLDeviceSource() override;

    void GenerateData() override;

    void CreateOutputs();

    virtual void OnIncomingMessage();

    virtual void OnIncomingCommand();

    virtual void OnLostConnection();

    virtual void RemoveObservers();


    using Superclass::SetInput;

    virtual void SetInput( unsigned int idx, const IGTLMessage* msg );

    const IGTLMessage* GetInput(void) const;

    const IGTLMessage* GetInput(unsigned int idx) const;

    const IGTLMessage* GetInput(std::string msgName) const;

    DataObjectPointerArraySizeType GetInputIndex(std::string msgName);

    DataObjectPointerArraySizeType GetOutputIndex(std::string msgName);

    mitk::IGTLDevice::Pointer m_IGTLDevice;

    unsigned int m_LostConnectionObserverTag;
    unsigned int m_IncomingCommandObserverTag;
    unsigned int m_IncomingMessageObserverTag;
  };
} // namespace mitk
#endif /* MITKIGTLDeviceSource_H_HEADER_INCLUDED_ */