ModuleDescription Class Reference

#include <ModuleDescription.h>

Public Member Functions
void	AddParameterGroup (const ModuleParameterGroup &group)
const std::string &	GetAcknowledgements () const
const std::string &	GetAlternativeLocation () const
const std::string &	GetAlternativeTarget () const
const std::string &	GetAlternativeType () const
const std::string &	GetCategory () const
const std::string &	GetContributor () const
const std::string &	GetDescription () const
const std::string &	GetDocumentationURL () const
const std::string &	GetIndex () const
const std::string &	GetLicense () const
const std::string &	GetLocation () const
const ModuleLogo &	GetLogo () const
std::string	GetParameterDefaultValue (const std::string &name) const
std::vector < ModuleParameterGroup > &	GetParameterGroups ()
const std::vector < ModuleParameterGroup > &	GetParameterGroups () const
ModuleProcessInformation *	GetProcessInformation ()
const ModuleProcessInformation *	GetProcessInformation () const
const std::string &	GetTarget () const
const std::string &	GetTitle () const
const std::string &	GetType () const
	Get the type of the module: Unknown, SharedObjectModule, CommandLineModule.
const std::string &	GetVersion () const
bool	HasParameter (const std::string &name) const
bool	HasReturnParameters () const
	ModuleDescription (const ModuleDescription &md)
	ModuleDescription ()
void	operator= (const ModuleDescription &md)
bool	ReadParameterFile (const std::string &filename)
void	SetAcknowledgements (const std::string &acknowledgements)
void	SetAlternativeLocation (const std::string &target)
void	SetAlternativeTarget (const std::string &target)
void	SetAlternativeType (const std::string &type)
void	SetCategory (const std::string &cat)
void	SetContributor (const std::string &contributor)
void	SetDescription (const std::string &description)
void	SetDocumentationURL (const std::string &documentationURL)
void	SetIndex (const std::string &ind)
void	SetLicense (const std::string &license)
void	SetLocation (const std::string &target)
void	SetLogo (const ModuleLogo &logo)
bool	SetParameterDefaultValue (const std::string &name, const std::string &value)
void	SetParameterGroups (const std::vector< ModuleParameterGroup > &groups)
void	SetTarget (const std::string &target)
void	SetTitle (const std::string &title)
void	SetType (const std::string &type)
	Set the type of module: Unknown, SharedObjectModule, CommandLineModule.
void	SetVersion (const std::string &version)
bool	WriteParameterFile (const std::string &filename, bool withHandlesToBulkParameters=true)
Private Attributes
std::string	Acknowledgements
std::string	AlternativeLocation
std::string	AlternativeTarget
std::string	AlternativeType
std::string	Category
std::string	Contributor
std::string	Description
std::string	DocumentationURL
std::string	Index
std::string	License
std::string	Location
ModuleLogo	Logo
std::vector< ModuleParameterGroup >	ParameterGroups
ModuleProcessInformation	ProcessInformation
std::string	Target
std::string	Title
std::string	Type
std::string	Version

Constructor & Destructor Documentation

ModuleDescription::ModuleDescription ( )

References Acknowledgements, AlternativeLocation, AlternativeTarget, AlternativeType, Category, Contributor, Description, DocumentationURL, Index, License, Location, Target, Title, Type, and Version.

ModuleDescription::ModuleDescription ( const ModuleDescription & md )

References Acknowledgements, AlternativeLocation, AlternativeTarget, AlternativeType, Category, Contributor, Description, DocumentationURL, Index, ModuleProcessInformation::Initialize(), License, Location, Logo, ParameterGroups, ProcessInformation, Target, Title, Type, and Version.

Member Function Documentation

void ModuleDescription::AddParameterGroup ( const ModuleParameterGroup & group ) [inline]

Referenced by endElement(), and GenerateTCLAP().

const std::string& ModuleDescription::GetAcknowledgements ( ) const [inline]

Referenced by vtkCommandLineModuleGUI::BuildGUI(), GenerateTCLAP(), main(), operator<<(), and qSlicerCLIModule::setXmlModuleDescription().

const std::string& ModuleDescription::GetAlternativeLocation ( ) const [inline]

