Slicer  4.9
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
vtkMRMLCommandLineModuleNode Class Reference

MRML node for representing the parameters allowing to run a command line interface module (CLI). The CLI parameters are defined with SetModuleDescription(). The parameters can be changed with SetParameterAsXXX(). It is possible to automatically run the CLI each time the parameters are changed, see SetAutoRun(). More...

#include <Libs/MRML/CLI/vtkMRMLCommandLineModuleNode.h>

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

Public Types

enum  AutoRunMode {
  AutoRunCancelsRunningProcess = 0x01, AutoRunOnChangedParameter = 0x10, AutoRunOnModifiedInputEvent = 0x20, AutoRunOnOtherInputEvents = 0x40,
  AutoRunOnAnyInputEvent = AutoRunOnModifiedInputEvent | AutoRunOnOtherInputEvents, AutoRunEnabledMask = AutoRunOnChangedParameter | AutoRunOnAnyInputEvent
}
 
enum  CLINodeEvent { ParameterChangedEvent = 17000, InputParameterEvent, AutoRunEvent, StatusModifiedEvent }
 List of events that can be fired on or by the node. More...
 
enum  StatusType {
  Idle =0x00, Scheduled =0x01, Running =0x02, Cancelling =0x04,
  Cancelled =0x08, Completing =0x10, Completed =0x20, ErrorsMask =0x40,
  CompletedWithErrors = Completed | ErrorsMask, BusyMask = Scheduled | Running | Cancelling | Completing
}
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

void Cancel ()
 
virtual void Copy (vtkMRMLNode *node) VTK_OVERRIDE
 Copy the node's attributes to this object. More...
 
virtual vtkMRMLNodeCreateNodeInstance () VTK_OVERRIDE
 Create instance of the default node. Like New only virtual. More...
 
bool GetAutoRun () const
 
unsigned int GetAutoRunDelay () const
 
int GetAutoRunMode () const
 
virtual const char * GetClassName ()
 
const std::string GetErrorText () const
 Get error messages generated during latest execution. More...
 
vtkMTimeType GetInputMTime () const
 
vtkMTimeType GetLastRunTime () const
 
const ModuleDescription & GetModuleDescription () const
 
ModuleDescription & GetModuleDescription ()
 
std::string GetModuleDescriptionAsString () const
 
std::string GetModuleTarget () const
 
std::string GetModuleTitle () const
 
std::string GetModuleType () const
 
std::string GetModuleVersion () const
 
virtual const char * GetNodeTagName () VTK_OVERRIDE
 Get node XML tag name (like Volume, Model) More...
 
unsigned int GetNumberOfParameterGroups () const
 
unsigned int GetNumberOfParametersInGroup (unsigned int group) const
 
const std::string GetOutputText () const
 Set output messages generated during latest execution. More...
 
std::string GetParameterArgType (unsigned int group, unsigned int param) const
 
std::string GetParameterAsString (const char *name) const
 
std::string GetParameterChannel (unsigned int group, unsigned int param) const
 
std::string GetParameterConstraints (unsigned int group, unsigned int param) const
 
std::string GetParameterCoordinateSystem (unsigned int group, unsigned int param) const
 
std::string GetParameterDefault (unsigned int group, unsigned int param) const
 
std::string GetParameterDescription (unsigned int group, unsigned int param) const
 
std::string GetParameterFileExtensions (unsigned int group, unsigned int param) const
 
std::string GetParameterFlag (unsigned int group, unsigned int param) const
 
std::string GetParameterGroupAdvanced (unsigned int group) const
 
std::string GetParameterGroupDescription (unsigned int group) const
 
std::string GetParameterGroupLabel (unsigned int group) const
 
std::string GetParameterIndex (unsigned int group, unsigned int param) const
 
std::string GetParameterLabel (unsigned int group, unsigned int param) const
 
std::string GetParameterLongFlag (unsigned int group, unsigned int param) const
 
std::string GetParameterMaximum (unsigned int group, unsigned int param) const
 
std::string GetParameterMinimum (unsigned int group, unsigned int param) const
 
vtkMTimeType GetParameterMTime () const
 
