 |
|
Loading...
Searching...
No Matches
|
|
Executes the defined script. More...
#include <CommandBankUtils.h>
Public Member Functions | |
| void | exec () const |
| Run the command with current parameter values. | |
 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 |
| Returns the class name of this command, like "CmdVerbose". | |
| const std::string & | getDescription () const final |
| virtual const drain::ReferenceMap & | getParameters () const |
| 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. | |
| bool | hasParameters () const |
| virtual void | run (const std::string ¶ms="") final |
| Description of result, comparable to a return type of a function. ? | |
| virtual void | update () |
| Optional method for preparing command to execution. | |
| Command & | addSection (int i) |
| const std::string & | getLastParameters () const |
| virtual void | getRelatedCommands (std::ostream &ostr=std::cout) const |
| 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 |
| void | parameterKeysToStream (std::ostream &ostr, const std::list< std::string > &list, char sep=',') 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. | |
Additional Inherited Members | |
| Public Types inherited from BeanCommand< BeanLike > | |
| typedef BeanLike | bean_t |
| 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 () |
| Public Attributes inherited from BeanCommand< BeanLike > | |
| BeanLike | bean |
| Public Attributes inherited from Command | |
| cmd_section_type | section = 1 |
| Static Public Attributes inherited from Command | |
| static const SprinterLayout | cmdArgLayout = {",", "?", "=", ""} |
| Protected Member Functions inherited from BeanCommand< BeanLike > | |
| virtual drain::ReferenceMap & | getParameters () final |
| Protected Attributes inherited from Command | |
| std::set< std::string > | relatedCommands |
| std::string | lastParameters |
| Protected Attributes inherited from Contextual | |
| Context * | contextPtr |
Executes the defined script.
Actually, this command itself does not execute the script, but is marked with TRIGGER flag which means that after calling the empty Command::exec() the CommandBank automatically runs the actual script.
|
inlinevirtual |
Run the command with current parameter values.
Reimplemented from Command.
1.9.8