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
vtkMRMLAnnotationRulerStorageNode Class Reference

#include <Modules/Loadable/Annotations/MRML/vtkMRMLAnnotationRulerStorageNode.h>

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

Public Types

typedef vtkMRMLAnnotationLinesStorageNode Superclass
 
- Public Types inherited from vtkMRMLAnnotationLinesStorageNode
typedef vtkMRMLAnnotationControlPointsStorageNode Superclass
 
- Public Types inherited from vtkMRMLAnnotationControlPointsStorageNode
typedef vtkMRMLAnnotationStorageNode Superclass
 
- Public Types inherited from vtkMRMLAnnotationStorageNode
typedef vtkMRMLStorageNode Superclass
 
- Public Types inherited from vtkMRMLStorageNode
enum  {
  Idle, Pending, Scheduled, Transferring,
  TransferDone, Cancelled, SkippedNoData
}
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

bool CanReadInReferenceNode (vtkMRMLNode *refNode) override
 Return true if the node can be read in. More...
 
void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object More...
 
vtkMRMLNodeCreateNodeInstance () override
 Create instance of the default node. Like New only virtual. More...
 
virtual const char * GetClassName ()
 
const char * GetNodeTagName () override
 
Get node XML tag name (like Storage, Model) More...
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
int ReadOneRuler (fstream &fstr, vtkMRMLAnnotationRulerNode *refNode)
 
void ReadXMLAttributes (const char **atts) override
 
Read node attributes from XML file More...
 
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 vtkMRMLAnnotationLinesStorageNode
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkMRMLAnnotationControlPointsStorageNode
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkMRMLAnnotationStorageNode
bool CanReadInReferenceNode (vtkMRMLNode *refNode) override
 Return true if the node can be read in. More...
 
vtkMRMLNodeCreateNodeInstance () override
 Create instance of the default node. Like New only virtual. More...
 
const char * GetNodeTagName () override
 
Get node XML tag name (like Storage, Model) More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkMRMLStorageNode
unsigned int AddFileName (const char *fileName)
 
Add in another file name to the list of file names More...
 
unsigned int AddURI (const char *uri)
 
Add in another URI to the list of URI's More...
 
virtual bool CanWriteFromReferenceNode (vtkMRMLNode *refNode)
 
virtual void ConfigureForDataExchange ()
 
int FileNameIsInList (const char *fileName)
 
const char * GetAbsoluteFilePath (const char *inputPath)
 
virtual std::string GetCompressionParameter ()
 
virtual std::string GetCompressionParameterFromDisplayName (const std::string &name)
 Returns a string representing the specified preset. More...
 
virtual std::vector< std::string > GetCompressionPresetDisplayNames ()
 Returns a list of displayable names of the supported compression presets. More...
 
virtual const std::vector< CompressionPresetGetCompressionPresets ()
 Get a list of all supported compression presets. More...
 
virtual const char * GetDefaultWriteFileExtension ()
 
Return default file extension for writing. More...
 
virtual std::string GetDisplayNameFromCompressionParameter (const std::string &preset)
 Returns the name of the specified preset. More...
 
virtual void GetFileExtensionsFromFileTypes (vtkStringArray *inputFileTypes, vtkStringArray *outputFileExtensions)
 
virtual char * GetFileName ()
 
std::string GetFileNameWithoutExtension (const char *fileName=nullptr)
 
std::string GetFullNameFromFileName ()
 
std::string GetFullNameFromNthFileName (int n)
 
const char * GetNthFileName (int n) const
 
return the nth file name, null if doesn't exist More...
 
const char * GetNthURI (int n)
 
Get the nth URI from the list of URI's More...
 
virtual int GetNumberOfCompressionPresets ()
 Get the number of compression presets. More...
 
int GetNumberOfFileNames () const
 
See how many file names were generated during ExecuteInformation More...
 
int GetNumberOfURIs ()
 
Return how many uri names this storage node holds in it's list More...
 
virtual int GetReadState ()
 Get/Set the state of reading. More...
 
const char * GetReadStateAsString ()
 
const char * GetStateAsString (int state)
 
virtual vtkMRMLStorableNodeGetStorableNode ()
 
vtkTimeStamp GetStoredTime ()
 
virtual std::string GetSupportedFileExtension (const char *fileName=nullptr, bool includeReadable=true, bool includeWriteable=true)
 
