CmdScript Class Reference

Load script file and executes the commands immediately. More...

#include <CommandBankUtils.h>

Inheritance diagram for CmdScript:

Collaboration diagram for CmdScript:

Public Member Functions
	CmdScript (CommandBank &cmdBank)
	CmdScript (const CmdScript &cmd)
Public Member Functions inherited from SimpleCommand< std::string >
	SimpleCommand (const std::string &name, const std::string &description, const std::string &key="value", const std::string &initValue=std::string(), const std::string &unit="")
	SimpleCommand (const std::string &name, const std::string &description, const std::string &key, std::initializer_list< S > l, const std::string &unit="")
	Constuctor designer for SimpleCommand<Unituple<> > .
	SimpleCommand (const SimpleCommand &cmd)
Public Member Functions inherited from BasicCommand
	BasicCommand (const std::string &name, const std::string &description)
	BasicCommand (const BasicCommand &cmd)
Public Member Functions inherited from BeanCommand< BeanLike >
	BeanCommand (const std::string &name, const std::string &description)
	BeanCommand (const BeanCommand &cmd)
	BeanCommand (BeanLike &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 SmartMap< T > &args)
template<class T >
void	setParameter (const std::string &key, const T &value)
	Set a value to a single parameter. More...
Command &	addSection (drain::Flagger::ivalue_t i)
virtual void	update ()
	Optional method for preparing command to execution. More...
bool	hasParameters () const
virtual const std::string &	getType () const
	Description of result, comparable to a return type of a function. ?
virtual void	exec () const
	Run the command with current parameter values.
virtual void	run (const std::string &params="")
	Convenience. Sets parameters and executes the command. More...
const std::string &	getLastParameters () const
	After executing this command run a routine, if defined. More...
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...

Protected Attributes
CommandBank &	bank
Protected Attributes inherited from Command
std::string	lastParameters
Protected Attributes inherited from Contextual
Context *	contextPtr

Additional Inherited Members
Public Types inherited from BeanCommand< BeanLike >
typedef BeanLike	bean_t
Static Public Member Functions inherited from Contextual
template<class T >
static Cloner< Context, T > &	getCloner ()
Public Attributes inherited from SimpleCommand< std::string >
std::string	value
Public Attributes inherited from BeanCommand< BeanLike >
BeanLike	bean
Public Attributes inherited from Command
int	section = 1
Static Public Attributes inherited from Command
static const SprinterLayout	cmdArgLayout = {",", "?", "=", ""}
Protected Member Functions inherited from BeanCommand< BeanLike >
virtual drain::ReferenceMap &	getParameters () final

Detailed Description

Load script file and executes the commands immediately.

Lightweight. Keeps commands until commandBank reads and stores them.

---

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

• src/drain/prog/CommandBankUtils.h