Slicer  4.11
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
vtkMRMLTableNode Class Reference

MRML node to represent a table object. More...

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

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

Public Types

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

vtkAbstractArray * AddColumn (vtkAbstractArray *column=nullptr)
 
int AddEmptyRow ()
 
void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object More...
 
void CopyAllColumnProperties (const std::string &sourceColumnName, const std::string &targetColumnName)
 
Copy all properties from one column to another. More...
 
vtkMRMLStorageNodeCreateDefaultStorageNode () override
 
Create default storage node or nullptr if does not have one More...
 
vtkMRMLNodeCreateNodeInstance () override
 Standard methods for MRML nodes. More...
 
void GetAllColumnPropertyNames (vtkStringArray *propertyNames)
 
std::string GetCellText (int rowIndex, int columnIndex)
 
virtual const char * GetClassName ()
 
std::string GetColumnDescription (const std::string &columnName)
 
int GetColumnIndex (const char *columnName)
 
int GetColumnIndex (const std::string &columnName)
 
int GetColumnIndex (vtkAbstractArray *column)
 
std::string GetColumnLongName (const std::string &columnName)
 
std::string GetColumnName (int columnIndex)
 
std::string GetColumnNullValue (const std::string &columnName)
 
std::string GetColumnProperty (const std::string &columnName, const std::string &propertyName)
 
std::string GetColumnProperty (int columnIndex, const std::string &propertyName)
 
int GetColumnType (const std::string &columnName)
 
std::string GetColumnUnitLabel (const std::string &columnName)
 
int GetColumnValueTypeFromSchema (const std::string &columnName)
 
virtual bool GetLocked ()
 
Table contents cannot be edited through the user interface More...
 
const char * GetNodeTagName () override
 
Get node XML tag name (like Volume, Model) More...
 
int GetNumberOfColumns ()
 
Convenience method for getting number of columns in the table. More...
 
int GetNumberOfRows ()
 
Convenience method for getting number of rows in the table. More...
 
virtual vtkTable * GetSchema ()
 
virtual vtkTable * GetTable ()
 
virtual bool GetUseColumnNameAsColumnHeader ()
 
Column name should be treated as column label More...
 
virtual bool GetUseFirstColumnAsRowHeader ()
 First column should be treated as row label. More...
 
vtkIdType InsertNextBlankRowWithNullValues (vtkTable *table)
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
 
Method to propagate events generated in mrml More...
 
void ReadXMLAttributes (const char **atts) override
 
Set node attributes More...
 
void RemoveAllColumnProperties (const std::string &columnName)
 
void RemoveAllColumnProperties (int columnIndex)
 
bool RemoveAllColumns ()
 
bool RemoveColumn (int columnIndex)
 
void RemoveColumnProperty (const std::string &propertyName)
 
bool RemoveRow (int rowIndex)
 
bool RenameColumn (int columnIndex, const char *newName)
 
virtual void SetAndObserveSchema (vtkTable *schema)
 
virtual void SetAndObserveTable (vtkTable *table)
 Get and Set Macros. More...
 
bool SetCellText (int rowIndex, int columnIndex, const char *text)
 
void SetColumnDescription (const std::string &columnName, const std::string &description)
 
Set human-readable description of a column. More...
 
void SetColumnLongName (const std::string &columnName, const std::string &description)
 
void SetColumnNullValue (const std::string &columnName, const std::string &nullValue)
 
Set null value for blank rows and missing values. More...
 
void SetColumnProperty (const std::string &columnName, const std::string &propertyName, const std::string &propertyValue)
 
void SetColumnProperty (int columnIndex, const std::string &propertyName, const std::string &propertyValue)
 
bool SetColumnType (const std::string &columnName, int typeId)
 
void SetColumnUnitLabel (const std::string &columnName, const std::string &unitLabel)
 
Set measurement unit for the data stored in the selected column. More...
 
bool SetDefaultColumnType (const std::string &type, const std::string &nullValue="")
 
virtual void SetLocked (bool)
 
virtual void SetUseColumnNameAsColumnHeader (bool)
 
virtual void SetUseFirstColumnAsRowHeader (bool)
 
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)
 
virtual std::string GetDefaultStorageNodeClassName (const char *filename=nullptr)
 
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 SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)
 