virtual vtkStringArray * GetSupportedReadFileTypes ()
 
virtual vtkStringArray * GetSupportedWriteFileTypes ()
 
virtual char * GetTempFileName ()
 
virtual char * GetURI ()
 
virtual vtkURIHandlerGetURIHandler ()
 
virtual int GetUseCompression ()
 
virtual char * GetWriteFileFormat ()
 
virtual int GetWriteState ()
 
Get/Set the state of writing More...
 
const char * GetWriteStateAsString ()
 
void InvalidateFile ()
 
int IsFilePathRelative (const char *filepath)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
 
Propagate Progress Event generated in ReadData More...
 
virtual int ReadData (vtkMRMLNode *refNode, bool temporaryFile=false)
 
void ResetFileNameList ()
 
Clear the array of file names More...
 
void ResetNthFileName (int n, const char *fileName)
 
Set the nth file in FileNameList, checks that it is already defined More...
 
void ResetNthURI (int n, const char *uri)
 
Set the nth uri in URIList, checks that it is already defined More...
 
void ResetURIList ()
 
Clear the array of URIs More...
 
virtual void SetCompressionParameter (std::string)
 Compression parameter that is used to save the node. More...
 
void SetDataDirectory (const char *dataDirName)
 
Set a new data directory for all files More...
 
virtual void SetDefaultWriteFileExtension (const char *ext)
 
virtual void SetFileName (const char *)
 
virtual void SetReadState (int)
 
void SetReadStateCancelled ()
 
void SetReadStateIdle ()
 
void SetReadStatePending ()
 
void SetReadStateScheduled ()
 
void SetReadStateSkippedNoData ()
 
void SetReadStateTransferDone ()
 
void SetReadStateTransferring ()
 
virtual void SetTempFileName (const char *)
 
A temporary file name used to calculate absolute paths More...
 
virtual void SetURI (const char *)
 
Location of the remote copy of this file. More...
 
virtual void SetURIHandler (vtkURIHandler *uriHandler)
 
void SetURIPrefix (const char *uriPrefix)
 
Set a new URI base for all URI's More...
 
virtual void SetUseCompression (int)
 
virtual void SetWriteFileFormat (const char *)
 
Allow to set specific file format that this node will write output. More...
 
virtual void SetWriteState (int)
 
void SetWriteStateCancelled ()
 
void SetWriteStateIdle ()
 
void SetWriteStatePending ()
 
void SetWriteStateScheduled ()
 
void SetWriteStateSkippedNoData ()
 
void SetWriteStateTransferDone ()
 
void SetWriteStateTransferring ()
 
virtual int SupportedFileType (const char *fileName)
 
virtual void UseCompressionOff ()
 
virtual void UseCompressionOn ()
 
Use compression on write More...
 
virtual int WriteData (vtkMRMLNode *refNode)
 
- 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...
 
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 vtkMRMLAnnotationRulerStorageNodeNew ()
 
static vtkMRMLAnnotationRulerStorageNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAnnotationLinesStorageNode
static int IsTypeOf (const char *type)
 
static vtkMRMLAnnotationLinesStorageNodeNew ()
 
static vtkMRMLAnnotationLinesStorageNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAnnotationControlPointsStorageNode
static int IsTypeOf (const char *type)
 
static vtkMRMLAnnotationControlPointsStorageNodeNew ()
 
static vtkMRMLAnnotationControlPointsStorageNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAnnotationStorageNode
static int IsTypeOf (const char *type)
 
static vtkMRMLAnnotationStorageNodeNew ()
 
static vtkMRMLAnnotationStorageNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLStorageNode
static std::string GetLowercaseExtensionFromFileName (const std::string &filename)
 
static int IsTypeOf (const char *type)
 
static vtkMRMLStorageNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

const char * GetAnnotationStorageType ()
 
void operator= (const vtkMRMLAnnotationRulerStorageNode &)
 
int ReadAnnotation (vtkMRMLAnnotationRulerNode *refNode)
 
int ReadAnnotationRulerData (vtkMRMLAnnotationRulerNode *refNode, char line[1024], int typeColumn, int line1IDColumn, int selColumn, int visColumn, int numColumns)
 
