![]() |
Slicer
4.8
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
Legacy subject hierarchy node to allow loading older MRML scenes. More...
#include <Libs/MRML/Core/vtkMRMLSubjectHierarchyLegacyNode.h>
Public Types | |
typedef vtkMRMLHierarchyNode | Superclass |
![]() | |
enum | { ChildNodeAddedEvent = 15550, ChildNodeRemovedEvent = 15551 } |
ChildNodeAddedEvent is send when a child node added to this parent. More... | |
typedef vtkMRMLNode | Superclass |
![]() | |
enum | { HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent, ReferenceRemovedEvent, ReferencedNodeModifiedEvent } |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual void | Copy (vtkMRMLNode *node) VTK_OVERRIDE |
Copy the node's attributes to this object. More... | |
virtual vtkMRMLNode * | CreateNodeInstance () VTK_OVERRIDE |
Create instance of the default node. Like New only virtual. More... | |
virtual const char * | GetClassName () |
virtual char * | GetLevel () |
Get level. More... | |
virtual const char * | GetNodeTagName () VTK_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) VTK_OVERRIDE |
virtual void | ReadXMLAttributes (const char **atts) VTK_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... | |
virtual void | WriteXML (ostream &of, int indent) VTK_OVERRIDE |
Write this node's information to a MRML file in XML format. More... | |
![]() | |
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=NULL) |
virtual vtkMRMLNode * | GetAssociatedNode () |
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... | |
vtkMRMLHierarchyNode * | GetNthChildNode (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... | |
vtkMRMLHierarchyNode * | GetParentNode () |
Associated prent MRML node. More... | |
virtual char * | GetParentNodeID () |
String ID of the parent hierarchy MRML node. More... | |
virtual double | GetSortingValue () |
vtkMRMLHierarchyNode * | GetTopParentNode () |
Get the top parent node in the hierarchy. More... | |
void | MoveInParent (int increment) |
void | PrintSelf (ostream &os, vtkIndent indent) VTK_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) |
virtual void | SetSceneReferences () VTK_OVERRIDE |
Set the reference node to current scene. More... | |
void | SetSortingValue (double value) |
Node's Sorting Value. More... | |
virtual void | UpdateReferenceID (const char *oldID, const char *newID) VTK_OVERRIDE |
Update the stored reference to another node in the scene. More... | |
virtual void | UpdateReferences () VTK_OVERRIDE |
virtual void | UpdateScene (vtkMRMLScene *scene) VTK_OVERRIDE |
Observe the reference transform node. More... | |
![]() | |
vtkMRMLNode * | AddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=0) |
Add and observe a reference node from this node for a specific referenceRole. More... | |
vtkMRMLNode * | AddNodeReferenceID (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=0, vtkIntArray *events=0) |
Add a referenceRole. More... | |
virtual void | AddToSceneOff () |
virtual void | AddToSceneOn () |
virtual void | CopyReferences (vtkMRMLNode *node) |
Copy the references of the node into this. More... | |
void | CopyWithoutModifiedEvent (vtkMRMLNode *node) |
void | CopyWithScene (vtkMRMLNode *node) |
Copy everything (including Scene and ID) from another node of the same type. More... | |
void | CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node) |
Copy everything (including Scene and ID) from another node of the same type. More... | |
void | CopyWithSingleModifiedEvent (vtkMRMLNode *node) |
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 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 () |
vtkMRMLNode * | GetNodeReference (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... | |
vtkMRMLNode * | GetNthNodeReference (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 vtkMRMLScene * | GetScene () |
Only the scene can set itself to the node. More... | |
virtual int | GetSelectable () |
Describes if the node is selectable. More... | |
virtual int | GetSelected () |
Get/Set for Selected. More... | |
virtual char * | GetSingletonTag () |
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=NULL) |
This method allows the node to compress events. More... | |
virtual int | InvokePendingModifiedEvent () |
Invokes any modified events that are pending . More... | |
bool | IsSingleton () |
virtual void | Modified () VTK_OVERRIDE |
Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More... | |
virtual void | OnNodeAddedToScene () |
void | PrintSelf (ostream &os, vtkIndent indent) VTK_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) |
vtkMRMLNode * | SetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=0) |
Set and observe a reference node from this node for a specific referenceRole. More... | |
vtkMRMLNode * | SetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=0) |
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... | |
vtkMRMLNode * | SetNodeReferenceID (const char *referenceRole, const char *referencedNodeID) |
Set a reference to a node with specified nodeID from this node for a specific referenceRole. More... | |
vtkMRMLNode * | SetNthNodeReferenceID (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) |
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 int | StartModify () |
Start modifying the node. Disable Modify events. More... | |
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... | |
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 vtkMRMLSubjectHierarchyLegacyNode * | GetSubjectHierarchyLegacyNodeByUID (vtkMRMLScene *scene, const char *uidName, const char *uidValue) |
static vtkMRMLSubjectHierarchyLegacyNode * | GetSubjectHierarchyLegacyNodeByUIDList (vtkMRMLScene *scene, const char *uidName, const char *uidValue) |
static int | IsTypeOf (const char *type) |
static vtkMRMLSubjectHierarchyLegacyNode * | New () |
static vtkMRMLSubjectHierarchyLegacyNode * | SafeDownCast (vtkObject *o) |
![]() | |
static vtkMRMLHierarchyNode * | GetAssociatedHierarchyNode (vtkMRMLScene *scene, const char *associatedNodeID) |
Get Hierarchy node for a given associated node. More... | |
static int | IsTypeOf (const char *type) |
static vtkMRMLHierarchyNode * | New () |
static vtkMRMLHierarchyNode * | SafeDownCast (vtkObject *o) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkMRMLNode * | SafeDownCast (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 () | |
![]() | |
virtual char * | GetAssociatedNodeIDReference () |
virtual char * | GetParentNodeIDReference () |
void | InvokeHierarchyModifiedEvent (vtkMRMLNode *node=NULL) |
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 () | |
![]() | |
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 NULL). More... | |
void | operator= (const vtkMRMLNode &) |
void | ParseReferencesAttribute (const char *attValue, std::map< std::string, std::string > &references) |
virtual void | SetTempURLString (const char *) |
Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More... | |
vtkMRMLNode * | UpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore) |
virtual void | UpdateNodeReferences (const char *referenceRole=NULL) |
virtual void | UpdateNthNodeReference (const char *referenceRole, int n) |
vtkMRMLNode () | |
vtkMRMLNode (const vtkMRMLNode &) | |
virtual | ~vtkMRMLNode () |
critical to have a virtual destructor! More... | |
Protected Attributes | |
char * | Level |
Level identifier (default levels are Subject and Study) More... | |
char * | OwnerPluginName |
Name of the owner plugin that claimed this node. More... | |
std::map< std::string, std::string > | UIDs |
![]() | |
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 |
![]() | |
int | AddToScene |
AttributesType | Attributes |
char * | Description |
int | HideFromEditors |
char * | ID |
int | InMRMLCallbackFlag |
Flag to avoid event loops. More... | |
vtkCallbackCommand * | MRMLCallbackCommand |
Holders for MRML callbacks. More... | |
vtkObserverManager * | MRMLObserverManager |
char * | Name |
NodeReferenceEventsType | NodeReferenceEvents |
std::map< std::string, std::string > | NodeReferenceMRMLAttributeNames |
NodeReferencesType | NodeReferences |
int | SaveWithScene |
vtkWeakPointer< vtkMRMLScene > | Scene |
int | Selectable |
int | Selected |
Additional Inherited Members | |
![]() | |
typedef std::map< std::string, vtkMRMLHierarchyNode * > | AssociatedHierarchyNodesType |
typedef std::map< std::string, std::vector< vtkMRMLHierarchyNode * > > | HierarchyChildrenNodesType |
![]() | |
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, NodeReferenceListType > | NodeReferencesType |
![]() | |
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 void | MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData) |
![]() | |
static double | MaximumSortingValue |
static std::map< vtkMRMLScene *, AssociatedHierarchyNodesType > | SceneAssociatedHierarchyNodes |
static std::map< vtkMRMLScene *, vtkMTimeType > | SceneAssociatedHierarchyNodesMTime |
static std::map< vtkMRMLScene *, HierarchyChildrenNodesType > | SceneHierarchyChildrenNodes |
static std::map< vtkMRMLScene *, vtkMTimeType > | SceneHierarchyChildrenNodesMTime |
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.
Definition at line 66 of file vtkMRMLSubjectHierarchyLegacyNode.h.
|
protected |
|
protected |
|
protected |
|
virtual |
Copy the node's attributes to this object.
Reimplemented from vtkMRMLHierarchyNode.
|
virtual |
Create instance of the default node. Like New only virtual.
Reimplemented from vtkMRMLHierarchyNode.
|
static |
Deserialize a UID list string (stored in the UID map) into a vector of UID strings.
|
virtual |
Reimplemented from vtkMRMLHierarchyNode.
|
virtual |
Get level.
|
virtual |
Get node XML tag name (like Volume, Contour)
Reimplemented from vtkMRMLHierarchyNode.
|
virtual |
Get owner plugin name.
|
static |
Find subject hierarchy node according to a UID (by exact match)
scene | MRML scene |
uidName | UID string to lookup |
uidValue | UID string that needs to exactly match the UID string of the subject hierarchy node |
|
static |
Find subject hierarchy node according to a UID (by containing). For example find UID in instance UID list
scene | MRML scene |
uidName | UID string to lookup |
uidValue | UID string that needs to be contained in the UID string of the subject hierarchy node |
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
std::string vtkMRMLSubjectHierarchyLegacyNode::GetUID | ( | std::string | uidName | ) |
Get a UID with a known name
std::map<std::string, std::string> vtkMRMLSubjectHierarchyLegacyNode::GetUIDs | ( | ) | const |
Get UID map for this subject hierarchy node.
|
virtual |
Reimplemented from vtkMRMLHierarchyNode.
|
static |
|
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
|
protected |
void vtkMRMLSubjectHierarchyLegacyNode::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
virtual |
Read node attributes from XML file.
Reimplemented from vtkMRMLHierarchyNode.
|
static |
|
virtual |
Set level.
|
virtual |
Set owner plugin name.
|
virtual |
Write this node's information to a MRML file in XML format.
Reimplemented from vtkMRMLHierarchyNode.
|
protected |
Level identifier (default levels are Subject and Study)
Definition at line 129 of file vtkMRMLSubjectHierarchyLegacyNode.h.
|
protected |
Name of the owner plugin that claimed this node.
Definition at line 132 of file vtkMRMLSubjectHierarchyLegacyNode.h.
|
static |
Definition at line 57 of file vtkMRMLSubjectHierarchyLegacyNode.h.
|
static |
Definition at line 58 of file vtkMRMLSubjectHierarchyLegacyNode.h.
|
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.