mitkIGTLMessageSource.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 MITKIGTLMESSAGESOURCE_H_HEADER_INCLUDED_
#define MITKIGTLMESSAGESOURCE_H_HEADER_INCLUDED_

#include <itkProcessObject.h>
#include "mitkPropertyList.h"
#include "MitkOpenIGTLinkExports.h"
#include "mitkIGTLMessage.h"

// Microservices
#include <mitkServiceInterface.h>
#include <usServiceRegistration.h>

//itk
#include <itkFastMutexLock.h>

namespace mitk {

  class MITKOPENIGTLINK_EXPORT IGTLMessageSource : public itk::ProcessObject
  {
  public:
    mitkClassMacroItkParent(IGTLMessageSource, itk::ProcessObject);

    itkGetMacro(Name,std::string);

    itkSetMacro(Name,std::string);

    itkGetMacro(Type,std::string);

    itkSetMacro(Type,std::string);

    IGTLMessage* GetOutput(void);

    IGTLMessage* GetOutput(DataObjectPointerArraySizeType idx);

    IGTLMessage* GetOutput(const std::string& messageName);

    DataObjectPointerArraySizeType GetOutputIndex(std::string messageName);

    virtual void RegisterAsMicroservice();

    virtual void UnRegisterMicroservice();

    std::string GetMicroserviceID();

    static const std::string US_INTERFACE_NAME;
    static const std::string US_PROPKEY_DEVICENAME;
    static const std::string US_PROPKEY_DEVICETYPE;
    static const std::string US_PROPKEY_ID;
    static const std::string US_PROPKEY_ISACTIVE; //NOT IMPLEMENTED YET!

    virtual void GraftNthOutput(unsigned int idx, itk::DataObject *graft);

    virtual void GraftOutput(itk::DataObject *graft);

    itk::DataObject::Pointer MakeOutput ( DataObjectPointerArraySizeType idx ) override;

    itk::DataObject::Pointer MakeOutput(const DataObjectIdentifierType &name) override;

    virtual void SetParameters(const mitk::PropertyList*){};

    virtual mitk::PropertyList::ConstPointer GetParameters() const;

    void SetFPS(unsigned int fps);

    unsigned int GetFPS();

  protected:
    IGTLMessageSource();
    ~IGTLMessageSource() override;

    std::string m_Name;
    std::string m_Type;


    itk::FastMutexLock::Pointer m_StreamingFPSMutex;
    unsigned int m_StreamingFPS;

    us::ServiceRegistration<Self> m_ServiceRegistration;
  };
} // namespace mitk
// This is the microservice declaration. Do not meddle!
MITK_DECLARE_SERVICE_INTERFACE(mitk::IGTLMessageSource, "org.mitk.services.IGTLMessageSource")
#endif /* MITKIGTLMESSAGESOURCE_H_HEADER_INCLUDED_ */