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

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

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

Inheritance diagram for vtkMRMLNode::vtkMRMLNodeReference:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLNode::vtkMRMLNodeReference:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
vtkIntArray * GetEvents () const
 
vtkMRMLNodeGetReferencedNode () const
 
virtual char * GetReferencedNodeID ()
 
virtual char * GetReferenceRole ()
 
vtkMRMLNodeGetReferencingNode () const
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &vtkNotUsed(os), vtkIndent vtkNotUsed(indent)) override
 
void SetEvents (vtkIntArray *events)
 Set the events that will be observed when the referenced node will be available. More...
 
void SetReferencedNode (vtkMRMLNode *node)
 
virtual void SetReferencedNodeID (const char *)
 
virtual void SetReferenceRole (const char *)
 
void SetReferencingNode (vtkMRMLNode *node)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLNodeReferenceNew ()
 
static vtkMRMLNodeReferenceSafeDownCast (vtkObject *o)
 

Protected Member Functions

void operator= (const vtkMRMLNodeReference &)
 
 vtkMRMLNodeReference ()
 
 vtkMRMLNodeReference (const vtkMRMLNodeReference &)
 
 ~vtkMRMLNodeReference () override
 

Protected Attributes

vtkSmartPointer< vtkIntArray > Events
 
vtkSmartPointer< vtkMRMLNodeReferencedNode
 The referenced node that is actually observed now. More...
 
char * ReferencedNodeID
 
char * ReferenceRole
 Name of the reference role. More...
 
vtkWeakPointer< vtkMRMLNodeReferencingNode
 Points to this MRML node (that added the reference) More...
 

Detailed Description

Class to hold information about a node reference.

Definition at line 801 of file vtkMRMLNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 804 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

◆ GetClassName()

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

◆ GetEvents()

vtkIntArray* vtkMRMLNode::vtkMRMLNodeReference::GetEvents ( ) const

◆ 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

◆ 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 806 of file vtkMRMLNode.h.

◆ SafeDownCast()

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

◆ SetEvents()

void vtkMRMLNode::vtkMRMLNodeReference::SetEvents ( 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.

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

Member Data Documentation

◆ Events

vtkSmartPointer<vtkIntArray> vtkMRMLNode::vtkMRMLNodeReference::Events
protected

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

Definition at line 849 of file vtkMRMLNode.h.

◆ ReferencedNode

vtkSmartPointer<vtkMRMLNode> vtkMRMLNode::vtkMRMLNodeReference::ReferencedNode
protected

The referenced node that is actually observed now.

Definition at line 842 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 846 of file vtkMRMLNode.h.

◆ ReferenceRole

char* vtkMRMLNode::vtkMRMLNodeReference::ReferenceRole
protected

Name of the reference role.

Definition at line 837 of file vtkMRMLNode.h.

◆ ReferencingNode

vtkWeakPointer<vtkMRMLNode> vtkMRMLNode::vtkMRMLNodeReference::ReferencingNode
protected

Points to this MRML node (that added the reference)

Definition at line 840 of file vtkMRMLNode.h.


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