mitkNavigationDataSource.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 MITKNAVIGATIONDATASOURCE_H_HEADER_INCLUDED_
#define MITKNAVIGATIONDATASOURCE_H_HEADER_INCLUDED_

#include <itkProcessObject.h>
#include "mitkNavigationData.h"
#include <mitkNavigationTool.h>
#include <mitkNavigationToolStorage.h>
#include "mitkPropertyList.h"
#include "MitkIGTExports.h"

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

namespace mitk {

  class MITKIGT_EXPORT NavigationDataSource : public itk::ProcessObject
  {
  public:
    mitkClassMacroItkParent(NavigationDataSource, itk::ProcessObject);

    itkGetMacro(Name,std::string);

    itkSetMacro(Name,std::string);

    NavigationData* GetOutput(void);

    NavigationData* GetOutput(DataObjectPointerArraySizeType idx);

    NavigationData* GetOutput(const std::string& navDataName);

    NavigationTool::Pointer GetToolMetaData(DataObjectPointerArraySizeType idx);

    NavigationTool::Pointer GetToolMetaData(const std::string& navDataName);

    itkGetMacro(ToolMetaDataCollection, mitk::NavigationToolStorage::Pointer);

    itkSetMacro(ToolMetaDataCollection, mitk::NavigationToolStorage::Pointer);

    DataObjectPointerArraySizeType GetOutputIndex(std::string navDataName);

    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_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;

    virtual void Freeze();

    virtual void UnFreeze();

    itkGetMacro(IsFrozen,bool);


  protected:
    NavigationDataSource();
    ~NavigationDataSource() override;

    std::string m_Name;

    bool m_IsFrozen;

    NavigationToolStorage::Pointer m_ToolMetaDataCollection;


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