vtkMRMLNodeFactory.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Copyright (c) Kitware Inc.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
 
==============================================================================*/
 
#ifndef __vtkMRMLNodeFactory_h
#define __vtkMRMLNodeFactory_h
 
// MRML includes
#include "vtkMRML.h"
 
// VTK includes
#include <vtkCommand.h>
#include <vtkObject.h>
 
// STD includes
#include <map>
#include <string>
#include <vector>
 
class vtkMRMLNode;

class VTK_MRML_EXPORT vtkMRMLNodeFactory : public vtkObject
{
public:
  static vtkMRMLNodeFactory* New();
  vtkTypeMacro(vtkMRMLNodeFactory, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  enum
  {
    NodeClassRegisteredEvent = vtkCommand::UserEvent + 1
  };

  void RegisterCoreNodeClasses();

  void RegisterNodeClass(vtkMRMLNode* node, const char* tagName);

  void RegisterNodeClass(vtkMRMLNode* node);

  void RegisterAbstractNodeClass(const std::string& className, const std::string& typeDisplayName);

  void CopyRegisteredNodeClasses(vtkMRMLNodeFactory* sourceFactory);

  vtkMRMLNode* CreateNodeByClass(const char* className);

  const char* GetClassNameByTag(const char* tagName);

  const char* GetTagByClassName(const char* className);

  std::string GetTypeDisplayNameByClassName(const std::string& className);

  int GetNumberOfRegisteredNodeClasses();
  vtkMRMLNode* GetNthRegisteredNodeClass(int n);
  bool IsNodeClassRegistered(const std::string& className);

  int GetNumberOfRegisteredAbstractNodeClasses();
  std::string GetNthRegisteredAbstractNodeClassName(int n);
  std::string GetNthRegisteredAbstractNodeTypeDisplayName(int n);
 
protected:
  vtkMRMLNodeFactory();
  ~vtkMRMLNodeFactory() override;
  vtkMRMLNodeFactory(const vtkMRMLNodeFactory&) = delete;
  void operator=(const vtkMRMLNodeFactory&) = delete;
 
  std::vector<vtkMRMLNode*> RegisteredNodeClasses;
  std::vector<std::string> RegisteredNodeTags;
  std::map<std::string, std::string> RegisteredAbstractNodeClassTypeDisplayNames; // map class name to type display name
};
 
#endif