$darkmode
cloe::utility::ContactFactory< D > Class Template Reference
Inheritance diagram for cloe::utility::ContactFactory< D >:
[legend]
Collaboration diagram for cloe::utility::ContactFactory< D >:
[legend]

Public Types

using ActionType = UseContact< D >
 

Public Member Functions

 ContactFactory (ContactMap< D > *m, const std::string &name="hmi")
 
TriggerSchema schema () const override
 
ActionPtr make (const Conf &c) const override
 
ActionPtr make (const std::string &s) const override
 
- Public Member Functions inherited from cloe::TriggerFactory< T >
virtual Json json_schema () const
 
- Public Member Functions inherited from cloe::Entity
 Entity (const std::string &name)
 
 Entity (const std::string &name, const std::string &desc)
 
std::string name () const
 
void set_name (const std::string &name)
 
std::string description () const
 
void set_description (const 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]

template<typename D = Duration>
ActionPtr cloe::utility::ContactFactory< D >::make ( const Conf c) const
inlineoverridevirtual

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

Implements cloe::TriggerFactory< T >.

◆ make() [2/2]

template<typename D = Duration>
ActionPtr cloe::utility::ContactFactory< D >::make ( const std::string &  s) const
inlineoverridevirtual

Construct a UseContact action from a string.

The accepted format is a comma-separated list of buttons to activate, with an optional leading exclamation mark:

basic/hmi=!enable
basic/hmi=resume,plus,enable

The order of button names does not matter.

Reimplemented from cloe::TriggerFactory< T >.

◆ schema()

template<typename D = Duration>
TriggerSchema cloe::utility::ContactFactory< D >::schema ( ) const
inlineoverridevirtual

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 >.


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