int ReadAnnotationRulerProperties (vtkMRMLAnnotationRulerNode *refNode, char line[1024], int &typeColumn, int &line1IDColumn, int &selColumn, int &visColumn, int &numColumns)
 
int ReadDataInternal (vtkMRMLNode *refNode) override
 Read data and set it in the referenced node. More...
 
 vtkMRMLAnnotationRulerStorageNode ()
 
 vtkMRMLAnnotationRulerStorageNode (const vtkMRMLAnnotationRulerStorageNode &)
 
int WriteAnnotationDataInternal (vtkMRMLNode *refNode, fstream &of) override
 Write data from the referenced node into the stream. More...
 
int WriteAnnotationRulerData (fstream &of, vtkMRMLAnnotationRulerNode *refNode)
 
int WriteAnnotationRulerProperties (fstream &of, vtkMRMLAnnotationRulerNode *refNode)
 
 ~vtkMRMLAnnotationRulerStorageNode () override
 
- Protected Member Functions inherited from vtkMRMLAnnotationLinesStorageNode
const char * GetAnnotationStorageType ()
 
void operator= (const vtkMRMLAnnotationLinesStorageNode &)
 
int ReadAnnotation (vtkMRMLAnnotationLinesNode *refNode)
 
int ReadAnnotationLineDisplayProperties (vtkMRMLAnnotationLineDisplayNode *refNode, std::string lineString, std::string preposition)
 
int ReadAnnotationLinesData (vtkMRMLAnnotationLinesNode *refNode, char line[1024], int typeColumn, int startIDColumn, int endIDColumn, int selColumn, int visColumn, int numColumns)
 
int ReadAnnotationLinesProperties (vtkMRMLAnnotationLinesNode *refNode, char line[1024], int &typeColumn, int &startIDColumn, int &endIDColumn, int &selColumn, int &visColumn, int &numColumns)
 
 vtkMRMLAnnotationLinesStorageNode ()
 
 vtkMRMLAnnotationLinesStorageNode (const vtkMRMLAnnotationLinesStorageNode &)
 
int WriteAnnotationLineDisplayProperties (fstream &of, vtkMRMLAnnotationLineDisplayNode *refNode, std::string preposition)
 
int WriteAnnotationLinesData (fstream &of, vtkMRMLAnnotationLinesNode *refNode)
 
int WriteAnnotationLinesProperties (fstream &of, vtkMRMLAnnotationLinesNode *refNode)
 
 ~vtkMRMLAnnotationLinesStorageNode () override
 
- Protected Member Functions inherited from vtkMRMLAnnotationControlPointsStorageNode
const char * GetAnnotationStorageType ()
 
void operator= (const vtkMRMLAnnotationControlPointsStorageNode &)
 
int ReadAnnotation (vtkMRMLAnnotationControlPointsNode *refNode)
 
int ReadAnnotationControlPointsData (vtkMRMLAnnotationControlPointsNode *refNode, char line[1024], int typeColumn, int xColumn, int yColumn, int zColumn, int selColumn, int visColumn, int numColumns)
 
int ReadAnnotationControlPointsProperties (vtkMRMLAnnotationControlPointsNode *refNode, char line[1024], int &typeColumn, int &xColumn, int &yColumn, int &zColumn, int &selColumn, int &visColumn, int &numColumns)
 
int ReadAnnotationPointDisplayProperties (vtkMRMLAnnotationPointDisplayNode *refNode, std::string lineString, std::string preposition)
 
 vtkMRMLAnnotationControlPointsStorageNode ()
 
 vtkMRMLAnnotationControlPointsStorageNode (const vtkMRMLAnnotationControlPointsStorageNode &)
 
int WriteAnnotationControlPointsData (fstream &of, vtkMRMLAnnotationControlPointsNode *refNode)
 
int WriteAnnotationControlPointsProperties (fstream &of, vtkMRMLAnnotationControlPointsNode *refNode)
 
int WriteAnnotationPointDisplayProperties (fstream &of, vtkMRMLAnnotationPointDisplayNode *refNode, std::string preposition)
 
 ~vtkMRMLAnnotationControlPointsStorageNode () override
 
- Protected Member Functions inherited from vtkMRMLAnnotationStorageNode
const char * GetAnnotationStorageType ()
 
void InitializeSupportedReadFileTypes () override
 Initialize all the supported read file types. More...
 