void SetAndObserveStorageNodeID (const char *storageNodeID)
 
String ID of the storage MRML node More...
 
void SetSlicerDataType (const char *type)
 
virtual void StorableModified ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data 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 CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithoutModifiedEvent (vtkMRMLNode *node)
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSingleModifiedEvent (vtkMRMLNode *node)
 
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 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 bool GetUndoEnabled ()
 
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 const char * GetDefaultColumnName ()
 Name of the column that stores default properties that are used when a new column is created. More...
 
static std::string GetValueTypeAsString (int valueType)
 Get value type id from string (uses vtkImageScalarTypeNameMacro) More...
 
static int GetValueTypeFromString (std::string valueTypeStr)
 Get value type id from string (inverse of vtkImageScalarTypeNameMacro) More...
 
static int IsTypeOf (const char *type)
 
static vtkMRMLTableNodeNew ()
 Data types supported by the table. Used in qMRMLTableModel for visualization. More...
 
static vtkMRMLTableNodeSafeDownCast (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

std::string GetColumnPropertyInternal (const std::string &columnName, const std::string &propertyName)
 Get column property, even for reserved properties. More...
 
vtkIdType GetPropertyRowIndex (const std::string &columnName)
 
void operator= (const vtkMRMLTableNode &)
 
void SetColumnPropertyInternal (const std::string &columnName, const std::string &propertyName, const std::string &propertyValue)
 Set column property, even for reserved properties. More...
 
 vtkMRMLTableNode ()
 Constructor and destructor. More...
 
 vtkMRMLTableNode (const vtkMRMLTableNode &)
 
 ~vtkMRMLTableNode () 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::map< std::string, std::string > &references)
 
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

bool Locked
 
vtkTable * Schema
 
vtkTable * Table
 Data. More...
 
bool UseColumnNameAsColumnHeader
 
bool UseFirstColumnAsRowHeader
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene
 
AttributesType Attributes
 
char * Description
 
int HideFromEditors
 
char * ID
 
int InMRMLCallbackFlag
 
Flag to avoid event loops More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable
 
int Selected
 
bool UndoEnabled
 

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 to represent a table object.

This class can store a spreadsheet. Data is stored as a vtkTable object. A few convenience methods are provided for manipulating rows, columns, and cells. For performance-critical use cases it is recommended to manipulate the vtkTable object directly. If the vtkTable object content is modified then Modified() method has to be called on the vtkTable object when modifications are completed.

Definition at line 44 of file vtkMRMLTableNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 51 of file vtkMRMLTableNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLTableNode() [1/2]

vtkMRMLTableNode::vtkMRMLTableNode ( )
protected

Constructor and destructor.

◆ ~vtkMRMLTableNode()

vtkMRMLTableNode::~vtkMRMLTableNode ( )
overrideprotected

◆ vtkMRMLTableNode() [2/2]

vtkMRMLTableNode::vtkMRMLTableNode ( const vtkMRMLTableNode )
protected

Member Function Documentation

◆ AddColumn()

vtkAbstractArray* vtkMRMLTableNode::AddColumn ( vtkAbstractArray *  column = nullptr)

Add an array to the table as a new column. If no column is provided then an empty column is added. If a column is provided then the number of rows in the table and tuples in the provided array will be matched by either adding empty rows to the table or empty elements to the array. If a column is provided that does not have a name then a name will be generated automatically that is unique among all table column names.

◆ AddEmptyRow()

int vtkMRMLTableNode::AddEmptyRow ( )

Add an empty row at the end of the table Returns the index of the inserted row or -1 on failure.

◆ Copy()

void vtkMRMLTableNode::Copy ( vtkMRMLNode node)
overridevirtual


Copy the node's attributes to this object

Reimplemented from vtkMRMLStorableNode.

◆ CopyAllColumnProperties()

void vtkMRMLTableNode::CopyAllColumnProperties ( const std::string &  sourceColumnName,
const std::string &  targetColumnName 
)


Copy all properties from one column to another.

◆ CreateDefaultStorageNode()

vtkMRMLStorageNode* vtkMRMLTableNode::CreateDefaultStorageNode ( )
overridevirtual


Create default storage node or nullptr if does not have one

Reimplemented from vtkMRMLStorableNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLTableNode::CreateNodeInstance ( )
overridevirtual