Get the alternative location for the module. This is path to the file (shared object or executable) for a second version of the module (usually a different type from the primary).

Referenced by operator<<().

const std::string& ModuleDescription::GetAlternativeTarget ( ) const [inline]

Get the alternative target for the module. This is the entry for a shared object module and the full command (with path) for an executable. The alternative target is used for a second version of a module (whose type differs from the primary target, executable verses shared object).

Referenced by operator<<().

const std::string& ModuleDescription::GetAlternativeType ( ) const [inline]

Get the type of an alternative version of the module: Unknown, SharedObjectModule, CommandLineModule. The alternative version is usually a different type than the primary version.

Referenced by operator<<().

const std::string& ModuleDescription::GetCategory ( ) const [inline]

Referenced by main(), operator<<(), qSlicerCLIModuleWidget::qSlicerCLIModuleWidget(), vtkCommandLineModuleGUI::SetModuleDescription(), and qSlicerCLIModule::setXmlModuleDescription().

const std::string& ModuleDescription::GetContributor ( ) const [inline]

Referenced by vtkCommandLineModuleGUI::BuildGUI(), GenerateTCLAP(), main(), operator<<(), qSlicerCLIModuleWidget::qSlicerCLIModuleWidget(), and qSlicerCLIModule::setXmlModuleDescription().

const std::string& ModuleDescription::GetDescription ( void ) const [inline]

Referenced by vtkCommandLineModuleGUI::BuildGUI(), GenerateTCLAP(), main(), operator<<(), and qSlicerCLIModule::setXmlModuleDescription().

const std::string& ModuleDescription::GetDocumentationURL ( ) const [inline]

Referenced by vtkCommandLineModuleGUI::BuildGUI(), main(), operator<<(), and qSlicerCLIModule::setXmlModuleDescription().

const std::string& ModuleDescription::GetIndex ( ) const [inline]

Referenced by operator<<().

const std::string& ModuleDescription::GetLicense ( ) const [inline]

Referenced by main(), and operator<<().

const std::string& ModuleDescription::GetLocation ( ) const [inline]

Get the location for the module. This is path to the file (shared object or executable) for the module.

Referenced by vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), GenerateBatchMakeWrapper(), ModuleFactory::GetModuleFromCache(), vtkCommandLineModuleLogic::LazyEvaluateModuleTarget(), operator<<(), ModuleFactory::ScanForCommandLineModulesByExecuting(), ModuleFactory::ScanForCommandLineModulesByPeeking(), ModuleFactory::ScanForPythonModulesByLoading(), and ModuleFactory::ScanForSharedObjectModules().

const ModuleLogo & ModuleDescription::GetLogo ( ) const

References Logo.

Referenced by ModuleFactory::ScanForCommandLineModulesByExecuting(), ModuleFactory::ScanForCommandLineModulesByPeeking(), ModuleFactory::ScanForPythonModulesByLoading(), ModuleFactory::ScanForSharedObjectModules(), and vtkCommandLineModuleGUI::SetModuleDescription().

std::string ModuleDescription::GetParameterDefaultValue ( const std::string & name ) const

References ParameterGroups.

Referenced by vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), vtkCommandLineModuleLogic::FindHiddenNodeID(), vtkSlicerCLIModuleLogic::FindHiddenNodeID(), vtkMRMLCommandLineModuleNode::GetParameterAsString(), and ReadParameterFile().

std::vector<ModuleParameterGroup>& ModuleDescription::GetParameterGroups ( ) [inline]

const std::vector<ModuleParameterGroup>& ModuleDescription::GetParameterGroups ( ) const [inline]

Referenced by vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), vtkCommandLineModuleGUI::BuildGUI(), vtkSlicerParameterWidget::CreateWidgets(), GenerateBatchMakeWrapper(), GenerateEchoArgs(), GenerateTCLAP(), main(), operator<<(), qSlicerCLIModuleWidget::qSlicerCLIModuleWidget(), vtkCommandLineModuleGUI::UpdateGUI(), and vtkMRMLCommandLineModuleNode::WriteXML().

ModuleProcessInformation* ModuleDescription::GetProcessInformation ( ) [inline]