void InitializeSupportedWriteFileTypes () override
 Initialize all the supported write file types. More...
 
int OpenFileToRead (fstream &of, vtkMRMLNode *refNode)
 
int OpenFileToWrite (fstream &of)
 
void operator= (const vtkMRMLAnnotationStorageNode &)
 
int ReadAnnotation (vtkMRMLAnnotationNode *refNode)
 
int ReadAnnotationDisplayProperties (vtkMRMLAnnotationDisplayNode *annotationDisplayNode, std::string lineString, std::string preposition)
 
int ReadAnnotationTextData (vtkMRMLAnnotationNode *refNode, char line[1024], int typeColumn, int textColumn, int selColumn, int visColumn, int numColumns)
 
int ReadAnnotationTextDisplayProperties (vtkMRMLAnnotationTextDisplayNode *annotationDisplayNode, std::string lineString, std::string preposition)
 
int ReadAnnotationTextProperties (vtkMRMLAnnotationNode *annotationNode, char line[1024], int &typeColumn, int &annotationColumn, int &selColumn, int &visColumn, int &columnNumber)
 
int ReadDataInternal (vtkMRMLNode *refNode) override
 Read data and set it in the referenced node. More...
 
 vtkMRMLAnnotationStorageNode ()
 
 vtkMRMLAnnotationStorageNode (const vtkMRMLAnnotationStorageNode &)
 
int WriteAnnotationData (fstream &of, vtkMRMLAnnotationNode *refNode)
 
int WriteAnnotationDisplayProperties (fstream &of, vtkMRMLAnnotationDisplayNode *refNode, std::string preposition)
 
int WriteAnnotationTextDisplayProperties (fstream &of, vtkMRMLAnnotationTextDisplayNode *refNode, std::string preposition)
 
int WriteAnnotationTextProperties (fstream &of, vtkMRMLAnnotationNode *refNode)
 
int WriteDataInternal (vtkMRMLNode *refNode) override
 Write data from a referenced node. More...
 
 ~vtkMRMLAnnotationStorageNode () override
 
- Protected Member Functions inherited from vtkMRMLStorageNode
void operator= (const vtkMRMLStorageNode &)
 
void StageReadData (vtkMRMLNode *refNode)
 
void StageWriteData (vtkMRMLNode *refNode)
 
virtual void UpdateCompressionPresets ()
 
 vtkMRMLStorageNode ()
 
 vtkMRMLStorageNode (const vtkMRMLStorageNode &)
 
 ~vtkMRMLStorageNode () 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...
 

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)
 
- Protected Attributes inherited from vtkMRMLStorageNode
std::string CompressionParameter
 
std::vector< CompressionPresetCompressionPresets
 
std::string DefaultWriteFileExtension
 List of supported extensions to write in. More...
 
char * FileName
 
std::vector< std::string > FileNameList
 
An array of file names, should contain the FileName but may not More...
 
vtkWeakPointer< vtkMRMLStorableNodeLastFoundStorableNode
 
int ReadState
 
vtkTimeStamp * StoredTime
 
vtkStringArray * SupportedReadFileTypes
 List of supported extensions to read in. More...
 
vtkStringArray * SupportedWriteFileTypes
 
char * TempFileName
 
char * URI
 
vtkURIHandlerURIHandler
 
std::vector< std::string > URIList
 
An array of URI's, should contain the URI but may not More...
 
int UseCompression
 
char * WriteFileFormat
 
int WriteState
 
- 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
 

Detailed Description

Definition at line 15 of file vtkMRMLAnnotationRulerStorageNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 20 of file vtkMRMLAnnotationRulerStorageNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLAnnotationRulerStorageNode() [1/2]

vtkMRMLAnnotationRulerStorageNode::vtkMRMLAnnotationRulerStorageNode ( )
protected

◆ ~vtkMRMLAnnotationRulerStorageNode()

vtkMRMLAnnotationRulerStorageNode::~vtkMRMLAnnotationRulerStorageNode ( )
overrideprotected

◆ vtkMRMLAnnotationRulerStorageNode() [2/2]

vtkMRMLAnnotationRulerStorageNode::vtkMRMLAnnotationRulerStorageNode ( const vtkMRMLAnnotationRulerStorageNode )
protected

Member Function Documentation

◆ CanReadInReferenceNode()