Standard methods for MRML nodes.

Implements vtkMRMLStorableNode.

◆ GetAllColumnPropertyNames()

void vtkMRMLTableNode::GetAllColumnPropertyNames ( vtkStringArray *  propertyNames)

Get list of all column property names.

See also
SetAndObserveSchema

◆ GetCellText()

std::string vtkMRMLTableNode::GetCellText ( int  rowIndex,
int  columnIndex 
)

Convenience method for getting a single value in the table. Returns empty string if failed to get value. Returns the value on success.

◆ GetClassName()

virtual const char* vtkMRMLTableNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLStorableNode.

◆ GetColumnDescription()

std::string vtkMRMLTableNode::GetColumnDescription ( const std::string &  columnName)

◆ GetColumnIndex() [1/3]

int vtkMRMLTableNode::GetColumnIndex ( const char *  columnName)

Get column index of the first column by the specified name. Returns -1 if no such column is found.

◆ GetColumnIndex() [2/3]

int vtkMRMLTableNode::GetColumnIndex ( const std::string &  columnName)

◆ GetColumnIndex() [3/3]

int vtkMRMLTableNode::GetColumnIndex ( vtkAbstractArray *  column)

Get column index from column pointer. Returns -1 if column is not found.

◆ GetColumnLongName()

std::string vtkMRMLTableNode::GetColumnLongName ( const std::string &  columnName)

◆ GetColumnName()

std::string vtkMRMLTableNode::GetColumnName ( int  columnIndex)

Get column name from column index. Returns empty string if column is not found.

◆ GetColumnNullValue()

std::string vtkMRMLTableNode::GetColumnNullValue ( const std::string &  columnName)

◆ GetColumnProperty() [1/2]

std::string vtkMRMLTableNode::GetColumnProperty ( const std::string &  columnName,
const std::string &  propertyName 
)

Get a column property. Property name "columnName" is reserved for internal use.

See also
SetAndObserveSchema, GetColumnValueTypeFromSchema

◆ GetColumnProperty() [2/2]

std::string vtkMRMLTableNode::GetColumnProperty ( int  columnIndex,
const std::string &  propertyName 
)

◆ GetColumnPropertyInternal()

std::string vtkMRMLTableNode::GetColumnPropertyInternal ( const std::string &  columnName,
const std::string &  propertyName 
)
protected

Get column property, even for reserved properties.

◆ GetColumnType()

int vtkMRMLTableNode::GetColumnType ( const std::string &  columnName)

Get data type of a column.

Returns
column type ID

◆ GetColumnUnitLabel()

std::string vtkMRMLTableNode::GetColumnUnitLabel ( const std::string &  columnName)

◆ GetColumnValueTypeFromSchema()

int vtkMRMLTableNode::GetColumnValueTypeFromSchema ( const std::string &  columnName)

Get column type stored in the schema as VTK type ID. It should only be used during reading/writing of the node, because once the table column is created, the actual column type is the type of the associated VTK data array.

◆ GetDefaultColumnName()

static const char* vtkMRMLTableNode::GetDefaultColumnName ( )
static

Name of the column that stores default properties that are used when a new column is created.

◆ GetLocked()

virtual bool vtkMRMLTableNode::GetLocked ( )
virtual


Table contents cannot be edited through the user interface

◆ GetNodeTagName()

const char* vtkMRMLTableNode::GetNodeTagName ( )
inlineoverridevirtual


Get node XML tag name (like Volume, Model)

Implements vtkMRMLStorableNode.

Definition at line 75 of file vtkMRMLTableNode.h.

◆ GetNumberOfColumns()

int vtkMRMLTableNode::GetNumberOfColumns ( )


Convenience method for getting number of columns in the table.

◆ GetNumberOfRows()

int vtkMRMLTableNode::GetNumberOfRows ( )


Convenience method for getting number of rows in the table.

◆ GetPropertyRowIndex()

vtkIdType vtkMRMLTableNode::GetPropertyRowIndex ( const std::string &  columnName)
protected

◆ GetSchema()

virtual vtkTable* vtkMRMLTableNode::GetSchema ( )
virtual

◆ GetTable()

virtual vtkTable* vtkMRMLTableNode::GetTable ( )
virtual

◆ GetUseColumnNameAsColumnHeader()

