Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
vtkMRMLSubjectHierarchyLegacyNode Class Reference

Legacy subject hierarchy node to allow loading older MRML scenes. More...

#include <Libs/MRML/Core/vtkMRMLSubjectHierarchyLegacyNode.h>

Inheritance diagram for vtkMRMLSubjectHierarchyLegacyNode:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLSubjectHierarchyLegacyNode:
Collaboration graph
[legend]

Public Types

typedef vtkMRMLHierarchyNode Superclass
 
- Public Types inherited from vtkMRMLHierarchyNode
enum  { ChildNodeAddedEvent = 15550, ChildNodeRemovedEvent = 15551 }
 ChildNodeAddedEvent is send when a child node added to this parent. More...
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

void Copy (vtkMRMLNode *node) override
 Copy the node's attributes to this object. More...
 
vtkMRMLNodeCreateNodeInstance () override
 Create instance of the default node. Like New only virtual. More...
 
virtual const char * GetClassName ()
 
virtual char * GetLevel ()
 Get level. More...
 
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Contour) More...
 
virtual char * GetOwnerPluginName ()
 Get owner plugin name. More...
 
std::vector< vtkMRMLSubjectHierarchyLegacyNode * > GetSubjectHierarchyNodesReferencedByDICOM ()
 
std::string GetUID (std::string uidName)
 
std::map< std::string, std::string > GetUIDs () const
 Get UID map for this subject hierarchy node. More...
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReadXMLAttributes (const char **atts) override
 Read node attributes from XML file. More...
 
virtual void SetLevel (const char *)
 Set level. More...
 
virtual void SetOwnerPluginName (const char *)
 Set owner plugin name. More...
 
void WriteXML (ostream &of, int indent) override
 Write this node's information to a MRML file in XML format. More...
 
- Public Member Functions inherited from vtkMRMLHierarchyNode
virtual void AllowMultipleChildrenOff ()
 
virtual void AllowMultipleChildrenOn ()
 
void GetAllChildrenNodes (std::vector< vtkMRMLHierarchyNode *> &childrenNodes)
 
Given this hierarchy node returns all it's children recursively. More...
 
virtual int GetAllowMultipleChildren ()
 
virtual void GetAssociatedChildrenNodes (vtkCollection *children, const char *childClass=nullptr)
 
virtual vtkMRMLNodeGetAssociatedNode ()
 Get node associated with this hierarchy node. More...
 
virtual char * GetAssociatedNodeID ()
 
String ID of the corresponding displayable MRML node More...
 
std::vector< vtkMRMLHierarchyNode * > GetChildrenNodes ()
 
int GetIndexInParent ()
 Get index of this node in it's parent based on the value of their SortingValue. More...
 
vtkMRMLHierarchyNodeGetNthChildNode (int index)
 Get n-th child node sorted in the order of their SortingValue. More...
 
int GetNumberOfChildrenNodes ()
 Returns the number of immediate children in the hierarchy. More...
 
vtkMRMLHierarchyNodeGetParentNode ()
 
Associated prent MRML node More...
 
virtual char * GetParentNodeID ()
 
String ID of the parent hierarchy MRML node More...
 
virtual double GetSortingValue ()
 
vtkMRMLHierarchyNodeGetTopParentNode ()
 
Get the top parent node in the hierarchy More...
 
void MoveInParent (int increment)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void RemoveAllHierarchyChildrenNodes ()
 Removes all children hierarchy nodes including children of children, etc. More...
 
void RemoveHierarchyChildrenNodes ()
 Removes immediate children nodes, their children are reparented to this parent node. More...
 
virtual void SetAllowMultipleChildren (int)
 
virtual void SetAssociatedNodeID (const char *ref)
 
void SetIndexInParent (int index)
 Set index of this node in it's parent based on the value of their SortingValue. More...
 
virtual void SetParentNodeID (const char *ref)
 
