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

MRML node for representing a sequence of MRML nodes. More...

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

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

Classes

struct  IndexEntryType
 

Public Types

enum  IndexTypes { NumericIndex = 0, TextIndex, NumberOfIndexTypes }
 
typedef vtkMRMLStorableNode Superclass
 
- Public Types inherited from vtkMRMLStorableNode
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...
 
virtual void CopySequenceIndex (vtkMRMLNode *node)
 
vtkMRMLStorageNodeCreateDefaultStorageNode () override
 
vtkMRMLNodeCreateNodeInstance () override
 Create instance of a sequence node. More...
 
virtual const char * GetClassName ()
 
vtkMRMLNodeGetDataNodeAtValue (const std::string &indexValue, bool exactMatchRequired=true)
 
std::string GetDataNodeClassName ()
 Return the class name of the data nodes (e.g., vtkMRMLTransformNode). If there are no data nodes yet then it returns empty string. More...
 
std::string GetDataNodeTagName ()
 Return the human-readable type name of the data nodes (e.g., TransformNode). If there are no data nodes yet then it returns the string "undefined". More...
 
std::string GetDefaultStorageNodeClassName (const char *filename=nullptr) override
 
virtual std::string GetIndexName ()
 Get index name (example: time) More...
 
virtual int GetIndexType ()
 Get the type of the index (numeric, text, ...) More...
 
virtual std::string GetIndexTypeAsString ()
 
virtual std::string GetIndexUnit ()
 Get unit for the index (example: s) More...
 
int GetItemNumberFromIndexValue (const std::string &indexValue, bool exactMatchRequired=true)
 
const char * GetNodeTagName () override
 Get unique node XML tag name (like Volume, Model) More...
 
vtkMRMLNodeGetNthDataNode (int itemNumber)
 Get the data node corresponding to the n-th index value. More...
 
std::string GetNthIndexValue (int itemNumber)
 Index value of n-th data node. More...
 
int GetNumberOfDataNodes ()
 Return the number of nodes stored in this sequence. More...
 
virtual double GetNumericIndexValueTolerance ()
 
vtkMRMLSceneGetSequenceScene (bool autoCreate=true)
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReadXMLAttributes (const char **atts) override
 Set node attributes from name/value pairs. More...
 
void RemoveAllDataNodes ()
 Remove all data nodes from the sequence. More...
 
void RemoveDataNodeAtValue (const std::string &indexValue)
 Remove data node corresponding to the specified index. More...
 
vtkMRMLNodeSetDataNodeAtValue (vtkMRMLNode *node, const std::string &indexValue)
 
void SetIndexName (const std::string &str)
 Set index name (example: time) More...
 
void SetIndexType (int indexType)
 Set the type of the index (numeric, text, ...) More...
 
void SetIndexTypeFromString (const char *indexTypeString)
 
void SetIndexUnit (const std::string &str)
 Set unit for the index (example: s) More...
 
void SetNumericIndexValueTolerance (double tolerance)
 Set tolerance value for comparing numerix index values. More...
 
bool UpdateDataNodeAtValue (vtkMRMLNode *node, const std::string &indexValue, bool shallowCopy=false)
 
bool UpdateIndexValue (const std::string &oldIndexValue, const std::string &newIndexValue)
 Change index value of an existing data node. More...
 
void UpdateScene (vtkMRMLScene *scene) override
 Update node IDs in case of node ID conflicts on scene import. More...
 
void UpdateSequenceIndex ()
 Update sequence index to point to nodes. 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 vtkMRMLStorableNode
void AddAndObserveStorageNodeID (const char *storageNodeID)
 
virtual bool AddDefaultStorageNode (const char *filename=nullptr)
 
void Copy (vtkMRMLNode *node) override
 Copy node contents from another node of the same type. Reimplemented to copy default sequence storage node class. More...
 
virtual vtkMRMLStorageNodeCreateDefaultSequenceStorageNode ()
 
virtual std::string GetDefaultSequenceStorageNodeClassName ()
 
virtual bool GetModifiedSinceRead ()
 
vtkMRMLStorageNodeGetNthStorageNode (int n)
 
Get associated display MRML node More...
 
const char * GetNthStorageNodeID (int n)
 
int GetNumberOfStorageNodes ()
 
const char * GetSlicerDataType ()
 
vtkMRMLStorageNodeGetStorageNode ()
 
const char * GetStorageNodeID ()
 
virtual vtkTagTableGetUserTagTable ()
 Methods for user-specified metadata. More...
 
bool HasStorageNodeID (const char *storageNodeID)
 
Return true if storageNodeID is in the storage node ID list. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *, unsigned long, void *) override
 
alternative method to propagate events generated in Storage nodes More...
 
