engine::actions::CommandFactory Class Reference

Inheritance diagram for engine::actions::CommandFactory:

Collaboration diagram for engine::actions::CommandFactory:

Public Types
using	ActionType = Command

Public Member Functions
	CommandFactory (CommandExecuter *exec)
cloe::TriggerSchema	schema () const override
cloe::ActionPtr	make (const cloe::Conf &c) const override
cloe::ActionPtr	make (const std::string &s) const override
Public Member Functions inherited from cloe::TriggerFactory< T >
virtual fable::Json	json_schema () const
	Entity (std::string name)
	Entity (std::string name, std::string desc)
Public Member Functions inherited from cloe::Entity
	Entity (std::string name)
	Entity (std::string name, std::string desc)
const std::string &	name () const
void	set_name (std::string name)
const std::string &	description () const
void	set_description (std::string desc)

Additional Inherited Members
Protected Member Functions inherited from cloe::Entity
virtual Logger	logger () const
Protected Attributes inherited from cloe::Entity
std::string	name_
std::string	desc_

Member Function Documentation

make() [1/2]

cloe::ActionPtr engine::actions::CommandFactory::make ( const cloe::Conf &  c ) const

overridevirtual

Create a new T based on the content of the input Conf.

• This method may throw TriggerInvalid.

Implements cloe::TriggerFactory< T >.

Here is the call graph for this function:

Here is the caller graph for this function:

make() [2/2]

cloe::ActionPtr engine::actions::CommandFactory::make ( const std::string &  s ) const

overridevirtual

Create a new T based on the content of the input string.

The default implementation tries to make an instance with an empty JSON object, which only works for actions and events that require no input.

It is strongly recommended to implement this method by creating a Conf object and passing that to the make(const Conf&) method. This allows users to draw a strong parallel from string representation to JSON representation.

• This method may throw TriggerInvalid.

Reimplemented from cloe::TriggerFactory< T >.

Here is the call graph for this function:

schema()

cloe::TriggerSchema engine::actions::CommandFactory::schema ( ) const

overridevirtual

Return factory schema.

This can be used to check input automatically or to derive help text for all trigger events and actions dynamically.

Reimplemented from cloe::TriggerFactory< T >.

Here is the call graph for this function:

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/cloe/checkouts/stable/engine/src/utility/command.hpp
• /home/docs/checkouts/readthedocs.org/user_builds/cloe/checkouts/stable/engine/src/utility/command.cpp