std::string GetParameterMultiple (unsigned int group, unsigned int param) const
 
std::string GetParameterName (unsigned int group, unsigned int param) const
 
std::string GetParameterTag (unsigned int group, unsigned int param) const
 
std::string GetParameterType (unsigned int group, unsigned int param) const
 
std::string GetParameterValue (unsigned int group, unsigned int param) const
 
int GetStatus () const
 
const char * GetStatusString () const
 
virtual int IsA (const char *type)
 
bool IsBusy () const
 
bool IsInputDefaultValue (const std::string &value) const
 
bool IsValidGroupId (unsigned int group) const
 
bool IsValidParamId (unsigned int group, unsigned int param) const
 
virtual void Modified () VTK_OVERRIDE
 Reimplemented for internal reasons. More...
 
void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
bool ReadParameterFile (const std::string &filename)
 
virtual void ReadXMLAttributes (const char **atts) VTK_OVERRIDE
 Set node attributes. More...
 
void SetAutoRun (bool enable)
 
void SetAutoRunDelay (unsigned int delayInMs)
 
void SetAutoRunMode (int autoRunMode)
 
void SetErrorText (const std::string &text, bool modify=true)
 Set error messages generated during latest execution. More...
 
void SetModuleDescription (const ModuleDescription &description)
 
void SetModuleDescription (const char *name)
 
void SetOutputText (const std::string &text, bool modify=true)
 Set output messages generated during latest execution. More...
 
bool SetParameterAsBool (const char *name, bool value)
 
bool SetParameterAsDouble (const char *name, double value)
 
bool SetParameterAsFloat (const char *name, float value)
 
bool SetParameterAsInt (const char *name, int value)
 
bool SetParameterAsNode (const char *name, vtkMRMLNode *value)
 
bool SetParameterAsString (const char *name, const std::string &value)
 
void SetStatus (int status, bool modify=true)
 
bool WriteParameterFile (const std::string &filename, bool withHandlesToBulkParameters=true)
 
virtual void WriteXML (ostream &of, int indent) VTK_OVERRIDE
 Write this node's information to a MRML file in XML format. More...
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=0)
 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=0, vtkIntArray *events=0)
 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 ()
 Only the scene can set itself to the node. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
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=NULL)
 This method allows the node to compress events. More...
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending. More...
 
bool IsSingleton ()
 
virtual void OnNodeAddedToScene ()
 
void PrintSelf (ostream &os, vtkIndent indent) VTK_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=0)
 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=0)
 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)
 
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 int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
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 GetNumberOfRegisteredModules ()
 Methods to manage the master list of module description prototypes. More...
 
static ModuleDescription GetRegisteredModuleDescription (const std::string &name)
 
static const char * GetRegisteredModuleNameByIndex (int idx)
 
static bool HasRegisteredModule (const std::string &name)
 
static int IsTypeOf (const char *type)
 
static vtkMRMLCommandLineModuleNodeNew ()
 
static void RegisterModuleDescription (ModuleDescription md)
 
static vtkMRMLCommandLineModuleNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

void AbortProcess ()
 
virtual void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) VTK_OVERRIDE
 Propagate events generated in mrml. More...
 
- 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 NULL). 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=NULL)
 
virtual void UpdateNthNodeReference (const char *referenceRole, int n)
 
 vtkMRMLNode ()
 
 vtkMRMLNode (const vtkMRMLNode &)
 
virtual ~vtkMRMLNode ()
 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 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
 

Detailed Description

MRML node for representing the parameters allowing to run a command line interface module (CLI). The CLI parameters are defined with SetModuleDescription(). The parameters can be changed with SetParameterAsXXX(). It is possible to automatically run the CLI each time the parameters are changed, see SetAutoRun().

Definition at line 26 of file vtkMRMLCommandLineModuleNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 30 of file vtkMRMLCommandLineModuleNode.h.

Member Enumeration Documentation

◆ AutoRunMode

This enum type controls when the CLI should be run automatically.

See also
SetAutoRun(), GetAutoRun()
Enumerator
AutoRunCancelsRunningProcess 

