mitkNavigationToolStorage.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 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(std::string sourceID);

    virtual void UnRegisterMicroservice();

    std::string GetMicroserviceID();

    static const std::string US_INTERFACE_NAME; // Name of the interface
    static const std::string US_PROPKEY_SOURCE_ID; // ID of the device this ToolStorage is associated with
    static const std::string US_PROPKEY_STORAGE_NAME; // name of the storage


    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();

    int GetToolCount();

    bool isEmpty();

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

    void SetName(std::string);

    itkGetConstMacro(Name,std::string);

    void LockStorage();

    void UnLockStorage();

    bool isLocked();

    void UpdateMicroservice();

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

    std::vector<mitk::NavigationTool::Pointer> m_ToolCollection;
    mitk::DataStorage::Pointer m_DataStorage;
    std::string m_Name;
    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