const ModuleProcessInformation* ModuleDescription::GetProcessInformation ( ) const [inline]

Referenced by vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), operator<<(), qSlicerCLIModuleWidget::qSlicerCLIModuleWidget(), qSlicerCLIModule::setXmlModuleDescription(), and vtkCommandLineModuleGUI::UpdateGUI().

const std::string& ModuleDescription::GetTarget ( ) const [inline]

Get the target for the module. This is the entry point for a shared object module and the full command (with path) for an executable.

Referenced by vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), vtkChangeTrackerLogic::DoITKRegistration(), vtkChangeTrackerLogic::DoITKROIRegistration(), ModuleFactory::GetLogoForCommandLineModuleByExecuting(), ModuleFactory::GetModuleFromCache(), vtkCommandLineModuleLogic::LazyEvaluateModuleTarget(), operator<<(), vtkCommandLineModuleGUI::ProcessGUIEvents(), vtkChangeTrackerLogic::ResampleScan2(), ModuleFactory::ScanForCommandLineModulesByExecuting(), ModuleFactory::ScanForCommandLineModulesByPeeking(), ModuleFactory::ScanForPythonModulesByLoading(), and ModuleFactory::ScanForSharedObjectModules().

const std::string& ModuleDescription::GetTitle ( ) const [inline]

Referenced by vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), vtkCommandLineModuleGUI::BuildGUI(), vtkSlicerParameterWidget::CreateWidgets(), GenerateBatchMakeWrapper(), ModuleFactory::GetModuleFromCache(), main(), operator<<(), qSlicerCLIModuleWidget::qSlicerCLIModuleWidget(), vtkMRMLCommandLineModuleNode::RegisterModuleDescription(), ModuleFactory::ScanForCommandLineModulesByExecuting(), ModuleFactory::ScanForCommandLineModulesByPeeking(), ModuleFactory::ScanForPythonModulesByLoading(), ModuleFactory::ScanForSharedObjectModules(), vtkMRMLCommandLineModuleNode::SetModuleDescription(), qSlicerCLIModule::setXmlModuleDescription(), Slicer3_main(), vtkCommandLineModuleGUI::UpdateMRML(), and vtkMRMLCommandLineModuleNode::WriteXML().

const std::string& ModuleDescription::GetType ( ) const [inline]

Get the type of the module: Unknown, SharedObjectModule, CommandLineModule.

Referenced by vtkCommandLineModuleLogic::Apply(), vtkSlicerCLIModuleLogic::Apply(), vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), GenerateBatchMakeWrapper(), ModuleFactory::GetModuleFromCache(), vtkCommandLineModuleLogic::LazyEvaluateModuleTarget(), operator<<(), ModuleFactory::ScanForCommandLineModulesByExecuting(), ModuleFactory::ScanForCommandLineModulesByPeeking(), ModuleFactory::ScanForPythonModulesByLoading(), and ModuleFactory::ScanForSharedObjectModules().

const std::string& ModuleDescription::GetVersion ( ) const [inline]

Referenced by GenerateBatchMakeWrapper(), GenerateTCLAP(), main(), operator<<(), vtkMRMLCommandLineModuleNode::ReadXMLAttributes(), and vtkMRMLCommandLineModuleNode::WriteXML().

bool ModuleDescription::HasParameter ( const std::string & name ) const

References ParameterGroups.

Referenced by vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), vtkCommandLineModuleLogic::FindHiddenNodeID(), vtkSlicerCLIModuleLogic::FindHiddenNodeID(), ReadParameterFile(), and vtkMRMLCommandLineModuleNode::ReadXMLAttributes().

bool ModuleDescription::HasReturnParameters ( ) const

References ParameterGroups.

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

void ModuleDescription::operator= ( const ModuleDescription & md )

References Acknowledgements, AlternativeLocation, AlternativeTarget, AlternativeType, Category, Contributor, Description, DocumentationURL, Index, License, Location, Logo, ParameterGroups, ProcessInformation, Target, Title, Type, and Version.

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

Read a parameter file. Syntax of file is "name: value" for each parameter. Returns a bool indicating whether any parameter value was modified.

References GetParameterDefaultValue(), HasParameter(), slicerget::line, SetParameterDefaultValue(), and trimLeadingAndTrailing().

