mitkNavigationToolStorage.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 NAVIGATIONTOOLSTORAGE_H_INCLUDED
#define NAVIGATIONTOOLSTORAGE_H_INCLUDED

//itk headers
#include <itkObjectFactory.h>

//mitk headers
#include <mitkCommon.h>
#include <MitkIGTExports.h>
#include "mitkNavigationTool.h"
#include <mitkDataStorage.h>

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

namespace mitk {
  class MITKIGT_EXPORT NavigationToolStorage : public itk::Object
  {
  public:
    mitkClassMacroItkParent(NavigationToolStorage,itk::Object);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self)
    mitkNewMacro1Param(Self,mitk::DataStorage::Pointer);


    virtual void RegisterAsMicroservice();

    virtual void UnRegisterMicroservice();

    std::string GetMicroserviceID();

    // Name of the interface
    static const std::string US_INTERFACE_NAME;
    // ID of the NavigationDataSource this ToolStorage is associated with. Can be empty ("") and changed with SetSourceID().
    static const std::string US_PROPKEY_SOURCE_ID;
    // name of the storage
    static const std::string US_PROPKEY_STORAGE_NAME;


    bool AddTool(mitk::NavigationTool::Pointer tool);

    mitk::NavigationTool::Pointer GetTool(int number);

    mitk::NavigationTool::Pointer GetTool(std::string identifier);

    mitk::NavigationTool::Pointer GetToolByName(std::string name);

    bool AssignToolNumber(std::string identifier1, int number2);

    bool DeleteTool(int number);

    bool DeleteAllTools();

    unsigned int GetToolCount();

    bool isEmpty();

    itkGetMacro(DataStorage,mitk::DataStorage::Pointer);

    void SetName(std::string);

    std::string GetName() const;

    void SetSourceID(std::string);

    std::string GetSourceID() const;

    void LockStorage();

    void UnLockStorage();

    bool isLocked();

    void UpdateMicroservice();

  protected:
    NavigationToolStorage();
    NavigationToolStorage(mitk::DataStorage::Pointer);
    ~NavigationToolStorage() override;

    std::vector<mitk::NavigationTool::Pointer> m_ToolCollection;
    mitk::DataStorage::Pointer m_DataStorage;
    std::string m_Name;
    std::string m_SourceID;
    bool m_storageLocked;

  private:
    us::ServiceRegistration<Self> m_ServiceRegistration;
    us::ServiceProperties m_props;

  };
} // namespace mitk
MITK_DECLARE_SERVICE_INTERFACE(mitk::NavigationToolStorage, "org.mitk.services.NavigationToolStorage")
#endif //NAVIGATIONTOOLSTORAGE