vtkMRMLCommandLineModuleNode Class Reference

#include <vtkMRMLCommandLineModuleNode.h>

Inheritance diagram for vtkMRMLCommandLineModuleNode:
vtkMRMLNode vtkObject

List of all members.

Public Types

enum  StatusType {
  Idle = 0, Scheduled = 1, Running = 2, Completed = 3,
  CompletedWithErrors = 4, Cancelled = 5
}

Public Member Functions

void AbortProcess ()
virtual void Copy (vtkMRMLNode *node)
virtual vtkMRMLNodeCreateNodeInstance ()
ModuleDescriptionGetModuleDescription ()
const ModuleDescriptionGetModuleDescription () const
const charGetModuleTarget ()
const charGetModuleTitle ()
const charGetModuleType ()
const charGetModuleVersion ()
virtual const charGetNodeTagName ()
unsigned int GetNumberOfParameterGroups ()
unsigned int GetNumberOfParametersInGroup (unsigned int group)
int GetNumberOfRegisteredModules ()
const charGetParameterArgType (unsigned int group, unsigned int param)
const charGetParameterAsString (const char *name) const
std::string GetParameterAsString (const std::string &name) const
const charGetParameterChannel (unsigned int group, unsigned int param)
const charGetParameterConstraints (unsigned int group, unsigned int param)
const charGetParameterCoordinateSystem (unsigned int group, unsigned int param)
const charGetParameterDefault (unsigned int group, unsigned int param)
const charGetParameterDescription (unsigned int group, unsigned int param)
const charGetParameterFileExtensions (unsigned int group, unsigned int param)
const charGetParameterFlag (unsigned int group, unsigned int param)
const charGetParameterGroupAdvanced (unsigned int group)
const charGetParameterGroupDescription (unsigned int group)
const charGetParameterGroupLabel (unsigned int group)
const charGetParameterIndex (unsigned int group, unsigned int param)
const charGetParameterLabel (unsigned int group, unsigned int param)
const charGetParameterLongFlag (unsigned int group, unsigned int param)
const charGetParameterMaximum (unsigned int group, unsigned int param)
const charGetParameterMinimum (unsigned int group, unsigned int param)
const charGetParameterMultiple (unsigned int group, unsigned int param)
const charGetParameterName (unsigned int group, unsigned int param)
const charGetParameterTag (unsigned int group, unsigned int param)
const charGetParameterType (unsigned int group, unsigned int param)
const charGetRegisteredModuleNameByIndex (int idx)
StatusType GetStatus ()
const charGetStatusString ()
void PrintSelf (ostream &os, vtkIndent indent)
bool ReadParameterFile (const char *filename)
bool ReadParameterFile (const std::string &filename)
virtual void ReadXMLAttributes (const char **atts)
void SetModuleDescription (const char *name)
void SetModuleDescription (const ModuleDescription &description)
void SetParameterAsBool (const char *name, const int value)
void SetParameterAsBool (const std::string &name, bool value)
void SetParameterAsDouble (const char *name, const double value)
void SetParameterAsDouble (const std::string &name, double value)
void SetParameterAsFloat (const char *name, const float value)
void SetParameterAsFloat (const std::string &name, float value)
void SetParameterAsInt (const char *name, const int value)
void SetParameterAsInt (const std::string &name, int value)
void SetParameterAsString (const char *name, const char *value)
 Some functions to make CommandLineModuleNodes useful from Tcl and Python.
void SetParameterAsString (const std::string &name, const std::string &value)
void SetStatus (StatusType status, bool modify=true)
 vtkTypeMacro (vtkMRMLCommandLineModuleNode, vtkMRMLNode)
bool WriteParameterFile (const char *filename, bool withHandlesToBulkParameters=true)
bool WriteParameterFile (const std::string &filename, bool withHandlesToBulkParameters=true)
virtual void WriteXML (ostream &of, int indent)

Static Public Member Functions

static void ClearRegisteredModules ()
static ModuleDescription GetRegisteredModuleDescription (const std::string &name)
static bool HasRegisteredModule (const std::string &name)
static
vtkMRMLCommandLineModuleNode
New ()
static void RegisterModuleDescription (ModuleDescription md)

