Command Class Reference

Base class for commands: typically actions taking parameters but also plain variable assignments and parameterless actions. More...

#include <Command.h>

Inheritance diagram for Command:

Collaboration diagram for Command:

Public Types
typedef int	cmd_section_type

Public Member Functions
	Command (const Command &cmd)
virtual const std::string &	getName () const =0
virtual const std::string &	getDescription () const =0
virtual const ReferenceMap &	getParameters () const =0
virtual void	setParameters (const std::string &args) final
template<class T >
void	setParameters (const T &args)
template<class T >
void	setParameter (const std::string &key, const T &value)
	Set a value to a single parameter. More...
bool	hasParameters () const
virtual const std::string &	getType () const
	Description of result, comparable to a return type of a function. ?
virtual void	run (const std::string &params="") final
	Convenience. Sets parameters and executes the command. More...
virtual void	update ()
	Optional method for preparing command to execution. More...
virtual void	exec () const
	Run the command with current parameter values.
Command &	addSection (int i)
const std::string &	getLastParameters () const
Public Member Functions inherited from Contextual
	Contextual ()
	Sets internal contextPtr to NULL.
	Contextual (const Contextual &src)
	Copies base context (even null) of the source. Notice that the actual instance may be of derived class.
	Contextual (Context &ctx)
	Copies internal contextPtr.
template<class C >
void	setContext ()
	Sets internal contextPtr to the static source.
void	setExternalContext (Context &ctx)
	Sets internal contextPtr to outside target.
bool	contextIsSet () const
	True, if contextPtr has been set.
template<class T = Context>
T &	getContext () const
	If context has been set, returns it through a cast to base class Context. More...

Public Attributes
cmd_section_type	section = 1

Static Public Attributes
static const SprinterLayout	cmdArgLayout = {",", "?", "=", ""}

Protected Member Functions
virtual ReferenceMap &	getParameters ()=0

Protected Attributes
std::string	lastParameters
Protected Attributes inherited from Contextual
Context *	contextPtr

Additional Inherited Members
Static Public Member Functions inherited from Contextual
template<class T >
static Cloner< Context, T > &	getCloner ()

Detailed Description

Base class for commands: typically actions taking parameters but also plain variable assignments and parameterless actions.

Member Typedef Documentation

cmd_section_type

typedef int cmd_section_type

Typically, zero section is for "hidden" commands not appearing in help dumps.

Member Function Documentation

run()

virtual void run ( const std::string &  params = "" )

inlinefinalvirtual

Convenience. Sets parameters and executes the command.

See also

exec() .

setParameter()

void setParameter ( const std::string &  key, const T &  value  )

inline

Set a value to a single parameter.

This method also assigns "<key>=<value>" to lastParameters

update()

virtual void update ( )

inlinevirtual

Optional method for preparing command to execution.

This function will be called prior to running exec()

Reimplemented in ProductCommand< OP >, DetectorCommand< OP >, and AnDReCommand< OP >.

---

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

• src/drain/prog/Command.h
• src/drain/prog/Command.cpp