void ReadXMLAttributes (const char **atts) override
 
Read node attributes from XML file More...
 
void SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)
 
void SetAndObserveStorageNodeID (const char *storageNodeID)
 
String ID of the storage MRML node More...
 
virtual void SetDefaultSequenceStorageNodeClassName (std::string)
 
void SetSlicerDataType (const char *type)
 
virtual void StorableModified ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data More...
 
 vtkMRMLCopyContentMacro (vtkMRMLStorableNode)
 
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 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 ()
 
int GetCustomModifiedEventPending (int eventId)
 
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 const char * GetTypeDisplayName ()
 
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...
 
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 SetSceneReferences ()
 Update the references of the 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 ()
 
virtual void UpdateReferenceID (const char *oldID, const char *newID)
 Update the stored reference to another node in the scene. More...
 
virtual void UpdateReferences ()
 The method should remove all pointers and observations to all nodes that are not in the scene anymore. 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...
 
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 std::string GetIndexTypeAsString (int indexType)
 Helper functions for converting between string and code representation of the index type. More...
 
static int GetIndexTypeFromString (const std::string &indexTypeString)
 
static int IsTypeOf (const char *type)
 
static vtkMRMLSequenceNodeNew ()
 
static vtkMRMLSequenceNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLStorableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLStorableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

vtkMRMLNodeDeepCopyNodeToScene (vtkMRMLNode *source, vtkMRMLScene *scene)
 
int GetInsertPosition (const std::string &indexValue)
 
void operator= (const vtkMRMLSequenceNode &)
 
void ReadIndexValues (const std::string &indexText)
 
 vtkMRMLSequenceNode ()
 
 vtkMRMLSequenceNode (const vtkMRMLSequenceNode &)
 
 ~vtkMRMLSequenceNode () override
 
- Protected Member Functions inherited from vtkMRMLStorableNode
virtual const char * GetStorageNodeReferenceMRMLAttributeName ()
 
virtual const char * GetStorageNodeReferenceRole ()
 
virtual vtkTimeStamp GetStoredTime ()
 
void operator= (const vtkMRMLStorableNode &)
 
 vtkMRMLStorableNode ()
 
 vtkMRMLStorableNode (const vtkMRMLStorableNode &)
 
 ~vtkMRMLStorableNode () 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)
 
void RemoveInvalidReferences (const std::set< std::string > &validNodeIDs)
 
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

std::deque< IndexEntryTypeIndexEntries
 List of data items (the scene may contain some more nodes, such as storage nodes) More...
 
std::string IndexName
 Describes index of the sequence node. More...
 
int IndexType {vtkMRMLSequenceNode::NumericIndex}
 
std::string IndexUnit
 
double NumericIndexValueTolerance {0.001}
 
vtkMRMLSceneSequenceScene {0}
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string DefaultSequenceStorageNodeClassName
 
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- 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 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 vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- Static Protected Attributes inherited from vtkMRMLStorableNode
static const char * StorageNodeReferenceMRMLAttributeName
 
static const char * StorageNodeReferenceRole
 

Detailed Description

MRML node for representing a sequence of MRML nodes.

This node contains a sequence of nodes (data nodes).

The data nodes can be referred to by an index, for example: IndexName: time IndexUnit: s IndexNumeric: YES IndexValue: 3.4567

If an index is numeric then it is sorted differently and equality determined using a numerical tolerance instead of exact string matching.

Definition at line 43 of file vtkMRMLSequenceNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 of file vtkMRMLSequenceNode.h.

Member Enumeration Documentation

◆ IndexTypes

Type of the index. Controls the behavior of sorting, finding, etc. Additional types may be added in the future, such as tag cloud, two-dimensional index, ...

Enumerator
NumericIndex 
TextIndex 
NumberOfIndexTypes 

Definition at line 161 of file vtkMRMLSequenceNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLSequenceNode() [1/2]

vtkMRMLSequenceNode::vtkMRMLSequenceNode ( )
protected

◆ ~vtkMRMLSequenceNode()

vtkMRMLSequenceNode::~vtkMRMLSequenceNode ( )
overrideprotected

◆ vtkMRMLSequenceNode() [2/2]

vtkMRMLSequenceNode::vtkMRMLSequenceNode ( const vtkMRMLSequenceNode )
protected

Member Function Documentation

◆ Copy()

void vtkMRMLSequenceNode::Copy ( vtkMRMLNode node)
overridevirtual


Copy the node's attributes to this object

Reimplemented from vtkMRMLNode.

◆ CopySequenceIndex()

virtual void vtkMRMLSequenceNode::CopySequenceIndex ( vtkMRMLNode node)
virtual

