ModuleParameter Class Reference

Class to describe a single parameter to a module. More...

#include <ModuleParameter.h>

List of all members.

Public Member Functions

virtual const std::string & GetAggregate () const
virtual const std::string & GetArgType () const
virtual const std::string & GetChannel () const
virtual const std::string & GetConstraints () const
virtual const std::string & GetCoordinateSystem () const
virtual const std::string & GetCPPType () const
virtual const std::string & GetDefault () const
virtual const std::vector
< std::string > & 		GetDeprecatedFlagAliases () const
virtual const std::string & GetDeprecatedFlagAliasesAsString () const
virtual const std::vector
< std::string > & 		GetDeprecatedLongFlagAliases () const
virtual const std::string & GetDeprecatedLongFlagAliasesAsString () const
virtual const std::string & GetDescription () const
virtual std::vector
< std::string > & 		GetElements ()
virtual const std::vector
< std::string > & 		GetElements () const
virtual const std::vector
< std::string > & 		GetFileExtensions () const
virtual const std::string & GetFileExtensionsAsString () const
virtual const std::string & GetFlag () const
virtual const std::vector
< std::string > & 		GetFlagAliases () const
virtual const std::string & GetFlagAliasesAsString () const
virtual const std::string & GetHidden () const
virtual const std::string & GetIndex () const
virtual const std::string & GetLabel () const
virtual const std::string & GetLongFlag () const
virtual const std::vector
< std::string > & 		GetLongFlagAliases () const
virtual const std::string & GetLongFlagAliasesAsString () const
virtual const std::string & GetMaximum () const
virtual const std::string & GetMinimum () const
virtual const std::string & GetMultiple () const
virtual const std::string & GetName () const
virtual const std::string & GetReference () const
virtual const std::string & GetStep () const
virtual const std::string & GetStringToType () const
virtual const std::string & GetTag () const
virtual const std::string & GetType () const
virtual bool IsFlagParameter () const
virtual bool IsIndexParameter () const
virtual bool IsReturnParameter () const
 ModuleParameter (const ModuleParameter &parameter)
 ModuleParameter ()
void operator= (const ModuleParameter &parameter)
virtual void SetAggregate (const std::string &aggregate)
virtual void SetArgType (const std::string &argType)
virtual void SetChannel (const std::string &channel)
virtual void SetConstraints (const std::string &constraints)
virtual void SetCoordinateSystem (const std::string &coordinateSystem)
virtual void SetCPPType (const std::string &type)
virtual void SetDefault (const std::string &def)
virtual void SetDeprecatedFlagAliasesAsString (const std::string &aliases)
virtual void SetDeprecatedLongFlagAliasesAsString (const std::string &aliases)
virtual void SetDescription (const std::string &description)
virtual void SetFileExtensionsAsString (const std::string &extensions)
virtual void SetFlag (const std::string &flag)
virtual void SetFlagAliasesAsString (const std::string &aliases)
virtual void SetHidden (const std::string &hidden)
virtual void SetIndex (const std::string &index)
virtual void SetLabel (const std::string &label)
virtual void SetLongFlag (const std::string &longFlag)
virtual void SetLongFlagAliasesAsString (const std::string &aliases)
virtual void SetMaximum (const std::string &maximum)
virtual void SetMinimum (const std::string &minimum)
virtual void SetMultiple (const std::string &multiple)
virtual void SetName (const std::string &name)
virtual void SetReference (const std::string &ref)
virtual void SetStep (const std::string &step)
virtual void SetStringToType (const std::string &stringToType)
virtual void SetTag (const std::string &tag)
virtual void SetType (const std::string &type)
virtual ~ModuleParameter ()

Private Attributes

std::string Aggregate
std::string ArgType
std::string Channel
std::string Constraints
std::string CoordinateSystem
std::string CPPType
std::string Default
std::vector< std::string > DeprecatedFlagAliases
std::string DeprecatedFlagAliasesAsString
std::vector< std::string > DeprecatedLongFlagAliases
std::string DeprecatedLongFlagAliasesAsString
std::string Description
std::vector< std::string > Elements
std::vector< std::string > FileExtensions
std::string FileExtensionsAsString
std::string Flag
std::vector< std::string > FlagAliases
std::string FlagAliasesAsString
std::string Hidden
std::string Index
std::string Label
std::string LongFlag
std::vector< std::string > LongFlagAliases
std::string LongFlagAliasesAsString
std::string Maximum
std::string Minimum
std::string Multiple
std::string Name
std::string Reference
std::string Step
std::string StringToType
std::string Tag
std::string Type