void SetSceneReferences () override
 Set the reference node to current scene. More...
 
void SetSortingValue (double value)
 

Node's Sorting Value More...
 
void UpdateReferenceID (const char *oldID, const char *newID) override
 
Update the stored reference to another node in the scene More...
 
void UpdateReferences () override
 
void UpdateScene (vtkMRMLScene *scene) override
 
Observe the reference transform node More...
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list. More...
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
 Add a referenceRole. More...
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
virtual void CopyContent (vtkMRMLNode *node, bool deepCopy=true)
 Copy node contents from another node of the same type. Does not copy node ID, Scene, Name, SingletonTag, HideFromEditors, AddToScene, UndoEnabled, and node references. If deepCopy is set to false then a shallow copy of bulk data (such as image or mesh data) could be made; copying may be faster but the node may share some data with the source node instead of creating an independent copy. More...
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void DisableModifiedEventOff ()
 
void DisableModifiedEventOn ()
 
virtual int EndModify (int previousDisableModifiedEventState)
 End modifying the node. More...
 
virtual int GetAddToScene ()
 node added to MRML scene. More...
 
const char * GetAttribute (const char *name)
 Get value of a name value pair attribute. More...
 
std::vector< std::string > GetAttributeNames ()
 Get all attribute names. More...
 
void GetAttributeNames (vtkStringArray *attributeNames)
 Get all attribute names. Python-wrappable version. More...
 
virtual vtkIntArray * GetContentModifiedEvents ()
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros. More...
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden. More...
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML. More...
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops. More...
 
virtual int GetModifiedEventPending ()
 
virtual char * GetName ()
 
vtkMRMLNodeGetNodeReference (const char *referenceRole)
 
const char * GetNodeReferenceID (const char *referenceRole)
 Utility function that returns the first node id for a specific referenceRole. More...
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
 Return a list of the referenced node IDs. More...
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
 Return a list of the referenced nodes. More...
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceRoles ()
 
int GetNumberOfNodeReferences (const char *referenceRole)
 Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual bool GetUndoEnabled ()
 
virtual bool HasCopyContent () const
 Returns true if the class supports deep and shallow copying node content. More...
 
bool HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Return true if referencedNodeID is in the node ID list for a specific referenceRole. More...
 
virtual void HideFromEditorsOff ()
 
virtual void HideFromEditorsOn ()
 
virtual void InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
 This method allows the node to compress events. More...
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending. More...
 
bool IsSingleton ()
 
void Modified () override
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...
 
virtual void OnNodeAddedToScene ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void ProcessChildNode (vtkMRMLNode *)
 Set dependencies between this node and a child node when parsing XML file. More...
 
virtual void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
 Propagate events generated in mrml. More...
 
void RemoveAttribute (const char *name)
 Remove attribute with the specified name. More...
 
void RemoveNodeReferenceIDs (const char *referenceRole)
 Remove all node IDs and associated nodes for a specific referenceRole. More...
 
void RemoveNthNodeReferenceID (const char *referenceRole, int n)
 Convenience method that removes the Nth node ID from the list. More...
 
virtual void Reset (vtkMRMLNode *defaultNode)
 Reset node attributes to the initial state as defined in the constructor or the passed default node. More...
 
virtual void SaveWithSceneOff ()
 
virtual void SaveWithSceneOn ()
 
virtual void SelectableOff ()
 
virtual void SelectableOn ()
 
virtual void SelectedOff ()
 
virtual void SelectedOn ()
 
virtual void SetAddToScene (int)
 
void SetAddToSceneNoModify (int value)
 
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe the Nth node ID for a specific reference role. More...
 
void SetAttribute (const char *name, const char *value)
 Set a name value pair attribute. More...
 
virtual void SetDescription (const char *)
 Text description of this node, to be set by the user. More...
 
void SetDisableModifiedEvent (int onOff)
 
