vtkMRMLNode::vtkMRMLNodeReference Class Reference

Class to hold information about a node reference. More...

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

Inheritance diagram for vtkMRMLNode::vtkMRMLNodeReference:

Collaboration diagram for vtkMRMLNode::vtkMRMLNodeReference:

Public Types
typedef vtkObject	Superclass

Public Member Functions
bool	ClearProperties ()
	Remove all properties from the reference.
virtual const char *	GetClassName ()
virtual ContentModifiedObserveType	GetObserveContentModifiedEvents ()
const ReferencePropertiesType *	GetProperties () const
std::string	GetProperty (const std::string &key) const
	Get the properties of the reference.
vtkMRMLNode *	GetReferencedNode () const
virtual char *	GetReferencedNodeID ()
virtual char *	GetReferenceRole ()
vtkMRMLNode *	GetReferencingNode () const
vtkIntArray *	GetStaticEvents () const
virtual int	IsA (const char *type)
void	PrintSelf (ostream &vtkNotUsed(os), vtkIndent vtkNotUsed(indent)) override
bool	RemoveProperty (const std::string &key)
	Remove a property from the reference.
virtual void	SetObserveContentModifiedEvents (ContentModifiedObserveType)
	Controls if ContentModifiedEvents should be observed.
void	SetProperties (const ReferencePropertiesType &properties)
bool	SetProperty (const std::string &key, const std::string &value)
	Set the properties of the reference.
void	SetReferencedNode (vtkMRMLNode *node)
virtual void	SetReferencedNodeID (const char *)
virtual void	SetReferenceRole (const char *)
void	SetReferencingNode (vtkMRMLNode *node)
void	SetStaticEvents (vtkIntArray *events)
	Set the events that will be observed when the referenced node will be available.

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLNodeReference *	New ()
static vtkMRMLNodeReference *	SafeDownCast (vtkObject *o)

Protected Member Functions
void	operator= (const vtkMRMLNodeReference &)
	vtkMRMLNodeReference ()
	vtkMRMLNodeReference (const vtkMRMLNodeReference &)
	~vtkMRMLNodeReference () override

Protected Attributes
ContentModifiedObserveType	ObserveContentModifiedEvents { vtkMRMLNode::ContentModifiedObserveUndefined }
ReferencePropertiesType	Properties
vtkSmartPointer< vtkMRMLNode >	ReferencedNode
	The referenced node that is actually observed now.
char *	ReferencedNodeID
char *	ReferenceRole
	Name of the reference role.
vtkWeakPointer< vtkMRMLNode >	ReferencingNode
	Points to this MRML node (that added the reference)
vtkSmartPointer< vtkIntArray >	StaticEvents
	Events that should be observed.

Detailed Description

Class to hold information about a node reference.

Definition at line 952 of file vtkMRMLNode.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkMRMLNode::vtkMRMLNodeReference::Superclass

Definition at line 955 of file vtkMRMLNode.h.

Constructor & Destructor Documentation

vtkMRMLNodeReference() [1/2]

vtkMRMLNode::vtkMRMLNodeReference::vtkMRMLNodeReference ( )

protected

~vtkMRMLNodeReference()

vtkMRMLNode::vtkMRMLNodeReference::~vtkMRMLNodeReference ( )

overrideprotected

vtkMRMLNodeReference() [2/2]

vtkMRMLNode::vtkMRMLNodeReference::vtkMRMLNodeReference ( const vtkMRMLNodeReference & )

protected

Member Function Documentation

ClearProperties()

bool vtkMRMLNode::vtkMRMLNodeReference::ClearProperties

(

)

Remove all properties from the reference.

GetClassName()

virtual const char * vtkMRMLNode::vtkMRMLNodeReference::GetClassName ( )

virtual

GetObserveContentModifiedEvents()

virtual ContentModifiedObserveType vtkMRMLNode::vtkMRMLNodeReference::GetObserveContentModifiedEvents ( )

virtual

GetProperties()

const ReferencePropertiesType * vtkMRMLNode::vtkMRMLNodeReference::GetProperties ( ) const

inline

Definition at line 996 of file vtkMRMLNode.h.

GetProperty()

std::string vtkMRMLNode::vtkMRMLNodeReference::GetProperty

(

const std::string &

key

)

const

Get the properties of the reference.

GetReferencedNode()

vtkMRMLNode * vtkMRMLNode::vtkMRMLNodeReference::GetReferencedNode

(

)

const

GetReferencedNodeID()

virtual char * vtkMRMLNode::vtkMRMLNodeReference::GetReferencedNodeID ( )

virtual

GetReferenceRole()

virtual char * vtkMRMLNode::vtkMRMLNodeReference::GetReferenceRole ( )

virtual

GetReferencingNode()

