vtkMRMLCommandLineModuleNode Class Reference

#include <vtkMRMLCommandLineModuleNode.h>

Inheritance diagram for vtkMRMLCommandLineModuleNode:

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 vtkMRMLNode *	CreateNodeInstance ()
ModuleDescription &	GetModuleDescription ()
const ModuleDescription &	GetModuleDescription () const
const char *	GetModuleTarget ()
const char *	GetModuleTitle ()
const char *	GetModuleType ()
const char *	GetModuleVersion ()
virtual const char *	GetNodeTagName ()
unsigned int	GetNumberOfParameterGroups ()
unsigned int	GetNumberOfParametersInGroup (unsigned int group)
int	GetNumberOfRegisteredModules ()
const char *	GetParameterArgType (unsigned int group, unsigned int param)
const char *	GetParameterAsString (const char *name) const
std::string	GetParameterAsString (const std::string &name) const
const char *	GetParameterChannel (unsigned int group, unsigned int param)
const char *	GetParameterConstraints (unsigned int group, unsigned int param)
const char *	GetParameterCoordinateSystem (unsigned int group, unsigned int param)
const char *	GetParameterDefault (unsigned int group, unsigned int param)
const char *	GetParameterDescription (unsigned int group, unsigned int param)
const char *	GetParameterFileExtensions (unsigned int group, unsigned int param)
const char *	GetParameterFlag (unsigned int group, unsigned int param)
const char *	GetParameterGroupAdvanced (unsigned int group)
const char *	GetParameterGroupDescription (unsigned int group)
const char *	GetParameterGroupLabel (unsigned int group)
const char *	GetParameterIndex (unsigned int group, unsigned int param)
const char *	GetParameterLabel (unsigned int group, unsigned int param)
const char *	GetParameterLongFlag (unsigned int group, unsigned int param)
const char *	GetParameterMaximum (unsigned int group, unsigned int param)
const char *	GetParameterMinimum (unsigned int group, unsigned int param)
const char *	GetParameterMultiple (unsigned int group, unsigned int param)
const char *	GetParameterName (unsigned int group, unsigned int param)
const char *	GetParameterTag (unsigned int group, unsigned int param)
const char *	GetParameterType (unsigned int group, unsigned int param)
const char *	GetRegisteredModuleNameByIndex (int idx)
StatusType	GetStatus ()
const char *	GetStatusString ()
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 ModuleDescriptionMap *	RegisteredModules = new ModuleDescriptionMap

---

Member Enumeration Documentation

enum vtkMRMLCommandLineModuleNode::StatusType

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]

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

Referenced by vtkCommandLineModuleLogic::Apply(), vtkSlicerCLIModuleLogic::Apply(), vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), vtkChangeTrackerLogic::DoITKRegistration(), vtkChangeTrackerLogic::DoITKROIRegistration(), vtkCommandLineModuleLogic::LazyEvaluateModuleTarget(), vtkChangeTrackerLogic::ResampleScan2(), vtkCommandLineModuleGUI::UpdateGUI(), and WriteXML().

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

References ModuleDescription::GetParameterDefaultValue(), and ModuleDescriptionObject.

Referenced by vtkCommandLineModuleGUI::UpdateGUI().

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

(

)

References m_Status.

Referenced by vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), vtkChangeTrackerLogic::DoITKRegistration(), vtkChangeTrackerLogic::DoITKROIRegistration(), vtkChangeTrackerLogic::ResampleScan2(), and vtkCommandLineModuleGUI::UpdateGUI().

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

)

References vtkMRMLNode::Modified(), ModuleDescriptionObject, and ModuleDescription::ReadParameterFile().

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]

Set node attributes

Reimplemented from vtkMRMLNode.

References GetRegisteredModuleDescription(), ModuleDescription::GetVersion(), ModuleDescription::HasParameter(), HasRegisteredModule(), ModuleDescriptionObject, vtkMRMLNode::SetAttribute(), ModuleDescription::SetParameterDefaultValue(), and vtkMRMLNode::URLDecodeString().

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

)

References ModuleDescription::GetTitle(), vtkMRMLNode::Modified(), ModuleDescriptionObject, and vtkMRMLNode::SetAttribute().

Referenced by Copy(), vtkChangeTrackerLogic::DoITKRegistration(), vtkChangeTrackerLogic::DoITKROIRegistration(), vtkCommandLineModuleGUI::ProcessGUIEvents(), vtkChangeTrackerLogic::ResampleScan2(), vtkSlicerDiffusionTestingWidget::RunDWI(), and vtkCommandLineModuleGUI::UpdateMRML().

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

References SetParameterAsBool().

Referenced by SetParameterAsBool().

void vtkMRMLCommandLineModuleNode::SetParameterAsBool	(	const std::string &	name,
		bool	value
	)

References FW::Actions::Modified.

Referenced by vtkSlicerDiffusionTestingWidget::RunDWI(), and vtkCommandLineModuleGUI::UpdateMRML().

void vtkMRMLCommandLineModuleNode::SetParameterAsDouble	(	const char *	name,
		const double	value
	)			[inline]

References SetParameterAsDouble().

Referenced by SetParameterAsDouble().

void vtkMRMLCommandLineModuleNode::SetParameterAsDouble	(	const std::string &	name,
		double	value
	)

References FW::Actions::Modified.

Referenced by vtkSlicerDiffusionTestingWidget::RunDWI(), and vtkCommandLineModuleGUI::UpdateMRML().

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
	)

Get/Set a parameter for the module.

References FW::Actions::Modified.

Referenced by vtkChangeTrackerLogic::DoITKRegistration(), vtkChangeTrackerLogic::DoITKROIRegistration(), vtkChangeTrackerLogic::ResampleScan2(), vtkSlicerDiffusionTestingWidget::RunDWI(), and vtkCommandLineModuleGUI::UpdateMRML().

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]

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

Reimplemented from vtkMRMLNode.

References GetModuleDescription(), ModuleDescription::GetParameterGroups(), ModuleDescription::GetTitle(), ModuleDescription::GetVersion(), and vtkMRMLNode::URLEncodeString().

---

Member Data Documentation

StatusType vtkMRMLCommandLineModuleNode::m_Status [private]

Referenced by Copy(), GetStatus(), PrintSelf(), and vtkMRMLCommandLineModuleNode().

ModuleDescription vtkMRMLCommandLineModuleNode::ModuleDescriptionObject [private]

Referenced by Copy(), GetParameterAsString(), PrintSelf(), ReadParameterFile(), ReadXMLAttributes(), and SetModuleDescription().

ModuleDescriptionMap * vtkMRMLCommandLineModuleNode::RegisteredModules = new ModuleDescriptionMap [static, private]

Referenced by GetNumberOfRegisteredModules(), and GetRegisteredModuleNameByIndex().

---

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

• Libs/MRMLCLI/vtkMRMLCommandLineModuleNode.h
• Libs/MRMLCLI/vtkMRMLCommandLineModuleNode.cxx