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

Inheritance diagram for vtkMRMLTextNode:

Collaboration diagram for vtkMRMLTextNode:

[legend]

Public Types
enum	{ CreateStorageNodeAuto, CreateStorageNodeAlways, CreateStorageNodeNever }

enum	{ TextModifiedEvent = 51000 }

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
vtkMRMLStorageNode *	CreateDefaultStorageNode () override

vtkMRMLNode *	CreateNodeInstance () override
	MRMLNode methods. More...

virtual const char *	GetClassName ()

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

virtual int	GetEncoding ()

std::string	GetEncodingAsString ()

virtual int	GetForceCreateStorageNode ()

const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model) More...

virtual std::string	GetText ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	ReadXMLAttributes (const char **atts) override
	Set node attributes More...

void	SetEncoding (int encoding)

virtual void	SetForceCreateStorageNode (int)

void	SetText (const std::string &text, int encoding=-1)

	vtkMRMLCopyContentMacro (vtkMRMLTextNode)

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 vtkMRMLStorageNode *	CreateDefaultSequenceStorageNode ()

virtual std::string	GetDefaultSequenceStorageNodeClassName ()

virtual bool	GetModifiedSinceRead ()

vtkMRMLStorageNode *	GetNthStorageNode (int n)
	Get associated display MRML node More...

const char *	GetNthStorageNodeID (int n)

int	GetNumberOfStorageNodes ()

const char *	GetSlicerDataType ()

vtkMRMLStorageNode *	GetStorageNode ()

const char *	GetStorageNodeID ()

virtual vtkTagTable *	GetUserTagTable ()
	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	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)

Public Member Functions inherited from vtkMRMLNode
vtkMRMLNode *	AddAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=nullptr)
	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=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 ()

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 ()
	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)

vtkMRMLNode *	SetAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=nullptr)
	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=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...

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)
	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 int	IsTypeOf (const char *type)

static vtkMRMLTextNode *	New ()

static vtkMRMLTextNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLStorableNode
static int	IsTypeOf (const char *type)

static vtkMRMLStorableNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLNode
static int	IsTypeOf (const char *type)

static vtkMRMLNode *	SafeDownCast (vtkObject *o)

Protected Member Functions
void	operator= (const vtkMRMLTextNode &)

	vtkMRMLTextNode ()

	vtkMRMLTextNode (const vtkMRMLTextNode &)

	~vtkMRMLTextNode () 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...