Detailed Description

Class to describe a single parameter to a module.

ModuleParameter describes a single parameters to a module. Information on the parameter type, name, flag, label, description, channel, index, default, and constraints can be stored.

Constructor & Destructor Documentation

ModuleParameter::ModuleParameter (  ) 

References Aggregate, ArgType, Channel, Constraints, CoordinateSystem, CPPType, Default, DeprecatedFlagAliasesAsString, DeprecatedLongFlagAliasesAsString, Description, FileExtensionsAsString, Flag, FlagAliasesAsString, Hidden, Index, Label, LongFlag, LongFlagAliasesAsString, Maximum, Minimum, Multiple, Name, Reference, Step, StringToType, Tag, and Type.

virtual ModuleParameter::~ModuleParameter (  )  [inline, virtual]
ModuleParameter::ModuleParameter ( const ModuleParameter &  parameter  ) 

References Aggregate, ArgType, Channel, Constraints, CoordinateSystem, CPPType, Default, DeprecatedFlagAliases, DeprecatedFlagAliasesAsString, DeprecatedLongFlagAliases, DeprecatedLongFlagAliasesAsString, Description, Elements, FileExtensions, FileExtensionsAsString, Flag, FlagAliases, FlagAliasesAsString, Hidden, Index, Label, LongFlag, LongFlagAliases, LongFlagAliasesAsString, Maximum, Minimum, Multiple, Name, Reference, Step, StringToType, Tag, and Type.

Member Function Documentation