virtual void SetHideFromEditors (int)
 
void SetInMRMLCallbackFlag (int flag)
 
virtual void SetName (const char *)
 Name of this node, to be set by the user. More...
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
 Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More...
 
virtual void SetSaveWithScene (int)
 
virtual void SetScene (vtkMRMLScene *scene)
 This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More...
 
virtual void SetSelectable (int)
 
virtual void SetSelected (int)
 
void SetSingletonOff ()
 
void SetSingletonOn ()
 
virtual void SetSingletonTag (const char *)
 Tag that make this node a singleton in the scene. More...
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
virtual void UndoEnabledOff ()
 
virtual void UndoEnabledOn ()
 
const char * URLDecodeString (const char *inString)
 Decode a URL string. More...
 
const char * URLEncodeString (const char *inString)
 Encode a URL string. More...
 
virtual void WriteNodeBodyXML (ostream &of, int indent)
 Write this node's body to a MRML file in XML format. More...
 
std::string XMLAttributeDecodeString (const std::string &inString)
 Decode an XML attribute string. More...
 
std::string XMLAttributeEncodeString (const std::string &inString)
 Encode an XML attribute string (replaces special characters by code sequences) More...
 

Static Public Member Functions

static void DeserializeUIDList (std::string uidListString, std::vector< std::string > &deserializedUIDList)
 Deserialize a UID list string (stored in the UID map) into a vector of UID strings. More...
 
static vtkMRMLSubjectHierarchyLegacyNodeGetSubjectHierarchyLegacyNodeByUID (vtkMRMLScene *scene, const char *uidName, const char *uidValue)
 
static vtkMRMLSubjectHierarchyLegacyNodeGetSubjectHierarchyLegacyNodeByUIDList (vtkMRMLScene *scene, const char *uidName, const char *uidValue)
 
static int IsTypeOf (const char *type)
 
static vtkMRMLSubjectHierarchyLegacyNodeNew ()
 
static vtkMRMLSubjectHierarchyLegacyNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLHierarchyNode
static vtkMRMLHierarchyNodeGetAssociatedHierarchyNode (vtkMRMLScene *scene, const char *associatedNodeID)
 
Get Hierarchy node for a given associated node More...
 
static int IsTypeOf (const char *type)
 
static vtkMRMLHierarchyNodeNew ()
 
static vtkMRMLHierarchyNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Static Public Attributes

static const std::string SUBJECTHIERARCHY_UID_ITEM_SEPARATOR
 
static const std::string SUBJECTHIERARCHY_UID_NAME_VALUE_SEPARATOR
 

Protected Member Functions

void operator= (const vtkMRMLSubjectHierarchyLegacyNode &)
 
 vtkMRMLSubjectHierarchyLegacyNode ()
 
 vtkMRMLSubjectHierarchyLegacyNode (const vtkMRMLSubjectHierarchyLegacyNode &)
 
 ~vtkMRMLSubjectHierarchyLegacyNode () override
 
- Protected Member Functions inherited from vtkMRMLHierarchyNode
virtual char * GetAssociatedNodeIDReference ()
 
virtual char * GetParentNodeIDReference ()
 
void InvokeHierarchyModifiedEvent (vtkMRMLNode *node=nullptr)
 
void operator= (const vtkMRMLHierarchyNode &)
 
void SetAssociatedNodeIDReference (const char *)
 
void SetParentNodeIDReference (const char *id)
 
String ID of the parent hierarchy MRML node More...
 
void UpdateChildrenMap ()
 
 vtkMRMLHierarchyNode ()
 
 vtkMRMLHierarchyNode (const vtkMRMLHierarchyNode &)
 
 ~vtkMRMLHierarchyNode () override
 
- Protected Member Functions inherited from vtkMRMLNode
virtual const char * GetMRMLAttributeNameFromReferenceRole (const char *refRole)
 Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise. More...
 
