BeanCommand< B, B2 > Class Template Reference

Retrieves bean dynamically for each call. More...

#include <Command.h>

Inheritance diagram for BeanCommand< B, B2 >:

Collaboration diagram for BeanCommand< B, B2 >:

Public Types
typedef B	bean_t
Public Types inherited from Command
typedef int	cmd_section_type

Public Member Functions
	BeanCommand (const std::string &name, const std::string &description)
	BeanCommand (const BeanCommand &cmd)
	BeanCommand (B &b)
virtual const bean_t &	getBean () const
virtual bean_t &	getBean ()
const std::string &	getName () const final
const std::string &	getDescription () const final
virtual const drain::ReferenceMap &	getParameters () const final
Public Member Functions inherited from Command
	Command (const Command &cmd)
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
B2	bean
Public Attributes inherited from Command
cmd_section_type	section = 1

Protected Member Functions
virtual drain::ReferenceMap &	getParameters () final

Additional Inherited Members
Static Public Member Functions inherited from Contextual
template<class T >
static Cloner< Context, T > &	getCloner ()
Static Public Attributes inherited from Command
static const SprinterLayout	cmdArgLayout = {",", "?", "=", ""}
Protected Attributes inherited from Command
std::string	lastParameters
Protected Attributes inherited from Contextual
Context *	contextPtr

Detailed Description

template<class B, class B2 = B>
class drain::BeanCommand< B, B2 >

Retrieves bean dynamically for each call.

Base for derived classes using member BeanLike or referenced BeanLikes. Beans implement getName(), getDescription(), getParameters()

Template Parameters

B	- bean class
BS	- same as B, or reference of B

---

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

• src/drain/prog/Command.h