Triggering a new autorun cancels the processing of the current CLI if any.

See also
SetStatus(), Cancelling
AutoRunOnChangedParameter 

When set, it triggers autorun requests when a parameter is modified when calling SetParameterAsXXX().

See also
AutoRunOnModifiedInputEvent
AutoRunOnModifiedInputEvent 

When set, it triggers autorun requests when an input node (i.e. a parameter not in the output channel) is modified ( vtkCommand::ModifiedEvent is invoked). As of now, a parameter in both input and output channels does not trigger an autorun (infinite loop).

AutoRunOnOtherInputEvents 

Trigger an auto run when an input parameter fires an event other than vtkCommand::ModifiedEvent

AutoRunOnAnyInputEvent 

Trigger an auto run when an input parameter fires any event.

AutoRunEnabledMask 

Mask used to know if auto run is configured with valid parameters.

Definition at line 139 of file vtkMRMLCommandLineModuleNode.h.

◆ CLINodeEvent

List of events that can be fired on or by the node.

Enumerator
ParameterChangedEvent 

Event invoked anytime a parameter value is changed.

See also
InputParameterModifiedEvent, SetParameterAsString(), SetParameterAsNode(), SetParameterAsInt(), SetParameterAsBool(), SetParameterAsDouble(), SetParameterAsFloat()
InputParameterEvent 

Event invoked anytime a node set as input parameter triggers an event. The type of event is passed as callData. (e.g. ModifiedEvent, PolyDataModifiedEvent).

See also
SetParameterAsNode(), ParameterChangedEvent
AutoRunEvent 

Event invoked when the AutoRun is triggerd. It takes a request time as call data. 0 when called from CLI node.

See also
SetAutoRun()
StatusModifiedEvent 

Event invoked when the CLI changes of status.

Definition at line 49 of file vtkMRMLCommandLineModuleNode.h.

◆ StatusType

Enumerator
Idle 

Initial state of the CLI.

Scheduled 

State when the CLI has been requested to be executed.

Running 

State when the CLI is being executed.

Cancelling 

State when the CLI has been requested to be cancelled.

Cancelled 

State when the CLI is no longer being executed because Cancelling has been requested. Do not set manually, use Cancel() instead.

Completing 

State when the CLI has been successfully executed and is in a finishing state that loads the outputs into the scene.

Completed 

State when the CLI has been successfully executed and outputs are loaded in the scene.

ErrorsMask 

Mask applied when the CLI has been executed with errors.

CompletedWithErrors 

State when the CLI has been executed with errors.

BusyMask 

Mask used to know if the CLI is in pending mode.

Definition at line 75 of file vtkMRMLCommandLineModuleNode.h.

Member Function Documentation

◆ AbortProcess()

void vtkMRMLCommandLineModuleNode::AbortProcess ( )
protected

◆ Cancel()

void vtkMRMLCommandLineModuleNode::Cancel ( )

Set a request to stop the processing of the CLI. Do nothing if the module is not "busy".

See also
IsBusy(), Cancelling, Cancelled

◆ Copy()

virtual void vtkMRMLCommandLineModuleNode::Copy ( vtkMRMLNode node)
virtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLNode.

◆ CreateNodeInstance()

virtual vtkMRMLNode* vtkMRMLCommandLineModuleNode::CreateNodeInstance ( )
virtual

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

Note
Subclasses should implement this method

Implements vtkMRMLNode.

◆ GetAutoRun()

bool vtkMRMLCommandLineModuleNode::GetAutoRun ( ) const

Return true if the AutoRun is enabled, false otherwise.

See also
SetAutoRun(), AutoRunMode, GetAutoRunDelay()

◆ GetAutoRunDelay()

unsigned int vtkMRMLCommandLineModuleNode::GetAutoRunDelay ( ) const

Return the number of msecs to wait before automatically running the module.

See also
SetAutoRunDelay(), GetAutoRun(), GetAutoRunMode()

◆ GetAutoRunMode()

int vtkMRMLCommandLineModuleNode::GetAutoRunMode ( ) const

Return the AutoRun mode flags.