Referenced by vtkMRMLCommandLineModuleNode::ReadParameterFile().

void ModuleDescription::SetAcknowledgements ( const std::string & acknowledgements ) [inline]

Referenced by endElement().

void ModuleDescription::SetAlternativeLocation ( const std::string & target ) [inline]

Set the alternative location for the module. This is path to the file (shared object or executable) for a second version of the module (usually a different type from the primary).

void ModuleDescription::SetAlternativeTarget ( const std::string & target ) [inline]

Set the alternative target for the module. This is the entry point for a shared object module and the full command (with path) for an executable. The alternative target is used for a second version of a module (whose type differs from the primary target, executable verses shared object).

void ModuleDescription::SetAlternativeType ( const std::string & type ) [inline]

Set the type of an alternative version of the module: Unknown, SharedObjectModule, CommandLineModule. The alternative version is usually a different type than the primary version.

void ModuleDescription::SetCategory ( const std::string & cat ) [inline]

Referenced by endElement().

void ModuleDescription::SetContributor ( const std::string & contributor ) [inline]

Referenced by endElement().

void ModuleDescription::SetDescription ( const std::string & description ) [inline]

Referenced by endElement().

void ModuleDescription::SetDocumentationURL ( const std::string & documentationURL ) [inline]

Referenced by endElement().

void ModuleDescription::SetIndex ( const std::string & ind ) [inline]

Referenced by endElement().

void ModuleDescription::SetLicense ( const std::string & license ) [inline]

Referenced by endElement().

void ModuleDescription::SetLocation ( const std::string & target ) [inline]

Set the location for the module. This is path to the file (shared object or executable) for the module.

Referenced by endElement(), ModuleFactory::GetModuleFromCache(), ModuleFactory::ScanForCommandLineModulesByExecuting(), ModuleFactory::ScanForCommandLineModulesByPeeking(), ModuleFactory::ScanForPythonModulesByLoading(), and ModuleFactory::ScanForSharedObjectModules().

void ModuleDescription::SetLogo ( const ModuleLogo & logo )

References Logo.

Referenced by ModuleFactory::GetLogoForCommandLineModuleByExecuting(), ModuleFactory::GetModuleFromCache(), ModuleFactory::ScanForCommandLineModulesByPeeking(), and ModuleFactory::ScanForSharedObjectModules().

bool ModuleDescription::SetParameterDefaultValue	(	const std::string &	name,
		const std::string &	value
	)

References ParameterGroups.

Referenced by ReadParameterFile(), and vtkMRMLCommandLineModuleNode::ReadXMLAttributes().

void ModuleDescription::SetParameterGroups ( const std::vector< ModuleParameterGroup > & groups ) [inline]

void ModuleDescription::SetTarget ( const std::string & target ) [inline]

Set the target for the module. This is the entry point for a shared object module and the full command (with path) for an executable.

Referenced by ModuleFactory::GetModuleFromCache(), vtkCommandLineModuleLogic::LazyEvaluateModuleTarget(), ModuleFactory::ScanForCommandLineModulesByExecuting(), ModuleFactory::ScanForCommandLineModulesByPeeking(), ModuleFactory::ScanForPythonModulesByLoading(), and ModuleFactory::ScanForSharedObjectModules().

void ModuleDescription::SetTitle ( const std::string & title ) [inline]

Referenced by endElement().

void ModuleDescription::SetType ( const std::string & type ) [inline]

Set the type of module: Unknown, SharedObjectModule, CommandLineModule.

Referenced by ModuleFactory::GetModuleFromCache(), ModuleFactory::ScanForCommandLineModulesByExecuting(), ModuleFactory::ScanForCommandLineModulesByPeeking(), ModuleFactory::ScanForPythonModulesByLoading(), and ModuleFactory::ScanForSharedObjectModules().

void ModuleDescription::SetVersion ( const std::string & version ) [inline]

Referenced by endElement().

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

Write a parameter file. By default, the method writes out all the parameters. The "withHandlesToBulkParameters" parameter controls whether the handles to the bulk parameters (image, geometry, etc.) are writte to the file.

References ParameterGroups.