bool vtkMRMLAnnotationRulerStorageNode::CanReadInReferenceNode ( vtkMRMLNode refNode)
overridevirtual

Return true if the node can be read in.

Reimplemented from vtkMRMLAnnotationLinesStorageNode.

◆ Copy()

void vtkMRMLAnnotationRulerStorageNode::Copy ( vtkMRMLNode node)
overridevirtual


Copy the node's attributes to this object

Reimplemented from vtkMRMLAnnotationLinesStorageNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLAnnotationRulerStorageNode::CreateNodeInstance ( )
overridevirtual

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

Note
Subclasses should implement this method

Reimplemented from vtkMRMLAnnotationLinesStorageNode.

◆ GetAnnotationStorageType()

const char* vtkMRMLAnnotationRulerStorageNode::GetAnnotationStorageType ( )
inlineprotected

Definition at line 55 of file vtkMRMLAnnotationRulerStorageNode.h.

◆ GetClassName()

virtual const char* vtkMRMLAnnotationRulerStorageNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLAnnotationLinesStorageNode.

◆ GetNodeTagName()

const char* vtkMRMLAnnotationRulerStorageNode::GetNodeTagName ( )
inlineoverridevirtual


Get node XML tag name (like Storage, Model)

Reimplemented from vtkMRMLAnnotationLinesStorageNode.

Definition at line 40 of file vtkMRMLAnnotationRulerStorageNode.h.

◆ IsA()

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

Reimplemented from vtkMRMLAnnotationLinesStorageNode.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLAnnotationRulerStorageNode* vtkMRMLAnnotationRulerStorageNode::New ( )
static

◆ operator=()

void vtkMRMLAnnotationRulerStorageNode::operator= ( const vtkMRMLAnnotationRulerStorageNode )
protected

◆ PrintSelf()

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

◆ ReadAnnotation()

int vtkMRMLAnnotationRulerStorageNode::ReadAnnotation ( vtkMRMLAnnotationRulerNode refNode)
protected

◆ ReadAnnotationRulerData()

int vtkMRMLAnnotationRulerStorageNode::ReadAnnotationRulerData ( vtkMRMLAnnotationRulerNode refNode,
char  line[1024],
int  typeColumn,
int  line1IDColumn,
int  selColumn,
int  visColumn,
int  numColumns 
)
protected

◆ ReadAnnotationRulerProperties()

int vtkMRMLAnnotationRulerStorageNode::ReadAnnotationRulerProperties ( vtkMRMLAnnotationRulerNode refNode,
char  line[1024],
int &  typeColumn,
int &  line1IDColumn,
int &  selColumn,
int &  visColumn,
int &  numColumns 
)
protected

◆ ReadDataInternal()

int vtkMRMLAnnotationRulerStorageNode::ReadDataInternal ( vtkMRMLNode refNode)
overrideprotectedvirtual

Read data and set it in the referenced node.

Reimplemented from vtkMRMLAnnotationLinesStorageNode.

◆ ReadOneRuler()

int vtkMRMLAnnotationRulerStorageNode::ReadOneRuler ( fstream &  fstr,
vtkMRMLAnnotationRulerNode refNode 
)

Read a single ruler from an open list file, called by the hierarchy storage node

◆ ReadXMLAttributes()

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


Read node attributes from XML file

Reimplemented from vtkMRMLAnnotationLinesStorageNode.

◆ SafeDownCast()

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

◆ WriteAnnotationDataInternal()

int vtkMRMLAnnotationRulerStorageNode::WriteAnnotationDataInternal ( vtkMRMLNode refNode,
fstream &  of 
)
overrideprotectedvirtual

Write data from the referenced node into the stream.

Reimplemented from vtkMRMLAnnotationLinesStorageNode.

◆ WriteAnnotationRulerData()

int vtkMRMLAnnotationRulerStorageNode::WriteAnnotationRulerData ( fstream &  of,
vtkMRMLAnnotationRulerNode refNode 
)
protected

◆ WriteAnnotationRulerProperties()

int vtkMRMLAnnotationRulerStorageNode::WriteAnnotationRulerProperties ( fstream &  of,
vtkMRMLAnnotationRulerNode refNode 
)
protected

◆ WriteXML()

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


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

Reimplemented from vtkMRMLAnnotationLinesStorageNode.


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