See also
AutoRunMode, SetAutoRunMode(), GetAutoRun(), GetAutoRunDelay()

◆ GetClassName()

virtual const char* vtkMRMLCommandLineModuleNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLNode.

◆ GetErrorText()

const std::string vtkMRMLCommandLineModuleNode::GetErrorText ( ) const

Get error messages generated during latest execution.

◆ GetInputMTime()

vtkMTimeType vtkMRMLCommandLineModuleNode::GetInputMTime ( ) const

Return the last time an input parameter was modified.

See also
GetParameterMTime(), GetMTime()

◆ GetLastRunTime()

vtkMTimeType vtkMRMLCommandLineModuleNode::GetLastRunTime ( ) const

Return the last time the module was ran.

See also
GetParameterMTime(), GetInputMTime(), GetMTime()

◆ GetModuleDescription() [1/2]

const ModuleDescription& vtkMRMLCommandLineModuleNode::GetModuleDescription ( ) const

Get/Set the module description object. THe module description object is used to cache the current settings for the module.

◆ GetModuleDescription() [2/2]

ModuleDescription& vtkMRMLCommandLineModuleNode::GetModuleDescription ( )

◆ GetModuleDescriptionAsString()

std::string vtkMRMLCommandLineModuleNode::GetModuleDescriptionAsString ( ) const

◆ GetModuleTarget()

std::string vtkMRMLCommandLineModuleNode::GetModuleTarget ( ) const

◆ GetModuleTitle()

std::string vtkMRMLCommandLineModuleNode::GetModuleTitle ( ) const

◆ GetModuleType()

std::string vtkMRMLCommandLineModuleNode::GetModuleType ( ) const

◆ GetModuleVersion()

std::string vtkMRMLCommandLineModuleNode::GetModuleVersion ( ) const

◆ GetNodeTagName()

virtual const char* vtkMRMLCommandLineModuleNode::GetNodeTagName ( )
inlinevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 45 of file vtkMRMLCommandLineModuleNode.h.

◆ GetNumberOfParameterGroups()

unsigned int vtkMRMLCommandLineModuleNode::GetNumberOfParameterGroups ( ) const

◆ GetNumberOfParametersInGroup()

unsigned int vtkMRMLCommandLineModuleNode::GetNumberOfParametersInGroup ( unsigned int  group) const

◆ GetNumberOfRegisteredModules()

static int vtkMRMLCommandLineModuleNode::GetNumberOfRegisteredModules ( )
static

Methods to manage the master list of module description prototypes.

◆ GetOutputText()

const std::string vtkMRMLCommandLineModuleNode::GetOutputText ( ) const

Set output messages generated during latest execution.

◆ GetParameterArgType()

std::string vtkMRMLCommandLineModuleNode::GetParameterArgType ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterAsString()

std::string vtkMRMLCommandLineModuleNode::GetParameterAsString ( const char *  name) const

◆ GetParameterChannel()

std::string vtkMRMLCommandLineModuleNode::GetParameterChannel ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterConstraints()

std::string vtkMRMLCommandLineModuleNode::GetParameterConstraints ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterCoordinateSystem()

std::string vtkMRMLCommandLineModuleNode::GetParameterCoordinateSystem ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterDefault()

std::string vtkMRMLCommandLineModuleNode::GetParameterDefault ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterDescription()

std::string vtkMRMLCommandLineModuleNode::GetParameterDescription ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterFileExtensions()

std::string vtkMRMLCommandLineModuleNode::GetParameterFileExtensions ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterFlag()

std::string vtkMRMLCommandLineModuleNode::GetParameterFlag ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterGroupAdvanced()

std::string vtkMRMLCommandLineModuleNode::GetParameterGroupAdvanced ( unsigned int  group) const

◆ GetParameterGroupDescription()

std::string vtkMRMLCommandLineModuleNode::GetParameterGroupDescription ( unsigned int  group) const

◆ GetParameterGroupLabel()

std::string vtkMRMLCommandLineModuleNode::GetParameterGroupLabel ( unsigned int  group) const

◆ GetParameterIndex()

