Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
dynamicgraph::command::CommandVerbose< E > Struct Template Reference

#include <command-bind.h>

Inheritance diagram for dynamicgraph::command::CommandVerbose< E >:
Inheritance graph
[legend]

Public Types

typedef boost::function< void(std::ostream &)> function_t
 

Public Member Functions

 CommandVerbose (E &entity, function_t function, const std::string &docString)
 
- Public Member Functions inherited from dynamicgraph::command::Command
 Command (Entity &entity, const std::vector< Value::Type > &valueTypes, const std::string &docstring)
 
Value execute ()
 Execute the command after checking parameters. More...
 
std::string getDocstring () const
 Get documentation string. More...
 
const std::vector< Value > & getParameterValues () const
 Get parameter values. More...
 
Entityowner ()
 Get a reference to the Entity owning this command. More...
 
void setParameterValues (const std::vector< Value > &values)
 Set parameter values. More...
 
const std::vector< Value::Type > & valueTypes () const
 Return the value type of all parameters. More...
 
virtual ~Command ()
 

Protected Member Functions

virtual Value doExecute ()
 Specific action performed by the command. More...
 

Private Attributes

function_t fptr
 

Additional Inherited Members

- Static Public Attributes inherited from dynamicgraph::command::Command
static const std::vector< Value::TypeEMPTY_ARG = std::vector<Value::Type>()
 

Detailed Description

template<class E>
struct dynamicgraph::command::CommandVerbose< E >

Definition at line 713 of file command-bind.h.

Member Typedef Documentation

◆ function_t

template<class E >
typedef boost::function<void(std::ostream &)> dynamicgraph::command::CommandVerbose< E >::function_t

Definition at line 714 of file command-bind.h.

Constructor & Destructor Documentation

◆ CommandVerbose()

template<class E >
dynamicgraph::command::CommandVerbose< E >::CommandVerbose ( E &  entity,
function_t  function,
const std::string &  docString 
)
inline

Definition at line 716 of file command-bind.h.

Member Function Documentation

◆ doExecute()

template<class E >
virtual Value dynamicgraph::command::CommandVerbose< E >::doExecute ( )
inlineprotectedvirtual

Specific action performed by the command.

Implements dynamicgraph::command::Command.

Definition at line 720 of file command-bind.h.

Member Data Documentation

◆ fptr

template<class E >
function_t dynamicgraph::command::CommandVerbose< E >::fptr
private

Definition at line 728 of file command-bind.h.


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


dynamic-graph
Author(s): Nicolas Mansard, Olivier Stasse
autogenerated on Sun Oct 22 2023 02:27:08