virtual bool vtkMRMLTableNode::GetUseColumnNameAsColumnHeader ( )
virtual


Column name should be treated as column label

◆ GetUseFirstColumnAsRowHeader()

virtual bool vtkMRMLTableNode::GetUseFirstColumnAsRowHeader ( )
virtual

First column should be treated as row label.

◆ GetValueTypeAsString()

static std::string vtkMRMLTableNode::GetValueTypeAsString ( int  valueType)
static

Get value type id from string (uses vtkImageScalarTypeNameMacro)

◆ GetValueTypeFromString()

static int vtkMRMLTableNode::GetValueTypeFromString ( std::string  valueTypeStr)
static

Get value type id from string (inverse of vtkImageScalarTypeNameMacro)

◆ InsertNextBlankRowWithNullValues()

vtkIdType vtkMRMLTableNode::InsertNextBlankRowWithNullValues ( vtkTable *  table)

Insert next blank row into the table, using null values defined in the schema.

Returns
row index of the inserted row

◆ IsA()

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

Reimplemented from vtkMRMLStorableNode.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLTableNode* vtkMRMLTableNode::New ( )
static

Data types supported by the table. Used in qMRMLTableModel for visualization.

◆ operator=()

void vtkMRMLTableNode::operator= ( const vtkMRMLTableNode )
protected

◆ PrintSelf()

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

◆ ProcessMRMLEvents()

void vtkMRMLTableNode::ProcessMRMLEvents ( vtkObject *  caller,
unsigned long  event,
void *  callData 
)
overridevirtual


Method to propagate events generated in mrml

Reimplemented from vtkMRMLStorableNode.

◆ ReadXMLAttributes()

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


Set node attributes

Reimplemented from vtkMRMLStorableNode.

◆ RemoveAllColumnProperties() [1/2]

void vtkMRMLTableNode::RemoveAllColumnProperties ( const std::string &  columnName)

Remove all properties defined for the specified column. To remove all properties for all columns, use SetAndObserveScheme(nullptr).

◆ RemoveAllColumnProperties() [2/2]

void vtkMRMLTableNode::RemoveAllColumnProperties ( int  columnIndex)

◆ RemoveAllColumns()

bool vtkMRMLTableNode::RemoveAllColumns ( )

Remove all columns from the table (including associated properties). Returns with true on success.

◆ RemoveColumn()

bool vtkMRMLTableNode::RemoveColumn ( int  columnIndex)

Remove array from the table (including associated properties). Returns with true on success.

◆ RemoveColumnProperty()

void vtkMRMLTableNode::RemoveColumnProperty ( const std::string &  propertyName)

Set a column property value. Property names reserved for internal use: columnName, type.

See also
SetAndObserveSchema()

◆ RemoveRow()

bool vtkMRMLTableNode::RemoveRow ( int  rowIndex)

Remove row from the table Returns with true on success.

◆ RenameColumn()

bool vtkMRMLTableNode::RenameColumn ( int  columnIndex,
const char *  newName 
)

Rename an array in the table (including associated properties). If a column by that name already exists then column properties of the existing column will be overwritten with the renamed column's properties. Returns with true on success.

◆ SafeDownCast()

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

◆ SetAndObserveSchema()

virtual void vtkMRMLTableNode::SetAndObserveSchema ( vtkTable *  schema)
virtual

Set schema table

Each row of the schema table contains description of a data table column. Columns of the schema table:

  • columnName: name of the data table column that properties are defined for (required) Column name <default> is reserved for defining default properties for new columns.
  • type: data type of the column. Supported types: string, double, float, int, unsigned int, bit, short, unsigned short, long, unsigned long, char, signed char, unsigned char, long long, unsigned long long __int64, unsigned __int64, idtype. Default: string.
  • nullValue: value to be used when a value is not specified (new table row is added, blank string is entered, etc)
  • longName: full human-readable name of the column
  • description: human-readable detailed description of the column
  • unitLabel: simple unit label
  • unitCodeMeaning: standard unit definition. Example: Standardized Uptake Value body weight.
  • unitCodeValue: standard unit definition. Example: {SUVbw}g/ml.
  • unitCodingSchemeDesignator: standard unit definition. Example: UCUM.

◆ SetAndObserveTable()