virtual const std::string& ModuleParameter::GetAggregate (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::createGeometryTagWidget(), operator<<(), and startElement().

virtual const std::string& ModuleParameter::GetArgType (  )  const [inline, virtual]

Referenced by operator<<().

virtual const std::string& ModuleParameter::GetChannel (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::createGeometryTagWidget(), qSlicerCLIModuleWidgetPrivate::createImageTagWidget(), qSlicerCLIModuleWidgetPrivate::createTableTagWidget(), qSlicerCLIModuleWidgetPrivate::createTransformTagWidget(), and operator<<().

virtual const std::string& ModuleParameter::GetConstraints (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::createDoubleTagWidget(), qSlicerCLIModuleWidgetPrivate::createFloatTagWidget(), qSlicerCLIModuleWidgetPrivate::createIntegerTagWidget(), and operator<<().

virtual const std::string& ModuleParameter::GetCoordinateSystem (  )  const [inline, virtual]

Referenced by operator<<().

virtual const std::string& ModuleParameter::GetCPPType (  )  const [inline, virtual]

Referenced by IsVectorOfVectors(), NeedsQuotes(), NeedsTemp(), and operator<<().

virtual const std::string& ModuleParameter::GetDefault (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::createBooleanTagWidget(), qSlicerCLIModuleWidgetPrivate::createDoubleTagWidget(), qSlicerCLIModuleWidgetPrivate::createEnumerationTagWidget(), qSlicerCLIModuleWidgetPrivate::createFloatTagWidget(), qSlicerCLIModuleWidgetPrivate::createIntegerTagWidget(), qSlicerCLIModuleWidgetPrivate::createStringTagWidget(), vtkCommandLineModuleLogic::FindHiddenNodeID(), vtkSlicerCLIModuleLogic::FindHiddenNodeID(), HasDefault(), operator<<(), and vtkSlicerParameterWidget::UpdateMRMLForWidget().

virtual const std::vector<std::string>& ModuleParameter::GetDeprecatedFlagAliases (  )  const [inline, virtual]

Referenced by operator<<().

virtual const std::string& ModuleParameter::GetDeprecatedFlagAliasesAsString (  )  const [inline, virtual]

Referenced by operator<<().

virtual const std::vector<std::string>& ModuleParameter::GetDeprecatedLongFlagAliases (  )  const [inline, virtual]

Referenced by operator<<().

virtual const std::string& ModuleParameter::GetDeprecatedLongFlagAliasesAsString (  )  const [inline, virtual]

Referenced by operator<<().

virtual const std::string& ModuleParameter::GetDescription ( void   )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::addParameter(), and operator<<().

virtual std::vector<std::string>& ModuleParameter::GetElements (  )  [inline, virtual]
virtual const std::vector<std::string>& ModuleParameter::GetElements (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::createEnumerationTagWidget(), endElement(), and operator<<().

const std::vector< std::string > & ModuleParameter::GetFileExtensions (  )  const [virtual]

References FileExtensions.

Referenced by operator<<().

virtual const std::string& ModuleParameter::GetFileExtensionsAsString (  )  const [inline, virtual]

Referenced by operator<<().

virtual const std::string& ModuleParameter::GetFlag (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::addParameter(), endElement(), and operator<<().

virtual const std::vector<std::string>& ModuleParameter::GetFlagAliases (  )  const [inline, virtual]

Referenced by operator<<().

virtual const std::string& ModuleParameter::GetFlagAliasesAsString (  )  const [inline, virtual]

Referenced by operator<<().

virtual const std::string& ModuleParameter::GetHidden (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::addParameter(), vtkCommandLineModuleLogic::FindHiddenNodeID(), vtkSlicerCLIModuleLogic::FindHiddenNodeID(), and operator<<().

virtual const std::string& ModuleParameter::GetIndex (  )  const [inline, virtual]

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

virtual const std::string& ModuleParameter::GetLabel (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::addParameter(), qSlicerCLIModuleWidgetPrivate::createBooleanTagWidget(), qSlicerCLIModuleWidgetPrivate::createDoubleTagWidget(), qSlicerCLIModuleWidgetPrivate::createEnumerationTagWidget(), qSlicerCLIModuleWidgetPrivate::createFloatTagWidget(), qSlicerCLIModuleWidgetPrivate::createGeometryTagWidget(), qSlicerCLIModuleWidgetPrivate::createImageTagWidget(), qSlicerCLIModuleWidgetPrivate::createIntegerTagWidget(), qSlicerCLIModuleWidgetPrivate::createPointTagWidget(), qSlicerCLIModuleWidgetPrivate::createRegionTagWidget(), qSlicerCLIModuleWidgetPrivate::createStringTagWidget(), qSlicerCLIModuleWidgetPrivate::createTableTagWidget(), qSlicerCLIModuleWidgetPrivate::createTransformTagWidget(), and operator<<().

virtual const std::string& ModuleParameter::GetLongFlag (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::addParameter(), endElement(), and operator<<().

virtual const std::vector<std::string>& ModuleParameter::GetLongFlagAliases (  )  const [inline, virtual]

Referenced by operator<<().

virtual const std::string& ModuleParameter::GetLongFlagAliasesAsString (  )  const [inline, virtual]

Referenced by operator<<().

virtual const std::string& ModuleParameter::GetMaximum (  )  const [inline, virtual]

References Maximum().

Referenced by qSlicerCLIModuleWidgetPrivate::createIntegerTagWidget(), and operator<<().

virtual const std::string& ModuleParameter::GetMinimum (  )  const [inline, virtual]

References Minimum().

Referenced by qSlicerCLIModuleWidgetPrivate::createIntegerTagWidget(), and operator<<().

virtual const std::string& ModuleParameter::GetMultiple (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::createGeometryTagWidget(), HasDefault(), NeedsQuotes(), NeedsTemp(), operator<<(), and startElement().

virtual const std::string& ModuleParameter::GetName (  )  const [inline, virtual]

Referenced by endElement(), vtkCommandLineModuleLogic::FindHiddenNodeID(), vtkSlicerCLIModuleLogic::FindHiddenNodeID(), operator<<(), and vtkSlicerParameterWidget::UpdateMRMLForWidget().

virtual const std::string& ModuleParameter::GetReference (  )  const [inline, virtual]

Referenced by vtkCommandLineModuleLogic::FindHiddenNodeID(), vtkSlicerCLIModuleLogic::FindHiddenNodeID(), and operator<<().

virtual const std::string& ModuleParameter::GetStep (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::createIntegerTagWidget(), and operator<<().

virtual const std::string& ModuleParameter::GetStringToType (  )  const [inline, virtual]

Referenced by operator<<().

virtual const std::string& ModuleParameter::GetTag (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::addParameter(), vtkCommandLineModuleLogic::FindHiddenNodeID(), vtkSlicerCLIModuleLogic::FindHiddenNodeID(), IsEnumeration(), and operator<<().

virtual const std::string& ModuleParameter::GetType (  )  const [inline, virtual]

Referenced by qSlicerCLIModuleWidgetPrivate::createGeometryTagWidget(), qSlicerCLIModuleWidgetPrivate::createImageTagWidget(), qSlicerCLIModuleWidgetPrivate::createTableTagWidget(), qSlicerCLIModuleWidgetPrivate::createTransformTagWidget(), vtkCommandLineModuleLogic::FindHiddenNodeID(), vtkSlicerCLIModuleLogic::FindHiddenNodeID(), and operator<<().

virtual bool ModuleParameter::IsFlagParameter (  )  const [inline, virtual]
virtual bool ModuleParameter::IsIndexParameter (  )  const [inline, virtual]
virtual bool ModuleParameter::IsReturnParameter (  )  const [inline, virtual]
void ModuleParameter::operator= ( const ModuleParameter &  parameter  ) 

References Aggregate, ArgType, Channel, Constraints, CoordinateSystem, CPPType, Default, DeprecatedFlagAliases, DeprecatedFlagAliasesAsString, DeprecatedLongFlagAliases, DeprecatedLongFlagAliasesAsString, Description, Elements, FileExtensions, FileExtensionsAsString, Flag, FlagAliases, FlagAliasesAsString, Hidden, Index, Label, LongFlag, LongFlagAliases, LongFlagAliasesAsString, Maximum, Minimum, Multiple, Name, Reference, Step, StringToType, Tag, and Type.

virtual void ModuleParameter::SetAggregate ( const std::string &  aggregate  )  [inline, virtual]

Referenced by startElement().

virtual void ModuleParameter::SetArgType ( const std::string &  argType  )  [inline, virtual]

Referenced by startElement().

virtual void ModuleParameter::SetChannel ( const std::string &  channel  )  [inline, virtual]

Referenced by endElement().

virtual void ModuleParameter::SetConstraints ( const std::string &  constraints  )  [inline, virtual]

Referenced by endElement().

virtual void ModuleParameter::SetCoordinateSystem ( const std::string &  coordinateSystem  )  [inline, virtual]

Referenced by startElement().

virtual void ModuleParameter::SetCPPType ( const std::string &  type  )  [inline, virtual]

Referenced by GenerateTCLAP(), and startElement().

virtual void ModuleParameter::SetDefault ( const std::string &  def  )  [inline, virtual]

Referenced by endElement(), and GenerateTCLAP().

void ModuleParameter::SetDeprecatedFlagAliasesAsString ( const std::string &  aliases  )  [virtual]

References DeprecatedFlagAliases, DeprecatedFlagAliasesAsString, and splitString().

Referenced by startElement().

void ModuleParameter::SetDeprecatedLongFlagAliasesAsString ( const std::string &  aliases  )  [virtual]

References DeprecatedLongFlagAliases, DeprecatedLongFlagAliasesAsString, and splitString().

Referenced by startElement().

virtual void ModuleParameter::SetDescription ( const std::string &  description  )  [inline, virtual]

Referenced by endElement(), and GenerateTCLAP().

void ModuleParameter::SetFileExtensionsAsString ( const std::string &  extensions  )  [virtual]

References FileExtensions, FileExtensionsAsString, and splitString().

Referenced by startElement().

virtual void ModuleParameter::SetFlag ( const std::string &  flag  )  [inline, virtual]

Referenced by endElement().

void ModuleParameter::SetFlagAliasesAsString ( const std::string &  aliases  )  [virtual]

References FlagAliases, FlagAliasesAsString, and splitString().

Referenced by startElement().

virtual void ModuleParameter::SetHidden ( const std::string &  hidden  )  [inline, virtual]

Referenced by startElement().

virtual void ModuleParameter::SetIndex ( const std::string &  index  )  [inline, virtual]

Referenced by endElement().

virtual void ModuleParameter::SetLabel ( const std::string &  label  )  [inline, virtual]

Referenced by endElement().

virtual void ModuleParameter::SetLongFlag ( const std::string &  longFlag  )  [inline, virtual]

Referenced by endElement(), and GenerateTCLAP().

void ModuleParameter::SetLongFlagAliasesAsString ( const std::string &  aliases  )  [virtual]

References LongFlagAliases, LongFlagAliasesAsString, and splitString().

Referenced by startElement().

virtual void ModuleParameter::SetMaximum ( const std::string &  maximum  )  [inline, virtual]

References Maximum().

Referenced by endElement().

virtual void ModuleParameter::SetMinimum ( const std::string &  minimum  )  [inline, virtual]

References Minimum().

Referenced by endElement().

virtual void ModuleParameter::SetMultiple ( const std::string &  multiple  )  [inline, virtual]

Referenced by startElement().

virtual void ModuleParameter::SetName ( const std::string &  name  )  [inline, virtual]

Referenced by endElement(), and GenerateTCLAP().

virtual void ModuleParameter::SetReference ( const std::string &  ref  )  [inline, virtual]

Referenced by startElement().

virtual void ModuleParameter::SetStep ( const std::string &  step  )  [inline, virtual]

Referenced by endElement().

virtual void ModuleParameter::SetStringToType ( const std::string &  stringToType  )  [inline, virtual]

Referenced by startElement().

virtual void ModuleParameter::SetTag ( const std::string &  tag  )  [inline, virtual]

Referenced by GenerateTCLAP(), and startElement().

virtual void ModuleParameter::SetType ( const std::string &  type  )  [inline, virtual]

Referenced by startElement().

Member Data Documentation

std::string ModuleParameter::Aggregate [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::ArgType [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::Channel [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::Constraints [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::CoordinateSystem [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::CPPType [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::Default [private]

Referenced by ModuleParameter(), and operator=().

std::vector<std::string> ModuleParameter::DeprecatedFlagAliases [private]

Referenced by ModuleParameter(), operator=(), and SetDeprecatedFlagAliasesAsString().

std::string ModuleParameter::DeprecatedFlagAliasesAsString [private]

Referenced by ModuleParameter(), operator=(), and SetDeprecatedFlagAliasesAsString().

std::vector<std::string> ModuleParameter::DeprecatedLongFlagAliases [private]

Referenced by ModuleParameter(), operator=(), and SetDeprecatedLongFlagAliasesAsString().

std::string ModuleParameter::DeprecatedLongFlagAliasesAsString [private]

Referenced by ModuleParameter(), operator=(), and SetDeprecatedLongFlagAliasesAsString().

std::string ModuleParameter::Description [private]

Referenced by ModuleParameter(), and operator=().

std::vector<std::string> ModuleParameter::Elements [private]

Referenced by ModuleParameter(), and operator=().

std::vector<std::string> ModuleParameter::FileExtensions [mutable, private]

Referenced by GetFileExtensions(), ModuleParameter(), operator=(), and SetFileExtensionsAsString().

std::string ModuleParameter::FileExtensionsAsString [private]

Referenced by ModuleParameter(), operator=(), and SetFileExtensionsAsString().

std::string ModuleParameter::Flag [private]

Referenced by ModuleParameter(), and operator=().

std::vector<std::string> ModuleParameter::FlagAliases [private]

Referenced by ModuleParameter(), operator=(), and SetFlagAliasesAsString().

std::string ModuleParameter::FlagAliasesAsString [private]

Referenced by ModuleParameter(), operator=(), and SetFlagAliasesAsString().

std::string ModuleParameter::Hidden [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::Index [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::Label [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::LongFlag [private]

Referenced by ModuleParameter(), and operator=().

std::vector<std::string> ModuleParameter::LongFlagAliases [private]

Referenced by ModuleParameter(), operator=(), and SetLongFlagAliasesAsString().

std::string ModuleParameter::LongFlagAliasesAsString [private]

Referenced by ModuleParameter(), operator=(), and SetLongFlagAliasesAsString().

std::string ModuleParameter::Maximum [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::Minimum [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::Multiple [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::Name [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::Reference [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::Step [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::StringToType [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::Tag [private]

Referenced by ModuleParameter(), and operator=().

std::string ModuleParameter::Type [private]

Referenced by ModuleParameter(), and operator=().

The documentation for this class was generated from the following files:
Generated on 6 Apr 2011 for Slicer3 by  doxygen 1.6.1