Command  0.3
Public Member Functions | List of all members
command::Command Class Reference

#include <command.h>

Inheritance diagram for command::Command:
[legend]
Collaboration diagram for command::Command:
[legend]

Public Member Functions

 Command (unsigned int argc, char *argv[], std::initializer_list< Parameter * > params)
 
 ~Command ()
 

Additional Inherited Members

- Protected Types inherited from command::Parameter
typedef class Parameter Type
 
- Protected Member Functions inherited from command::Grouped
 Grouped (std::initializer_list< Parameter * > params, std::string description="Grouped")
 
virtual ~Grouped ()
 
virtual void handle ()
 
virtual bool understand (const std::string &value)
 
virtual bool hungryForValue ()
 
virtual unsigned int valuePosition (const std::string &)
 
void releaseMemory ()
 
- Protected 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
 
- Protected Member Functions inherited from command::Descriptive
 Descriptive (const std::string &description)
 
const std::string & describe ()
 
- Protected Attributes inherited from command::Grouped
std::vector< Parameter * > parameters
 
std::vector< std::string > values
 
std::vector< bool > understood
 
std::vector< bool > all_used
 
- Protected Attributes inherited from command::Parameter
bool used = false
 

Detailed Description

Main class for handling user passed parameters from command line.

Constructor & Destructor Documentation

◆ Command()

command::Command::Command ( unsigned int  argc,
char *  argv[],
std::initializer_list< Parameter * >  params 
)
inline

Default constructor.

Parameters
argcfrom the main function
argvfrom the main function
paramsinitializer_list containing Parameter handlers responsible for correctly handle user data.

◆ ~Command()

command::Command::~Command ( )
inline

Destructor. Releases allocated memory.


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