vtkMRMLNode * vtkMRMLNode::vtkMRMLNodeReference::GetReferencingNode

(

)

const

GetStaticEvents()

vtkIntArray * vtkMRMLNode::vtkMRMLNodeReference::GetStaticEvents

(

)

const

IsA()

virtual int vtkMRMLNode::vtkMRMLNodeReference::IsA ( const char * type )

virtual

IsTypeOf()

static int vtkMRMLNode::vtkMRMLNodeReference::IsTypeOf ( const char * type )

static

New()

static vtkMRMLNodeReference * vtkMRMLNode::vtkMRMLNodeReference::New ( )

static

operator=()

void vtkMRMLNode::vtkMRMLNodeReference::operator= ( const vtkMRMLNodeReference & )

protected

PrintSelf()

void vtkMRMLNode::vtkMRMLNodeReference::PrintSelf ( ostream & vtkNotUsedos, vtkIndent vtkNotUsedindent )

inlineoverride

Definition at line 957 of file vtkMRMLNode.h.

RemoveProperty()

bool vtkMRMLNode::vtkMRMLNodeReference::RemoveProperty

(

const std::string &

key

)

Remove a property from the reference.

SafeDownCast()

static vtkMRMLNodeReference * vtkMRMLNode::vtkMRMLNodeReference::SafeDownCast ( vtkObject * o )

static

SetObserveContentModifiedEvents()

virtual void vtkMRMLNode::vtkMRMLNodeReference::SetObserveContentModifiedEvents ( ContentModifiedObserveType )

virtual

Controls if ContentModifiedEvents should be observed.

SetProperties()

void vtkMRMLNode::vtkMRMLNodeReference::SetProperties ( const ReferencePropertiesType & properties )

inline

Definition at line 997 of file vtkMRMLNode.h.

SetProperty()

bool vtkMRMLNode::vtkMRMLNodeReference::SetProperty	(	const std::string &	key,
		const std::string &	value )

Set the properties of the reference.

SetReferencedNode()

void vtkMRMLNode::vtkMRMLNodeReference::SetReferencedNode

(

vtkMRMLNode *

node

)

SetReferencedNodeID()

virtual void vtkMRMLNode::vtkMRMLNodeReference::SetReferencedNodeID ( const char * )

virtual

SetReferenceRole()

virtual void vtkMRMLNode::vtkMRMLNodeReference::SetReferenceRole ( const char * )

virtual

SetReferencingNode()

void vtkMRMLNode::vtkMRMLNodeReference::SetReferencingNode

(

vtkMRMLNode *

node

)

SetStaticEvents()

void vtkMRMLNode::vtkMRMLNodeReference::SetStaticEvents

(

vtkIntArray *

events

)

Set the events that will be observed when the referenced node will be available.

If set to nullptr then the default event list (specified for the role) will be observed. If set to an empty event list then no events will be observed.

Member Data Documentation

ObserveContentModifiedEvents

ContentModifiedObserveType vtkMRMLNode::vtkMRMLNodeReference::ObserveContentModifiedEvents { vtkMRMLNode::ContentModifiedObserveUndefined }

protected

Specifies whether ContentModified events of the referenced node should be observed. The undefined state is used to indicate if the value was specified explicitly (necessary to distinguish it from being explicitly disabled for implementation of reference groups).

Definition at line 1022 of file vtkMRMLNode.h.

Properties

ReferencePropertiesType vtkMRMLNode::vtkMRMLNodeReference::Properties

protected

Definition at line 1024 of file vtkMRMLNode.h.

ReferencedNode

vtkSmartPointer<vtkMRMLNode> vtkMRMLNode::vtkMRMLNodeReference::ReferencedNode

protected

The referenced node that is actually observed now.

Definition at line 1012 of file vtkMRMLNode.h.

ReferencedNodeID

char* vtkMRMLNode::vtkMRMLNodeReference::ReferencedNodeID

protected

Referenced node that should be observed (may not be the same as ReferencedNode if the ReferencedNodeID is recently changed)

Definition at line 1016 of file vtkMRMLNode.h.

ReferenceRole

char* vtkMRMLNode::vtkMRMLNodeReference::ReferenceRole

protected

Name of the reference role.

Definition at line 1007 of file vtkMRMLNode.h.

ReferencingNode

vtkWeakPointer<vtkMRMLNode> vtkMRMLNode::vtkMRMLNodeReference::ReferencingNode

protected

Points to this MRML node (that added the reference)

Definition at line 1010 of file vtkMRMLNode.h.

StaticEvents

vtkSmartPointer<vtkIntArray> vtkMRMLNode::vtkMRMLNodeReference::StaticEvents

protected

Events that should be observed.

Definition at line 1018 of file vtkMRMLNode.h.

---

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

• Libs/MRML/Core/vtkMRMLNode.h