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

Inheritance diagram for vtkMRMLScriptedModuleNode:

Collaboration diagram for vtkMRMLScriptedModuleNode:

Public Types
typedef vtkMRMLNode	Superclass

Public Types inherited from vtkMRMLNode
enum	{ HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent, ReferenceRemovedEvent, ReferencedNodeModifiedEvent }

typedef vtkObject	Superclass

Public Member Functions
vtkMRMLNode *	CreateNodeInstance () override
	Create instance of the default node. Like New only virtual. More...

virtual const char *	GetClassName ()

virtual char *	GetModuleName ()

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

std::string	GetParameter (const std::string &name) const
	Get module parameter identified by name. More...

int	GetParameterCount ()
	Get number of parameters. More...

std::vector< std::string >	GetParameterNames ()
	Get list of parameter names. More...

std::string	GetParameterNamesAsCommaSeparatedList ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

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

virtual void	SetModuleName (const char *)

void	SetParameter (const std::string &name, const std::string &value)
	Set module parameter. More...

void	UnsetAllParameters ()

void	UnsetParameter (const std::string &name)
	Unset the parameter identified by name. More...

	vtkMRMLCopyContentMacro (vtkMRMLScriptedModuleNode)

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
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	Copy (vtkMRMLNode *node)
	Copy node contents from another node of the same type. Does not copy node ID and Scene. Performs deep copy - an independent copy is created from all data, including bulk data. More...

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

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

virtual void	UpdateScene (vtkMRMLScene *)

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 vtkMRMLScriptedModuleNode *	New ()

static vtkMRMLScriptedModuleNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLNode *	SafeDownCast (vtkObject *o)

Protected Types
typedef std::map< std::string, std::string >	ParameterMap

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

Protected Member Functions
void	operator= (const vtkMRMLScriptedModuleNode &)

	vtkMRMLScriptedModuleNode ()

	vtkMRMLScriptedModuleNode (const vtkMRMLScriptedModuleNode &)

	~vtkMRMLScriptedModuleNode () 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
char *	ModuleName

ParameterMap	Parameters

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
Static Protected Member Functions inherited from vtkMRMLNode
static void	MRMLCallback (vtkObject caller, unsigned long eid, void clientData, void *callData)

Detailed Description

The scripted module node is simply a MRMLNode container for an arbitrary keyword value pair map

Definition at line 27 of file vtkMRMLScriptedModuleNode.h.

Member Typedef Documentation

◆ ParameterMap

typedef std::map<std::string, std::string> vtkMRMLScriptedModuleNode::ParameterMap

protected

Definition at line 84 of file vtkMRMLScriptedModuleNode.h.

◆ Superclass

typedef vtkMRMLNode vtkMRMLScriptedModuleNode::Superclass

Definition at line 31 of file vtkMRMLScriptedModuleNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLScriptedModuleNode() [1/2]

vtkMRMLScriptedModuleNode::vtkMRMLScriptedModuleNode ( )

protected

◆ ~vtkMRMLScriptedModuleNode()

vtkMRMLScriptedModuleNode::~vtkMRMLScriptedModuleNode ( )

overrideprotected

◆ vtkMRMLScriptedModuleNode() [2/2]

vtkMRMLScriptedModuleNode::vtkMRMLScriptedModuleNode ( const vtkMRMLScriptedModuleNode & )

protected

Member Function Documentation

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLScriptedModuleNode::CreateNodeInstance ( )

overridevirtual

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

Note: Subclasses should implement this method

Implements vtkMRMLNode.

◆ GetClassName()

virtual const char* vtkMRMLScriptedModuleNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLNode.

◆ GetModuleName()

virtual char* vtkMRMLScriptedModuleNode::GetModuleName ( )

virtual

The name of the Module - this is used to customize the node selectors and other things

◆ GetNodeTagName()

const char* vtkMRMLScriptedModuleNode::GetNodeTagName ( )

overridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

◆ GetParameter()

std::string vtkMRMLScriptedModuleNode::GetParameter ( const std::string & name ) const

Get module parameter identified by name.

◆ GetParameterCount()

int vtkMRMLScriptedModuleNode::GetParameterCount ( )

Get number of parameters.

◆ GetParameterNames()

std::vector<std::string> vtkMRMLScriptedModuleNode::GetParameterNames ( )

Get list of parameter names.

◆ GetParameterNamesAsCommaSeparatedList()

std::string vtkMRMLScriptedModuleNode::GetParameterNamesAsCommaSeparatedList ( )

Get list of parameter names separated by a comma

See also: GetParameterNames

◆ IsA()

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

virtual

Reimplemented from vtkMRMLNode.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLScriptedModuleNode* vtkMRMLScriptedModuleNode::New ( )

static

◆ operator=()

void vtkMRMLScriptedModuleNode::operator= ( const vtkMRMLScriptedModuleNode & )

protected

◆ PrintSelf()

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

override

◆ ReadXMLAttributes()

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

overridevirtual

Set node attributes.

Reimplemented from vtkMRMLNode.

◆ SafeDownCast()

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

static

◆ SetModuleName()

virtual void vtkMRMLScriptedModuleNode::SetModuleName ( const char * )

virtual

◆ SetParameter()

void vtkMRMLScriptedModuleNode::SetParameter	(	const std::string &	name,
		const std::string &	value
	)

Set module parameter.

◆ UnsetAllParameters()

void vtkMRMLScriptedModuleNode::UnsetAllParameters ( )

Unset all parameters

See also: UnsetParameter

◆ UnsetParameter()

void vtkMRMLScriptedModuleNode::UnsetParameter ( const std::string & name )

Unset the parameter identified by name.

◆ vtkMRMLCopyContentMacro()

vtkMRMLScriptedModuleNode::vtkMRMLCopyContentMacro ( vtkMRMLScriptedModuleNode )

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

See also: vtkMRMLNode::CopyContent

◆ WriteXML()

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

overridevirtual

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

Reimplemented from vtkMRMLNode.

Member Data Documentation

◆ ModuleName

char* vtkMRMLScriptedModuleNode::ModuleName

protected

Definition at line 86 of file vtkMRMLScriptedModuleNode.h.

◆ Parameters

ParameterMap vtkMRMLScriptedModuleNode::Parameters

protected

Definition at line 85 of file vtkMRMLScriptedModuleNode.h.

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

Libs/MRML/Core/vtkMRMLScriptedModuleNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ParameterMap

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMRMLScriptedModuleNode() [1/2]

◆ ~vtkMRMLScriptedModuleNode()

◆ vtkMRMLScriptedModuleNode() [2/2]

Member Function Documentation

◆ CreateNodeInstance()

◆ GetClassName()

◆ GetModuleName()

◆ GetNodeTagName()

◆ GetParameter()

◆ GetParameterCount()

◆ GetParameterNames()

◆ GetParameterNamesAsCommaSeparatedList()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ ReadXMLAttributes()

◆ SafeDownCast()

◆ SetModuleName()

◆ SetParameter()

◆ UnsetAllParameters()

◆ UnsetParameter()

◆ vtkMRMLCopyContentMacro()

◆ WriteXML()

Member Data Documentation

◆ ModuleName

◆ Parameters