BasicCommand Class Reference

Simple implementation of Command: adds name , description and parameters . More...

#include <Command.h>

Inherits BeanCommand< BeanLike >.

Inherited by SimpleCommand< std::string >, SimpleCommand< int >, SimpleCommand< float >, SimpleCommand< bool >, SimpleCommand< double >, SimpleCommand< drain::Point2D< double >::tuple_t >, Deprecator< CmdOutputPalette >, CmdDebug, CmdExecScript, CmdExpandVariables, CmdLog, CmdStatus, SimpleCommand< T >, CartesianBBox, CartesianBBoxReset, CartesianBBoxTest, CartesianBBoxTile, CartesianCreateLookup, CartesianGrid, CartesianInit, CartesianPlot, CartesianRange, CartesianReset, CartesianSize, CartesianSpread, CmdAlign, CmdAlignTest, CmdAppend, CmdBaseSelective, CmdCheckType, CmdCompleteODIM, CmdConvert, CmdCreateDefaultQuality, CmdDebug, CmdDumpMap, CmdEncoding, CmdGeoTiff, CmdHistogram, CmdImage, CmdImageAlphaBase, CmdImageQuality, CmdLayout, CmdModifyQuality, CmdMove, CmdPaletteConf, CmdPaletteDefault, CmdPolarBase, CmdPolarSelect, CmdPython, CmdQuantityConf, CmdSweep, CmdTest2, CmdTestSelect, CmdTitle, CmdUpdateVariables, CmdVersion, Compositor, Deprecator< C >, PolarAdd, PolarPlot, UndetectWeight, and VerboseCmd.

Collaboration diagram for BasicCommand:

Public Member Functions
	BasicCommand (const std::string &name, const std::string &description)
	Constructor.
	BasicCommand (const BasicCommand &cmd)
	Copy constructor.
Public Member Functions inherited from BeanCommand< BeanLike >
	BeanCommand (const std::string &name, const std::string &description)
	Constructor.
	BeanCommand (const BeanCommand &cmd)
	Copy constructor.
	BeanCommand (BeanLike &b)
	Constructor wrapping an existing bean.
virtual const bean_t &	getBean () const
	Returns the wrapped bean.
virtual bean_t &	getBean ()
	Returns the wrapped bean.
const std::string &	getName () const final
	Returns the command name.
const std::string &	getDescription () const final
	Returns the command description.
virtual const drain::ReferenceMap &	getParameters () const
	Returns the command parameters.
Public Member Functions inherited from Command
	Command (const Command &cmd)
	Copy constructor.
virtual void	setParameters (const std::string &args) final
template<class T >
void	setParameters (const T &args)
	Sets parameters from argument.
template<class T >
void	setParameter (const std::string &key, const T &value)
	Set a value to a single parameter.
bool	hasParameters () const
	Returns true if this command has parameters.
virtual void	run (const std::string &params="") final
	Description of result, comparable to a return type of a function. ?
virtual void	update ()
	Optional method for preparing command to execution.
virtual void	exec () const
	Run the command with current parameter values.
Command &	addSection (int i)
	Marks this command as belonging to section i.
const std::string &	getLastParameters () const
	Returns the parameters from the last execution.
virtual void	getRelatedCommands (std::ostream &ostr=std::cout) const
	Writes related command names to stream.
void	linkRelated (const std::string &cmdKey) const
	Add related command(s), to appear in help after "See-also:" phrase.
virtual void	parametersToStream (std::ostream &ostr, const std::string &indent=" ") const
	By default, the "true", technical parameters.
virtual void	parameterKeysToStream (std::ostream &ostr) const
	Writes parameter keys to stream.
void	parameterKeysToStream (std::ostream &ostr, const std::list< std::string > &list, char sep=',') const
	Writes parameter keys to stream.
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.

Additional Inherited Members
Public Types inherited from BeanCommand< BeanLike >
typedef BeanLike	bean_t
	The bean type.
Public Types inherited from Command
typedef int	cmd_section_type
Static Public Member Functions inherited from Contextual
template<class T >
static Cloner< Context, T > &	getCloner ()
	Returns the object cloner.
Public Attributes inherited from BeanCommand< BeanLike >
BeanLike	bean
	The wrapped bean instance.
Public Attributes inherited from Command
cmd_section_type	section = 1
	Section bitmask; zero means hidden from help.
Static Public Attributes inherited from Command
static const SprinterLayout	cmdArgLayout = {",", "?", "=", ""}
	Layout flag for command argument handling.
Protected Member Functions inherited from BeanCommand< BeanLike >
virtual drain::ReferenceMap &	getParameters () final
Protected Attributes inherited from Command
std::set< std::string >	relatedCommands
	Set of related command keys shown in help.
std::string	lastParameters
	String record of the last argument(s) passed.
Protected Attributes inherited from Contextual
Context *	contextPtr
	Pointer to the current context; nullptr if not set.

Detailed Description

Simple implementation of Command: adds name , description and parameters .

Wrapper for simple template classes; no member functions are required. BasicDrainLet implements getDescription(), getParameters(), setParameters(). The default implementation of run() calls setParameters() and exec(). The default implementation exec() does nothing, it should be redefined in derived classes.

---

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

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