virtual void vtkMRMLTableNode::SetAndObserveTable ( vtkTable *  table)
virtual

Get and Set Macros.

◆ SetCellText()

bool vtkMRMLTableNode::SetCellText ( int  rowIndex,
int  columnIndex,
const char *  text 
)

Convenience method for setting a single value in the table. Returns true if the setting was successful. This updates the node immediately, therefore it is not efficient when a large number of values has to be modified. For bulk operations get the vtkTable object using GetTable() method and manipulate that directly.

◆ SetColumnDescription()

void vtkMRMLTableNode::SetColumnDescription ( const std::string &  columnName,
const std::string &  description 
)


Set human-readable description of a column.

◆ SetColumnLongName()

void vtkMRMLTableNode::SetColumnLongName ( const std::string &  columnName,
const std::string &  description 
)

Set a full human-readable name of a column. When there is no space constraings, the full name of the column may` displayed instead/in addition to columnName to identify a column.

◆ SetColumnNullValue()

void vtkMRMLTableNode::SetColumnNullValue ( const std::string &  columnName,
const std::string &  nullValue 
)


Set null value for blank rows and missing values.

◆ SetColumnProperty() [1/2]

void vtkMRMLTableNode::SetColumnProperty ( const std::string &  columnName,
const std::string &  propertyName,
const std::string &  propertyValue 
)

Set a column property value. Property name "columnName" is reserved for internal use. Property name "type" converts existing values in the column.

See also
SetAndObserveSchema

◆ SetColumnProperty() [2/2]

void vtkMRMLTableNode::SetColumnProperty ( int  columnIndex,
const std::string &  propertyName,
const std::string &  propertyValue 
)

◆ SetColumnPropertyInternal()

void vtkMRMLTableNode::SetColumnPropertyInternal ( const std::string &  columnName,
const std::string &  propertyName,
const std::string &  propertyValue 
)
protected

Set column property, even for reserved properties.

◆ SetColumnType()

bool vtkMRMLTableNode::SetColumnType ( const std::string &  columnName,
int  typeId 
)

Change data type of a column. If values are stored in the column then values will be converted, therefore data loss may occur.

Parameters
typenew column value type ID
Returns
True on success.

◆ SetColumnUnitLabel()

void vtkMRMLTableNode::SetColumnUnitLabel ( const std::string &  columnName,
const std::string &  unitLabel 
)


Set measurement unit for the data stored in the selected column.

◆ SetDefaultColumnType()

bool vtkMRMLTableNode::SetDefaultColumnType ( const std::string &  type,
const std::string &  nullValue = "" 
)

Set default type and null value for new columns. This is a convenience method to set column type with a simple call. To get or set other default properties, call SetColumnProperty() or GetColumnProperty() using the column name returned by GetDefaultColumnName().

Parameters
typetype of values stored in new columns by default (string, double, ...)
nullValuethis value is used when a new row is added to the column
Returns
True on success.
See also
SetAndObserveSchema

◆ SetLocked()

virtual void vtkMRMLTableNode::SetLocked ( bool  )
virtual

◆ SetUseColumnNameAsColumnHeader()

virtual void vtkMRMLTableNode::SetUseColumnNameAsColumnHeader ( bool  )
virtual

◆ SetUseFirstColumnAsRowHeader()

virtual void vtkMRMLTableNode::SetUseFirstColumnAsRowHeader ( bool  )
virtual

◆ WriteXML()

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


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

Reimplemented from vtkMRMLStorableNode.

Member Data Documentation

◆ Locked

bool vtkMRMLTableNode::Locked
protected

Definition at line 318 of file vtkMRMLTableNode.h.

◆ Schema

vtkTable* vtkMRMLTableNode::Schema
protected

Definition at line 322 of file vtkMRMLTableNode.h.

◆ Table

vtkTable* vtkMRMLTableNode::Table
protected

Data.

Definition at line 317 of file vtkMRMLTableNode.h.

◆ UseColumnNameAsColumnHeader

bool vtkMRMLTableNode::UseColumnNameAsColumnHeader
protected

Definition at line 319 of file vtkMRMLTableNode.h.

◆ UseFirstColumnAsRowHeader

bool vtkMRMLTableNode::UseFirstColumnAsRowHeader
protected

Definition at line 320 of file vtkMRMLTableNode.h.


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