virtual const char * GetReferenceRoleFromMRMLAttributeName (const char *attName)
 Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise. More...
 
virtual char * GetTempURLString ()
 
void GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents)
 
virtual void InvalidateNodeReferences ()
 
virtual bool IsReferenceRoleGeneric (const char *refRole)
 Return true if the reference role is generic (ends with '/') or false otherwise. More...
 
virtual void OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
 
virtual void OnNodeReferenceModified (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is modified. More...
 
virtual void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is removed (set to nullptr). More...
 
void operator= (const vtkMRMLNode &)
 
void ParseReferencesAttribute (const char *attValue, std::set< std::string > &references)
 
virtual void SetTempURLString (const char *)
 Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore)
 
virtual void UpdateNodeReferences (const char *referenceRole=nullptr)
 
virtual void UpdateNthNodeReference (const char *referenceRole, int n)
 
 vtkMRMLNode ()
 
 vtkMRMLNode (const vtkMRMLNode &)
 
 ~vtkMRMLNode () override
 critical to have a virtual destructor! More...
 

Protected Attributes

char * Level {nullptr}
 Level identifier (default levels are Subject and Study) More...
 
char * OwnerPluginName {nullptr}
 Name of the owner plugin that claimed this node. More...
 
std::map< std::string, std::string > UIDs
 
- Protected Attributes inherited from vtkMRMLHierarchyNode
int AllowMultipleChildren
 is this a node that's only supposed to have one child? More...
 
char * AssociatedNodeIDReference
 
String ID of the associated MRML node More...
 
char * ParentNodeIDReference
 
double SortingValue
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene {1}
 
AttributesType Attributes
 
vtkIntArray * ContentModifiedEvents
 
char * Description {nullptr}
 
int HideFromEditors {0}
 
char * ID {nullptr}
 
int InMRMLCallbackFlag {0}
 
Flag to avoid event loops More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name {nullptr}
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene {true}
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable {1}
 
int Selected {0}
 
bool UndoEnabled {false}
 

Additional Inherited Members

- Protected Types inherited from vtkMRMLHierarchyNode
typedef std::map< std::string, vtkMRMLHierarchyNode * > AssociatedHierarchyNodesType
 
typedef std::map< std::string, std::vector< vtkMRMLHierarchyNode * > > HierarchyChildrenNodesType
 
- Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string > AttributesType
 
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > > NodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from vtkMRMLHierarchyNode
static void AssociatedHierarchyIsModified (vtkMRMLScene *scene)
 Mark hierarchy as modified. More...
 
static void HierarchyIsModified (vtkMRMLScene *scene)
 Mark hierarchy as modified when you. More...
 
static int UpdateAssociatedToHierarchyMap (vtkMRMLScene *scene)
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- Static Protected Attributes inherited from vtkMRMLHierarchyNode
static double MaximumSortingValue
 
static std::map< vtkMRMLScene *, AssociatedHierarchyNodesTypeSceneAssociatedHierarchyNodes
 
static std::map< vtkMRMLScene *, vtkMTimeType > SceneAssociatedHierarchyNodesMTime
 
static std::map< vtkMRMLScene *, HierarchyChildrenNodesTypeSceneHierarchyChildrenNodes
 
static std::map< vtkMRMLScene *, vtkMTimeType > SceneHierarchyChildrenNodesMTime
 

Detailed Description

Legacy subject hierarchy node to allow loading older MRML scenes.

Older MRML scenes contain per-item subject hierarchy nodes, which are incompatible with the new single-node subject hierarchy design. Those nodes (identified by the lack of vtkMRMLSubjectHierarchyNode::SUBJECTHIERARCHY_VERSION_ATTRIBUTE_NAME attribute) are converted to this node type.

Notes:

Definition at line 53 of file vtkMRMLSubjectHierarchyLegacyNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 66 of file vtkMRMLSubjectHierarchyLegacyNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLSubjectHierarchyLegacyNode() [1/2]

