mitkStandaloneDataStorage.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 mitkStandaloneDataStorage_h
#define mitkStandaloneDataStorage_h
 
#include <itkVectorContainer.h>
#include <mitkDataStorage.h>
#include <mitkMessage.h>
#include <map>
#include <mutex>
 
namespace mitk
{
  class NodePredicateBase;
  class DataNode;
 
  class MITKCORE_EXPORT StandaloneDataStorage : public mitk::DataStorage
  {
  public:
    mitkClassMacro(StandaloneDataStorage, mitk::DataStorage);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);
 
    void Add(mitk::DataNode *node, const mitk::DataStorage::SetOfObjects *parents = nullptr) override;
    using DataStorage::Add; //ensure that also "void Add(DataNode *node, DataNode *parent);" is visible
 
    void Remove(const mitk::DataNode *node) override;
 
    bool Exists(const mitk::DataNode *node) const override;
 
    SetOfObjects::ConstPointer GetSources(const mitk::DataNode *node,
                                          const NodePredicateBase *condition = nullptr,
                                          bool onlyDirectSources = true) const override;
 
    SetOfObjects::ConstPointer GetDerivations(const mitk::DataNode *node,
                                              const NodePredicateBase *condition = nullptr,
                                              bool onlyDirectDerivations = true) const override;
 
    SetOfObjects::ConstPointer GetAll() const override;
 
    mutable std::mutex m_Mutex;
 
  protected:
    //##Documentation
    //## @brief noncyclical directed graph data structure to store the nodes with their relation
    typedef std::map<mitk::DataNode::ConstPointer, SetOfObjects::ConstPointer> AdjacencyList;
 
    StandaloneDataStorage();
    ~StandaloneDataStorage() override;
 
    //##Documentation
    //## @brief convenience method to check if the object has been initialized (i.e. a data tree has been set)
    bool IsInitialized() const;
 
    //##Documentation
    //## @brief Traverses the Relation graph and extracts a list of related elements (e.g. Sources or Derivations)
    SetOfObjects::ConstPointer GetRelations(const mitk::DataNode *node,
                                            const AdjacencyList &relation,
                                            const NodePredicateBase *condition = nullptr,
                                            bool onlyDirectlyRelated = true) const;
 
    //##Documentation
    //## @brief deletes all references to a node in a given relation (used in Remove() and TreeListener)
    void RemoveFromRelation(const mitk::DataNode *node, AdjacencyList &relation);
 
    //##Documentation
    //## @brief Prints the contents of the StandaloneDataStorage to os. Do not call directly, call ->Print() instead
    void PrintSelf(std::ostream &os, itk::Indent indent) const override;
 
    //##Documentation
    //## @brief Nodes and their relation are stored in m_SourceNodes
    AdjacencyList m_SourceNodes;
    //##Documentation
    //## @brief Nodes are stored in reverse relation for easier traversal in the opposite direction of the relation
    AdjacencyList m_DerivedNodes;
  };
} // namespace mitk
#endif