Private Member Functions

void operator= (const vtkMRMLCommandLineModuleNode &)
 vtkMRMLCommandLineModuleNode (const vtkMRMLCommandLineModuleNode &)
 vtkMRMLCommandLineModuleNode ()
 ETX.
 ~vtkMRMLCommandLineModuleNode ()

Private Attributes

StatusType m_Status
ModuleDescription ModuleDescriptionObject

Static Private Attributes

static ModuleDescriptionMapRegisteredModules = new ModuleDescriptionMap

Member Enumeration Documentation

Enumerator:
Idle 
Scheduled 
Running 
Completed 
CompletedWithErrors 
Cancelled 

Constructor & Destructor Documentation

vtkMRMLCommandLineModuleNode::vtkMRMLCommandLineModuleNode (  )  [private]

ETX.

References vtkMRMLNode::HideFromEditors, Idle, and m_Status.

vtkMRMLCommandLineModuleNode::~vtkMRMLCommandLineModuleNode (  )  [private]
vtkMRMLCommandLineModuleNode::vtkMRMLCommandLineModuleNode ( const vtkMRMLCommandLineModuleNode  )  [private]

Member Function Documentation

void vtkMRMLCommandLineModuleNode::AbortProcess (  )  [inline]
void vtkMRMLCommandLineModuleNode::ClearRegisteredModules (  )  [static]
void vtkMRMLCommandLineModuleNode::Copy ( vtkMRMLNode node  )  [virtual]

Copy the node's attributes to this object

References m_Status, ModuleDescriptionObject, SetModuleDescription(), and SetStatus().

vtkMRMLNode * vtkMRMLCommandLineModuleNode::CreateNodeInstance (  )  [virtual]

Create instance of the default node. Like New only virtual NOTE: Subclasses should implement this method

Implements vtkMRMLNode.

References autoSlicerTracto2regions::ret.

ModuleDescription& vtkMRMLCommandLineModuleNode::GetModuleDescription (  )  [inline]
const ModuleDescription& vtkMRMLCommandLineModuleNode::GetModuleDescription (  )  const [inline]
const char* vtkMRMLCommandLineModuleNode::GetModuleTarget (  )  [inline]
const char* vtkMRMLCommandLineModuleNode::GetModuleTitle (  )  [inline]
const char* vtkMRMLCommandLineModuleNode::GetModuleType (  )  [inline]
const char* vtkMRMLCommandLineModuleNode::GetModuleVersion (  )  [inline]
virtual const char* vtkMRMLCommandLineModuleNode::GetNodeTagName (  )  [inline, virtual]

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

unsigned int vtkMRMLCommandLineModuleNode::GetNumberOfParameterGroups (  )  [inline]
unsigned int vtkMRMLCommandLineModuleNode::GetNumberOfParametersInGroup ( unsigned int  group  )  [inline]

References slicerget::size.

int vtkMRMLCommandLineModuleNode::GetNumberOfRegisteredModules (  ) 

References RegisteredModules.