vtkMRMLSubjectHierarchyLegacyNode::vtkMRMLSubjectHierarchyLegacyNode ( )
protected

◆ ~vtkMRMLSubjectHierarchyLegacyNode()

vtkMRMLSubjectHierarchyLegacyNode::~vtkMRMLSubjectHierarchyLegacyNode ( )
overrideprotected

◆ vtkMRMLSubjectHierarchyLegacyNode() [2/2]

vtkMRMLSubjectHierarchyLegacyNode::vtkMRMLSubjectHierarchyLegacyNode ( const vtkMRMLSubjectHierarchyLegacyNode )
protected

Member Function Documentation

◆ Copy()

void vtkMRMLSubjectHierarchyLegacyNode::Copy ( vtkMRMLNode node)
overridevirtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLHierarchyNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLSubjectHierarchyLegacyNode::CreateNodeInstance ( )
overridevirtual

Create instance of the default node. Like New only virtual.

Note
Subclasses should implement this method

Reimplemented from vtkMRMLHierarchyNode.

◆ DeserializeUIDList()

static void vtkMRMLSubjectHierarchyLegacyNode::DeserializeUIDList ( std::string  uidListString,
std::vector< std::string > &  deserializedUIDList 
)
static

Deserialize a UID list string (stored in the UID map) into a vector of UID strings.

◆ GetClassName()

virtual const char* vtkMRMLSubjectHierarchyLegacyNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLHierarchyNode.

◆ GetLevel()

virtual char* vtkMRMLSubjectHierarchyLegacyNode::GetLevel ( )
virtual

Get level.

◆ GetNodeTagName()

const char* vtkMRMLSubjectHierarchyLegacyNode::GetNodeTagName ( )
overridevirtual

Get node XML tag name (like Volume, Contour)

Reimplemented from vtkMRMLHierarchyNode.

◆ GetOwnerPluginName()

virtual char* vtkMRMLSubjectHierarchyLegacyNode::GetOwnerPluginName ( )
virtual

Get owner plugin name.

◆ GetSubjectHierarchyLegacyNodeByUID()

static vtkMRMLSubjectHierarchyLegacyNode* vtkMRMLSubjectHierarchyLegacyNode::GetSubjectHierarchyLegacyNodeByUID ( vtkMRMLScene scene,
const char *  uidName,
const char *  uidValue 
)
static

Find subject hierarchy node according to a UID (by exact match)

Parameters
sceneMRML scene
uidNameUID string to lookup
uidValueUID string that needs to exactly match the UID string of the subject hierarchy node
See also
GetUID()

◆ GetSubjectHierarchyLegacyNodeByUIDList()

static vtkMRMLSubjectHierarchyLegacyNode* vtkMRMLSubjectHierarchyLegacyNode::GetSubjectHierarchyLegacyNodeByUIDList ( vtkMRMLScene scene,
const char *  uidName,
const char *  uidValue 
)
static

Find subject hierarchy node according to a UID (by containing). For example find UID in instance UID list

Parameters
sceneMRML scene
uidNameUID string to lookup
uidValueUID string that needs to be contained in the UID string of the subject hierarchy node
Returns
First match
See also
GetUID()

◆ GetSubjectHierarchyNodesReferencedByDICOM()

std::vector<vtkMRMLSubjectHierarchyLegacyNode*> vtkMRMLSubjectHierarchyLegacyNode::GetSubjectHierarchyNodesReferencedByDICOM ( )

Get subject hierarchy nodes that are referenced from this node by DICOM. Finds the series nodes that contain the SOP instance UIDs that are listed in the MRML attribute of this node containing the referenced SOP instance UIDs

See also
vtkMRMLSubjectHierarchyConstants::GetDICOMReferencedInstanceUIDsAttributeName()

◆ GetUID()

std::string vtkMRMLSubjectHierarchyLegacyNode::GetUID ( std::string  uidName)