std::string vtkMRMLCommandLineModuleNode::GetParameterIndex ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterLabel()

std::string vtkMRMLCommandLineModuleNode::GetParameterLabel ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterLongFlag()

std::string vtkMRMLCommandLineModuleNode::GetParameterLongFlag ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterMaximum()

std::string vtkMRMLCommandLineModuleNode::GetParameterMaximum ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterMinimum()

std::string vtkMRMLCommandLineModuleNode::GetParameterMinimum ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterMTime()

vtkMTimeType vtkMRMLCommandLineModuleNode::GetParameterMTime ( ) const

Return the last time a parameter was modified

See also
GetInputMTime(), GetMTime()

◆ GetParameterMultiple()

std::string vtkMRMLCommandLineModuleNode::GetParameterMultiple ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterName()

std::string vtkMRMLCommandLineModuleNode::GetParameterName ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterTag()

std::string vtkMRMLCommandLineModuleNode::GetParameterTag ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterType()

std::string vtkMRMLCommandLineModuleNode::GetParameterType ( unsigned int  group,
unsigned int  param 
) const

◆ GetParameterValue()

std::string vtkMRMLCommandLineModuleNode::GetParameterValue ( unsigned int  group,
unsigned int  param 
) const

◆ GetRegisteredModuleDescription()

static ModuleDescription vtkMRMLCommandLineModuleNode::GetRegisteredModuleDescription ( const std::string &  name)
static

◆ GetRegisteredModuleNameByIndex()

static const char* vtkMRMLCommandLineModuleNode::GetRegisteredModuleNameByIndex ( int  idx)
static

◆ GetStatus()

int vtkMRMLCommandLineModuleNode::GetStatus ( ) const

◆ GetStatusString()

const char* vtkMRMLCommandLineModuleNode::GetStatusString ( ) const

Return current status as a string for display.

See also
GetStatus(), IsBusy()

◆ HasRegisteredModule()

static bool vtkMRMLCommandLineModuleNode::HasRegisteredModule ( const std::string &  name)
static

◆ IsA()

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

Reimplemented from vtkMRMLNode.

◆ IsBusy()

bool vtkMRMLCommandLineModuleNode::IsBusy ( ) const

Return true if the module is in a busy state: Scheduled, Running, Cancelling, Completing.

See also
SetStatus(), GetStatus(), BusyMask, Cancel()

◆ IsInputDefaultValue()

bool vtkMRMLCommandLineModuleNode::IsInputDefaultValue ( const std::string &  value) const

Returns true if the value is a default value for a parameter that is not an output parameter.

See also
SetAutoRun

◆ IsTypeOf()

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

◆ IsValidGroupId()

bool vtkMRMLCommandLineModuleNode::IsValidGroupId ( unsigned int  group) const

◆ IsValidParamId()

bool vtkMRMLCommandLineModuleNode::IsValidParamId ( unsigned int  group,
unsigned int  param 
) const

◆ Modified()

virtual void vtkMRMLCommandLineModuleNode::Modified ( )
virtual

Reimplemented for internal reasons.

Reimplemented from vtkMRMLNode.

◆ New()

static vtkMRMLCommandLineModuleNode* vtkMRMLCommandLineModuleNode::New ( )
static

◆ PrintSelf()

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

◆ ProcessMRMLEvents()

virtual void vtkMRMLCommandLineModuleNode::ProcessMRMLEvents ( vtkObject *  caller,
unsigned long  event,
void *  callData 
)
protectedvirtual

Propagate events generated in mrml.

Reimplemented from vtkMRMLNode.

◆ ReadParameterFile()

bool vtkMRMLCommandLineModuleNode::ReadParameterFile ( const std::string &  filename)

Read a parameter file. This will set any parameters that parameters in this ModuleDescription.

◆ ReadXMLAttributes()

virtual void vtkMRMLCommandLineModuleNode::ReadXMLAttributes ( const char **  atts)
virtual

Set node attributes.

Reimplemented from vtkMRMLNode.

◆ RegisterModuleDescription()

static void vtkMRMLCommandLineModuleNode::RegisterModuleDescription ( ModuleDescription  md)
static

◆ SafeDownCast()

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

◆ SetAutoRun()

void vtkMRMLCommandLineModuleNode::SetAutoRun ( bool  enable)

Enable/Disable the AutoRun for the CLI node. The behavior is ensured by the CLI logic. AutoRun is disabled (false) by default.

See also
GetAutoRun(), AutoRunMode, SetAutoRunDelay()

◆ SetAutoRunDelay()

void vtkMRMLCommandLineModuleNode::SetAutoRunDelay ( unsigned int  delayInMs)

Set the number of msecs to wait before automatically running the module. 1000msecs by default.

See also
GetAutoRunDelay(), SetAutoRun(), SetAutoRunMode()

◆ SetAutoRunMode()

void vtkMRMLCommandLineModuleNode::SetAutoRunMode ( int  autoRunMode)

Set the auto running flags for the node. The behavior is ensured by the CLI logic. AutoRun is not enabled until SetAutoRun(true) is called. AutoRunWhenParameterChanged | AutoRunCancelsRunningProcess by default.

See also
AutoRunMode, GetAutoRunMode(), SetAutoRun(), SetAutoRunDelay()

◆ SetErrorText()

void vtkMRMLCommandLineModuleNode::SetErrorText ( const std::string &  text,
bool  modify = true 
)

Set error messages generated during latest execution.

◆ SetModuleDescription() [1/2]

void vtkMRMLCommandLineModuleNode::SetModuleDescription ( const ModuleDescription &  description)

◆ SetModuleDescription() [2/2]

void vtkMRMLCommandLineModuleNode::SetModuleDescription ( const char *  name)

◆ SetOutputText()

void vtkMRMLCommandLineModuleNode::SetOutputText ( const std::string &  text,
bool  modify = true 
)

Set output messages generated during latest execution.

◆ SetParameterAsBool()

bool vtkMRMLCommandLineModuleNode::SetParameterAsBool ( const char *  name,
bool  value 
)

◆ SetParameterAsDouble()

bool vtkMRMLCommandLineModuleNode::SetParameterAsDouble ( const char *  name,
double  value 
)

◆ SetParameterAsFloat()

bool vtkMRMLCommandLineModuleNode::SetParameterAsFloat ( const char *  name,
float  value 
)

◆ SetParameterAsInt()

bool vtkMRMLCommandLineModuleNode::SetParameterAsInt ( const char *  name,
int  value 
)

◆ SetParameterAsNode()

bool vtkMRMLCommandLineModuleNode::SetParameterAsNode ( const char *  name,
vtkMRMLNode value 
)

Set the parameter name to the node value. If the parameter is not in the output channel, InputParameterModifiedEvent is invoked anytime the node is modified (ModifiedEvent is invoked).

See also
SetParameterAsString(), SetParameterAsBool(), SetParameterAsDouble(), SetParameterAsFloat(), SetParameterAsInt()

◆ SetParameterAsString()

bool vtkMRMLCommandLineModuleNode::SetParameterAsString ( const char *  name,
const std::string &  value 
)

◆ SetStatus()

void vtkMRMLCommandLineModuleNode::SetStatus ( int  status,
bool  modify = true 
)

Set the status of the node (Idle, Scheduled, Running, Completed). The "modify" parameter indicates whether the object can be modified by the call. Having modify = false is used when a separate thread updates the node status but does not want to invoke modified events because it would refresh the GUI from the thread. Do not call manually, only the logic should change the status of the node.

See also
GetStatus(), GetStatusString(), IsBusy(), Cancel()

◆ WriteParameterFile()

bool vtkMRMLCommandLineModuleNode::WriteParameterFile ( const std::string &  filename,
bool  withHandlesToBulkParameters = true 
)

Write a parameter file. This will output any parameters that parameters in this ModuleDescription. "withHandlesToBulkParameters" allows to control whether all parameters are written or just the parameters with simple IO mechanisms.

◆ WriteXML()

virtual void vtkMRMLCommandLineModuleNode::WriteXML ( ostream &  of,
int  indent 
)
virtual

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

Reimplemented from vtkMRMLNode.


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