const char* vtkMRMLCommandLineModuleNode::GetParameterArgType ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterAsString ( const char name  )  const [inline]
std::string vtkMRMLCommandLineModuleNode::GetParameterAsString ( const std::string &  name  )  const
const char* vtkMRMLCommandLineModuleNode::GetParameterChannel ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterConstraints ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterCoordinateSystem ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterDefault ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterDescription ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterFileExtensions ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterFlag ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterGroupAdvanced ( unsigned int  group  )  [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterGroupDescription ( unsigned int  group  )  [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterGroupLabel ( unsigned int  group  )  [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterIndex ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterLabel ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterLongFlag ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterMaximum ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterMinimum ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterMultiple ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterName ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterTag ( unsigned int  group,
unsigned int  param 
) [inline]
const char* vtkMRMLCommandLineModuleNode::GetParameterType ( unsigned int  group,
unsigned int  param 
) [inline]
ModuleDescription vtkMRMLCommandLineModuleNode::GetRegisteredModuleDescription ( const std::string &  name  )  [static]

Referenced by ReadXMLAttributes().

const char * vtkMRMLCommandLineModuleNode::GetRegisteredModuleNameByIndex ( int  idx  ) 

References RegisteredModules.

vtkMRMLCommandLineModuleNode::StatusType vtkMRMLCommandLineModuleNode::GetStatus (  ) 
const char* vtkMRMLCommandLineModuleNode::GetStatusString (  )  [inline]
bool vtkMRMLCommandLineModuleNode::HasRegisteredModule ( const std::string &  name  )  [static]

Referenced by ReadXMLAttributes().

vtkMRMLCommandLineModuleNode * vtkMRMLCommandLineModuleNode::New (  )  [static]

Reimplemented from vtkMRMLNode.

References autoSlicerTracto2regions::ret.

Referenced by Slicer3_main().

void vtkMRMLCommandLineModuleNode::operator= ( const vtkMRMLCommandLineModuleNode  )  [private]

Reimplemented from vtkMRMLNode.

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

Reimplemented from vtkMRMLNode.

References m_Status, and ModuleDescriptionObject.

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

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

Referenced by vtkSlicerApplicationLogic::ProcessReadNodeData().

void vtkMRMLCommandLineModuleNode::ReadXMLAttributes ( const char **  atts  )  [virtual]
void vtkMRMLCommandLineModuleNode::RegisterModuleDescription ( ModuleDescription  md  )  [static]

Methods to manage the master list of module description prototypes

References ModuleDescription::GetTitle().

Referenced by Slicer3_main().

void vtkMRMLCommandLineModuleNode::SetModuleDescription ( const char name  )  [inline]

References SetModuleDescription().

Referenced by SetModuleDescription().

void vtkMRMLCommandLineModuleNode::SetModuleDescription ( const ModuleDescription description  ) 
void vtkMRMLCommandLineModuleNode::SetParameterAsBool ( const char name,
const int  value 
) [inline]

References SetParameterAsBool().

Referenced by SetParameterAsBool().

void vtkMRMLCommandLineModuleNode::SetParameterAsBool ( const std::string &  name,
bool  value 
)
void vtkMRMLCommandLineModuleNode::SetParameterAsDouble ( const char name,
const double  value 
) [inline]

References SetParameterAsDouble().

Referenced by SetParameterAsDouble().

void vtkMRMLCommandLineModuleNode::SetParameterAsDouble ( const std::string &  name,
double  value 
)
void vtkMRMLCommandLineModuleNode::SetParameterAsFloat ( const char name,
const float  value 
) [inline]

References SetParameterAsFloat().

Referenced by SetParameterAsFloat().

void vtkMRMLCommandLineModuleNode::SetParameterAsFloat ( const std::string &  name,
float  value 
)

References FW::Actions::Modified.

void vtkMRMLCommandLineModuleNode::SetParameterAsInt ( const char name,
const int  value 
) [inline]

References SetParameterAsInt().

Referenced by SetParameterAsInt().

void vtkMRMLCommandLineModuleNode::SetParameterAsInt ( const std::string &  name,
int  value 
)

References FW::Actions::Modified.

void vtkMRMLCommandLineModuleNode::SetParameterAsString ( const char name,
const char value 
) [inline]

Some functions to make CommandLineModuleNodes useful from Tcl and Python.

References SetParameterAsString().

Referenced by SetParameterAsString().

void vtkMRMLCommandLineModuleNode::SetParameterAsString ( const std::string &  name,
const std::string &  value 
)
void vtkMRMLCommandLineModuleNode::SetStatus ( vtkMRMLCommandLineModuleNode::StatusType  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.

References FW::Actions::Modified.

Referenced by vtkCommandLineModuleLogic::Apply(), vtkSlicerCLIModuleLogic::Apply(), vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), and Copy().

vtkMRMLCommandLineModuleNode::vtkTypeMacro ( vtkMRMLCommandLineModuleNode  ,
vtkMRMLNode   
)
bool vtkMRMLCommandLineModuleNode::WriteParameterFile ( const char filename,
bool  withHandlesToBulkParameters = true 
)

References FW::Actions::Modified.

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.

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

Member Data Documentation


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

Generated on 6 Apr 2011 for Slicer3 by  doxygen 1.6.1