Get a UID with a known name

Returns
The UID value if exists, empty string if does not

◆ GetUIDs()

std::map<std::string, std::string> vtkMRMLSubjectHierarchyLegacyNode::GetUIDs ( ) const

Get UID map for this subject hierarchy node.

◆ IsA()

virtual int vtkMRMLSubjectHierarchyLegacyNode::IsA ( const char *  type)
virtual

Reimplemented from vtkMRMLHierarchyNode.

◆ IsTypeOf()

static int vtkMRMLSubjectHierarchyLegacyNode::IsTypeOf ( const char *  type)
static

◆ New()

static vtkMRMLSubjectHierarchyLegacyNode* vtkMRMLSubjectHierarchyLegacyNode::New ( )
static

IMPORTANT! New method should not be used to create subject hierarchy nodes. The nodes are created automatically for supported data types when adding the data nodes. To set up the node (name, level, parent, associated data) call

See also
CreateSubjectHierarchyNode method.

◆ operator=()

void vtkMRMLSubjectHierarchyLegacyNode::operator= ( const vtkMRMLSubjectHierarchyLegacyNode )
protected

◆ PrintSelf()

void vtkMRMLSubjectHierarchyLegacyNode::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ ReadXMLAttributes()

void vtkMRMLSubjectHierarchyLegacyNode::ReadXMLAttributes ( const char **  atts)
overridevirtual

Read node attributes from XML file.

Reimplemented from vtkMRMLHierarchyNode.

◆ SafeDownCast()

static vtkMRMLSubjectHierarchyLegacyNode* vtkMRMLSubjectHierarchyLegacyNode::SafeDownCast ( vtkObject *  o)
static

◆ SetLevel()

virtual void vtkMRMLSubjectHierarchyLegacyNode::SetLevel ( const char *  )
virtual

Set level.

◆ SetOwnerPluginName()

virtual void vtkMRMLSubjectHierarchyLegacyNode::SetOwnerPluginName ( const char *  )
virtual

Set owner plugin name.

◆ WriteXML()

void vtkMRMLSubjectHierarchyLegacyNode::WriteXML ( ostream &  of,
int  indent 
)
overridevirtual

Write this node's information to a MRML file in XML format.

Reimplemented from vtkMRMLHierarchyNode.

Member Data Documentation

◆ Level

char* vtkMRMLSubjectHierarchyLegacyNode::Level {nullptr}
protected

Level identifier (default levels are Subject and Study)

Definition at line 129 of file vtkMRMLSubjectHierarchyLegacyNode.h.

◆ OwnerPluginName

char* vtkMRMLSubjectHierarchyLegacyNode::OwnerPluginName {nullptr}
protected

Name of the owner plugin that claimed this node.

Definition at line 132 of file vtkMRMLSubjectHierarchyLegacyNode.h.

◆ SUBJECTHIERARCHY_UID_ITEM_SEPARATOR

const std::string vtkMRMLSubjectHierarchyLegacyNode::SUBJECTHIERARCHY_UID_ITEM_SEPARATOR
static

Definition at line 57 of file vtkMRMLSubjectHierarchyLegacyNode.h.

◆ SUBJECTHIERARCHY_UID_NAME_VALUE_SEPARATOR

const std::string vtkMRMLSubjectHierarchyLegacyNode::SUBJECTHIERARCHY_UID_NAME_VALUE_SEPARATOR
static

Definition at line 58 of file vtkMRMLSubjectHierarchyLegacyNode.h.

◆ UIDs

std::map<std::string, std::string> vtkMRMLSubjectHierarchyLegacyNode::UIDs
protected

List of UIDs of this subject hierarchy node UIDs can be DICOM UIDs, MIDAS urls, etc.

Definition at line 136 of file vtkMRMLSubjectHierarchyLegacyNode.h.


The documentation for this class was generated from the following file: