command::Required Class Reference

#include <required.h>

Inheritance diagram for command::Required:

Collaboration diagram for command::Required:

Public Member Functions
	Required (Parameter *parameter)
virtual	~Required ()
virtual void	handle ()
virtual bool	understand (const std::string &value)
virtual bool	isRequired ()
virtual bool	isUsed ()
virtual unsigned int	valuePosition (const std::string &value)
Public Member Functions inherited from command::Parameter
	Parameter (const std::string &description)
virtual void	handle ()=0
virtual bool	understand (const std::string &)=0
virtual bool	isRequired ()
virtual bool	isUsed ()
virtual bool	hungryForValue ()
virtual unsigned int	valuePosition (const std::string &)=0
Public Member Functions inherited from command::Descriptive
	Descriptive (const std::string &description)
const std::string &	describe ()

Protected Attributes
Parameter *	parameter
Protected Attributes inherited from command::Parameter
bool	used = false

Additional Inherited Members
Public Types inherited from command::Parameter
typedef class Parameter	Type

Detailed Description

Required Parameter decorator. Makes passed Parameters treated as required

Constructor & Destructor Documentation

Required()

command::Required::Required ( Parameter *  parameter )

inline

Default constructor.

Parameters

parameter

Parameter which will be treated as required

~Required()

virtual command::Required::~Required ( )

inlinevirtual

Default destructor. Releases allocated memory

Member Function Documentation

handle()

virtual void command::Required::handle ( )

inlinevirtual

Wrapper method around passed Parameter::handle().

Method used for handling method calls linked with this Parameter

Implements command::Parameter.

isRequired()

virtual bool command::Required::isRequired ( )

inlinevirtual

Indicates if current Parameter is required

Returns

true, as all Parameters wrapped in Required class are set as required. In order to make them non-required do not use Required class

Reimplemented from command::Parameter.

isUsed()

virtual bool command::Required::isUsed ( )

inlinevirtual

Wrapper method around passed Parameter::isUsed().

Indicates if current Parameter has been already used

Returns

true if current Parameter has been already used. False otherwise.

Reimplemented from command::Parameter.

understand()

virtual bool command::Required::understand ( const std::string &  value )

inlinevirtual

Wrapper method around passed Parameter::understand()

Parameters

argv	command line value against which test will be made

Method used for checking if the given user value understandable for parameter.

Returns

true if passed value is understandable by current Parameter. False otherwise.

Implements command::Parameter.

valuePosition()

virtual unsigned int command::Required::valuePosition ( const std::string &  value )

inlinevirtual

Wrapper method around passed Parameter::valuePosition().

Returns

position where value starts in passed string

Implements command::Parameter.

Member Data Documentation

parameter

Parameter* command::Required::parameter

protected

Parameter which will be treated as required

---

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

• /home/rafal/prj/dlugolecki/command/include/required.h