vtkMRMLNode *	UpdateNodeReferenceEventObserver (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
int	Encoding {VTK_ENCODING_US_ASCII}

int	ForceCreateStorageNode {CreateStorageNodeAuto}

std::string	Text

Protected Attributes inherited from vtkMRMLStorableNode
std::string	DefaultSequenceStorageNodeClassName

std::string	SlicerDataType

vtkTimeStamp	StorableModifiedTime

vtkTagTable *	UserTagTable

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...

vtkObserverManager *	MRMLObserverManager

char *	Name {nullptr}

NodeReferenceEventsType	NodeReferenceEvents

std::map< std::string, std::string >	NodeReferenceMRMLAttributeNames

NodeReferencesType	NodeReferences

int	SaveWithScene {true}

vtkWeakPointer< vtkMRMLScene >	Scene

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, NodeReferenceListType >	NodeReferencesType

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

Definition at line 21 of file vtkMRMLTextNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLStorableNode vtkMRMLTextNode::Superclass

Definition at line 26 of file vtkMRMLTextNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
CreateStorageNodeAuto
CreateStorageNodeAlways
CreateStorageNodeNever

Definition at line 29 of file vtkMRMLTextNode.h.

◆ anonymous enum

anonymous enum

Enumerator
TextModifiedEvent

Definition at line 86 of file vtkMRMLTextNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLTextNode() [1/2]

vtkMRMLTextNode::vtkMRMLTextNode ( )

protected

◆ ~vtkMRMLTextNode()

vtkMRMLTextNode::~vtkMRMLTextNode ( )

overrideprotected

◆ vtkMRMLTextNode() [2/2]

vtkMRMLTextNode::vtkMRMLTextNode ( const vtkMRMLTextNode & )

protected

Member Function Documentation

◆ CreateDefaultStorageNode()

vtkMRMLStorageNode* vtkMRMLTextNode::CreateDefaultStorageNode ( )

overridevirtual

Create a storage node for this node type. If it returns nullptr then it means the node can be stored in the scene (in XML), without using a storage node.

Reimplemented from vtkMRMLStorableNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLTextNode::CreateNodeInstance ( )

overridevirtual

MRMLNode methods.

Implements vtkMRMLStorableNode.

◆ GetClassName()

virtual const char* vtkMRMLTextNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLStorableNode.

◆ GetDefaultStorageNodeClassName()

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

overridevirtual

Determines the most appropriate storage node class for the provided file name and node content.

Reimplemented from vtkMRMLStorableNode.

◆ GetEncoding()

virtual int vtkMRMLTextNode::GetEncoding ( )

virtual

◆ GetEncodingAsString()

std::string vtkMRMLTextNode::GetEncodingAsString ( )

◆ GetForceCreateStorageNode()

virtual int vtkMRMLTextNode::GetForceCreateStorageNode ( )

virtual

◆ GetNodeTagName()

const char* vtkMRMLTextNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLStorableNode.

Definition at line 52 of file vtkMRMLTextNode.h.

◆ GetText()

virtual std::string vtkMRMLTextNode::GetText ( )

virtual

◆ IsA()

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

virtual

Reimplemented from vtkMRMLStorableNode.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLTextNode* vtkMRMLTextNode::New ( )

static

◆ operator=()

void vtkMRMLTextNode::operator= ( const vtkMRMLTextNode & )

protected

◆ PrintSelf()

void vtkMRMLTextNode::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

override

◆ ReadXMLAttributes()

void vtkMRMLTextNode::ReadXMLAttributes ( const char ** atts )

overridevirtual

Set node attributes

Reimplemented from vtkMRMLStorableNode.

◆ SafeDownCast()

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

static

◆ SetEncoding()

void vtkMRMLTextNode::SetEncoding ( int encoding )

Set encoding of the text For character encoding, please refer IANA Character Sets (https://www.iana.org/assignments/character-sets/character-sets.xhtml) Default is VTK_ENCODING_US_ASCII

◆ SetForceCreateStorageNode()

virtual void vtkMRMLTextNode::SetForceCreateStorageNode ( int )

virtual

Force the use of a storage node, regardless of text length. By default, a storage node will only be used for nodes that have been read from file (drag and drop), or for nodes that have text longer than 250 characters. This option should be also be enabled for nodes with highly structured text (such as XML) that would not be good to have in the MRML.

◆ SetText()

void vtkMRMLTextNode::SetText	(	const std::string &	text,
		int	encoding = `-1`
	)

Set text node contents and encoding. If the encoding is not specified, then it will not be changed from the current value.

See also: SetEncoding()

◆ vtkMRMLCopyContentMacro()

vtkMRMLTextNode::vtkMRMLCopyContentMacro ( vtkMRMLTextNode )

Copy node content (excludes basic data, such as name and node references).

See also: vtkMRMLNode::CopyContent

◆ WriteXML()

void vtkMRMLTextNode::WriteXML	(	ostream &	of,
		int	indent
	)

overridevirtual

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

Reimplemented from vtkMRMLStorableNode.

Member Data Documentation

◆ Encoding

int vtkMRMLTextNode::Encoding {VTK_ENCODING_US_ASCII}

protected

Definition at line 99 of file vtkMRMLTextNode.h.

◆ ForceCreateStorageNode

int vtkMRMLTextNode::ForceCreateStorageNode {CreateStorageNodeAuto}

protected

Definition at line 100 of file vtkMRMLTextNode.h.

◆ Text

std::string vtkMRMLTextNode::Text

protected

Definition at line 98 of file vtkMRMLTextNode.h.

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

Libs/MRML/Core/vtkMRMLTextNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkMRMLTextNode() [1/2]

◆ ~vtkMRMLTextNode()

◆ vtkMRMLTextNode() [2/2]

Member Function Documentation

◆ CreateDefaultStorageNode()

◆ CreateNodeInstance()

◆ GetClassName()

◆ GetDefaultStorageNodeClassName()

◆ GetEncoding()

◆ GetEncodingAsString()

◆ GetForceCreateStorageNode()

◆ GetNodeTagName()

◆ GetText()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ ReadXMLAttributes()

◆ SafeDownCast()

◆ SetEncoding()

◆ SetForceCreateStorageNode()

◆ SetText()

◆ vtkMRMLCopyContentMacro()

◆ WriteXML()

Member Data Documentation

◆ Encoding

◆ ForceCreateStorageNode

◆ Text