cmtk::CommandLine::NonOptionParameterVector Class Reference

Non-option parameter. More...

Inheritance diagram for cmtk::CommandLine::NonOptionParameterVector:

Collaboration diagram for cmtk::CommandLine::NonOptionParameterVector:

List of all members.

Public Types
typedef NonOptionParameterVector	Self
	This class.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer.
typedef Option< std::vector < std::string > >	Superclass
	Superclass.
Public Member Functions
	NonOptionParameterVector (std::vector< std::string > *pvec, const char *name, const char *comment, bool *const flag)
	Constructor.
virtual void	Evaluate (const size_t argc, const char *argv[], size_t &index)
	Evaluate and set associated variable.
virtual mxml_node_t *	MakeXMLWithIndex (mxml_node_t *const parent, const int index) const
	Returns an XML tree describing this parameter.
virtual std::string	GetParamTypeString () const
	Return a textual description of the parameter associated with this option.
virtual std::ostringstream &	PrintHelp (std::ostringstream &fmt) const
	Format additional help information (e.g., default values).
virtual void	PrintWiki () const
	Format additional help information (e.g., default values).
Public Attributes
const char *	m_Name
	Name of this parameter.
const char *	m_Comment
	Comment (description) of this parameter.

---

Detailed Description

Non-option parameter.

Definition at line 629 of file cmtkCommandLine.h.

---

Member Typedef Documentation

typedef NonOptionParameterVector cmtk::CommandLine::NonOptionParameterVector::Self

This class.

Definition at line 635 of file cmtkCommandLine.h.

typedef SmartPointer<Self> cmtk::CommandLine::NonOptionParameterVector::SmartPtr

Smart pointer.

Reimplemented from cmtk::CommandLine::Item.

Definition at line 638 of file cmtkCommandLine.h.

typedef Option< std::vector<std::string> > cmtk::CommandLine::NonOptionParameterVector::Superclass

Superclass.

Definition at line 641 of file cmtkCommandLine.h.

---

Constructor & Destructor Documentation

cmtk::CommandLine::NonOptionParameterVector::NonOptionParameterVector	(	std::vector< std::string > *	pvec,
		const char *	name,
		const char *	comment,
		bool *const	flag
	)		[inline]

Constructor.

Definition at line 644 of file cmtkCommandLine.h.

---

Member Function Documentation

void cmtk::CommandLine::NonOptionParameterVector::Evaluate	(	const size_t	argc,
		const char *	argv[],
		size_t &	index
	)		[virtual]

Evaluate and set associated variable.

Reimplemented from cmtk::CommandLine::Option< std::vector< std::string > >.

Definition at line 37 of file cmtkCommandLineNonOptionParameterVector.cxx.

References cmtk::CommandLine::m_Properties, and cmtk::CommandLine::PROPS_OPTIONAL.

std::string cmtk::CommandLine::NonOptionParameterVector::GetParamTypeString

(

)

const [virtual]

Return a textual description of the parameter associated with this option.

Reimplemented from cmtk::CommandLine::Option< std::vector< std::string > >.

Definition at line 91 of file cmtkCommandLineNonOptionParameterVector.cxx.

mxml_node_t * cmtk::CommandLine::NonOptionParameterVector::MakeXMLWithIndex	(	mxml_node_t *const	parent,
		const int	index
	)		const [virtual]

Returns an XML tree describing this parameter.

Parameters:

parent	Parent in the XML tree for the new node.
index	Running index [0,1,...] of this argument in the argument list.

Definition at line 61 of file cmtkCommandLineNonOptionParameterVector.cxx.

virtual std::ostringstream& cmtk::CommandLine::NonOptionParameterVector::PrintHelp

(

std::ostringstream &

fmt )

const [inline, virtual]

Format additional help information (e.g., default values).

Parameters:

fmt	Stream that the additional help information is formatted into

Reimplemented from cmtk::CommandLine::Option< std::vector< std::string > >.

Definition at line 661 of file cmtkCommandLine.h.

virtual void cmtk::CommandLine::NonOptionParameterVector::PrintWiki

(

)

const [inline, virtual]

Format additional help information (e.g., default values).

Reimplemented from cmtk::CommandLine::Option< std::vector< std::string > >.

Definition at line 679 of file cmtkCommandLine.h.

References cmtk::StdOut.

---

Member Data Documentation

const char* cmtk::CommandLine::NonOptionParameterVector::m_Comment

Comment (description) of this parameter.

Definition at line 698 of file cmtkCommandLine.h.

const char* cmtk::CommandLine::NonOptionParameterVector::m_Name

Name of this parameter.

Definition at line 695 of file cmtkCommandLine.h.

---

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

• libs/System/cmtkCommandLine.h
• libs/System/cmtkCommandLineNonOptionParameterVector.cxx