Copy sequence index information (index name, unit, type, values, etc) Does not copy data nodes.

◆ CreateDefaultStorageNode()

vtkMRMLStorageNode* vtkMRMLSequenceNode::CreateDefaultStorageNode ( )
overridevirtual

Create default storage node. Uses vtkMRMLSequenceStorageNode unless the data node requests a more specific storage node class.

Reimplemented from vtkMRMLStorableNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLSequenceNode::CreateNodeInstance ( )
overridevirtual

Create instance of a sequence node.

Implements vtkMRMLStorableNode.

◆ DeepCopyNodeToScene()

vtkMRMLNode* vtkMRMLSequenceNode::DeepCopyNodeToScene ( vtkMRMLNode source,
vtkMRMLScene scene 
)
protected

◆ GetClassName()

virtual const char* vtkMRMLSequenceNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLStorableNode.

◆ GetDataNodeAtValue()

vtkMRMLNode* vtkMRMLSequenceNode::GetDataNodeAtValue ( const std::string &  indexValue,
bool  exactMatchRequired = true 
)

Get the node corresponding to the specified index value If exact match is not required and index is numeric then the best matching data node is returned.

◆ GetDataNodeClassName()

std::string vtkMRMLSequenceNode::GetDataNodeClassName ( )

Return the class name of the data nodes (e.g., vtkMRMLTransformNode). If there are no data nodes yet then it returns empty string.

◆ GetDataNodeTagName()

std::string vtkMRMLSequenceNode::GetDataNodeTagName ( )

Return the human-readable type name of the data nodes (e.g., TransformNode). If there are no data nodes yet then it returns the string "undefined".

◆ GetDefaultStorageNodeClassName()

std::string vtkMRMLSequenceNode::GetDefaultStorageNodeClassName ( const char *  filename = nullptr)
overridevirtual

Returns the most specific storage node possible (such as stvtkMRMLVolumeSequenceStorageNode if sequence contains volumes with the same type and geometry, or vtkMRMLLinearTransformSequenceStorageNode if sequence contains a list of linear transforms) and generic vtkMRMLSequenceStorageNode otherwise.

Reimplemented from vtkMRMLStorableNode.

◆ GetIndexName()

virtual std::string vtkMRMLSequenceNode::GetIndexName ( )
virtual

Get index name (example: time)

◆ GetIndexType()

virtual int vtkMRMLSequenceNode::GetIndexType ( )
virtual

Get the type of the index (numeric, text, ...)

◆ GetIndexTypeAsString() [1/2]

virtual std::string vtkMRMLSequenceNode::GetIndexTypeAsString ( )
virtual

◆ GetIndexTypeAsString() [2/2]

static std::string vtkMRMLSequenceNode::GetIndexTypeAsString ( int  indexType)
static

Helper functions for converting between string and code representation of the index type.

◆ GetIndexTypeFromString()

static int vtkMRMLSequenceNode::GetIndexTypeFromString ( const std::string &  indexTypeString)
static

◆ GetIndexUnit()

virtual std::string vtkMRMLSequenceNode::GetIndexUnit ( )
virtual

Get unit for the index (example: s)

◆ GetInsertPosition()

int vtkMRMLSequenceNode::GetInsertPosition ( const std::string &  indexValue)
protected

Get the index where an item would need to be inserted to. If numeric index then insert it by respecting sorting order, otherwise insert to the end.

◆ GetItemNumberFromIndexValue()

int vtkMRMLSequenceNode::GetItemNumberFromIndexValue ( const std::string &  indexValue,
bool  exactMatchRequired = true 
)

If exact match is not required and index is numeric then the best matching data node is returned. If the sequences has numeric index, uses data node just before the index value in the case of non-exact match

◆ GetNodeTagName()

const char* vtkMRMLSequenceNode::GetNodeTagName ( )
inlineoverridevirtual

Get unique node XML tag name (like Volume, Model)

Implements vtkMRMLStorableNode.

Definition at line 71 of file vtkMRMLSequenceNode.h.

◆ GetNthDataNode()

vtkMRMLNode* vtkMRMLSequenceNode::GetNthDataNode ( int  itemNumber)

Get the data node corresponding to the n-th index value.

◆ GetNthIndexValue()

std::string vtkMRMLSequenceNode::GetNthIndexValue ( int  itemNumber)

Index value of n-th data node.

◆ GetNumberOfDataNodes()

int vtkMRMLSequenceNode::GetNumberOfDataNodes ( )

Return the number of nodes stored in this sequence.

◆ GetNumericIndexValueTolerance()

virtual double vtkMRMLSequenceNode::GetNumericIndexValueTolerance ( )
virtual

Get tolerance value for comparing numerix index values. If index values differ by less than the tolerance then the index values considered to be equal.

◆ GetSequenceScene()

vtkMRMLScene* vtkMRMLSequenceNode::GetSequenceScene ( bool  autoCreate = true)

Return the internal scene that stores all the data nodes. If autoCreate is enabled then the sequence scene is created (if it has not been created already).

◆ IsA()

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

Reimplemented from vtkMRMLStorableNode.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLSequenceNode* vtkMRMLSequenceNode::New ( )
static

◆ operator=()

void vtkMRMLSequenceNode::operator= ( const vtkMRMLSequenceNode )
protected

◆ PrintSelf()

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

◆ ReadIndexValues()

void vtkMRMLSequenceNode::ReadIndexValues ( const std::string &  indexText)
protected

◆ ReadXMLAttributes()

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

Set node attributes from name/value pairs.

Reimplemented from vtkMRMLNode.

◆ RemoveAllDataNodes()

void vtkMRMLSequenceNode::RemoveAllDataNodes ( )

Remove all data nodes from the sequence.

◆ RemoveDataNodeAtValue()

void vtkMRMLSequenceNode::RemoveDataNodeAtValue ( const std::string &  indexValue)

Remove data node corresponding to the specified index.

◆ SafeDownCast()

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

◆ SetDataNodeAtValue()

vtkMRMLNode* vtkMRMLSequenceNode::SetDataNodeAtValue ( vtkMRMLNode node,
const std::string &  indexValue 
)

Add a copy of the provided node to this sequence as a data node. If a sequence item is not found by that index, a new item is added. Always performs deep-copy. Returns the data node copy that has just been created.

◆ SetIndexName()

void vtkMRMLSequenceNode::SetIndexName ( const std::string &  str)

Set index name (example: time)

◆ SetIndexType()

void vtkMRMLSequenceNode::SetIndexType ( int  indexType)

Set the type of the index (numeric, text, ...)

◆ SetIndexTypeFromString()

void vtkMRMLSequenceNode::SetIndexTypeFromString ( const char *  indexTypeString)

◆ SetIndexUnit()

void vtkMRMLSequenceNode::SetIndexUnit ( const std::string &  str)

Set unit for the index (example: s)

◆ SetNumericIndexValueTolerance()

void vtkMRMLSequenceNode::SetNumericIndexValueTolerance ( double  tolerance)

Set tolerance value for comparing numerix index values.

◆ UpdateDataNodeAtValue()

bool vtkMRMLSequenceNode::UpdateDataNodeAtValue ( vtkMRMLNode node,
const std::string &  indexValue,
bool  shallowCopy = false 
)

Update an existing data node. Return true if a data node was found by that index.

◆ UpdateIndexValue()

bool vtkMRMLSequenceNode::UpdateIndexValue ( const std::string &  oldIndexValue,
const std::string &  newIndexValue 
)

Change index value of an existing data node.

◆ UpdateScene()

void vtkMRMLSequenceNode::UpdateScene ( vtkMRMLScene scene)
overridevirtual

Update node IDs in case of node ID conflicts on scene import.

Reimplemented from vtkMRMLNode.

◆ UpdateSequenceIndex()

void vtkMRMLSequenceNode::UpdateSequenceIndex ( )

Update sequence index to point to nodes.

◆ WriteXML()

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

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

Reimplemented from vtkMRMLNode.

Member Data Documentation

◆ IndexEntries

std::deque< IndexEntryType > vtkMRMLSequenceNode::IndexEntries
protected

List of data items (the scene may contain some more nodes, such as storage nodes)

Definition at line 202 of file vtkMRMLSequenceNode.h.

◆ IndexName

std::string vtkMRMLSequenceNode::IndexName
protected

Describes index of the sequence node.

Definition at line 192 of file vtkMRMLSequenceNode.h.

◆ IndexType

int vtkMRMLSequenceNode::IndexType {vtkMRMLSequenceNode::NumericIndex}
protected

Definition at line 194 of file vtkMRMLSequenceNode.h.

◆ IndexUnit

std::string vtkMRMLSequenceNode::IndexUnit
protected

Definition at line 193 of file vtkMRMLSequenceNode.h.

◆ NumericIndexValueTolerance

double vtkMRMLSequenceNode::NumericIndexValueTolerance {0.001}
protected

Definition at line 195 of file vtkMRMLSequenceNode.h.

◆ SequenceScene

vtkMRMLScene* vtkMRMLSequenceNode::SequenceScene {0}
protected

Need to store the nodes in the scene, because for reading/writing nodes we need MRML storage nodes, which only work if they refer to a data node in the same scene

Definition at line 199 of file vtkMRMLSequenceNode.h.


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