$darkmode
Public Member Functions | List of all members
cloe::TriggerSchema Struct Reference

#include <trigger.hpp>

Public Member Functions

 TriggerSchema (std::string name, std::string desc)
 
 TriggerSchema (std::string name, std::string desc, fable::schema::PropertyList<> props)
 
 TriggerSchema (std::string name, std::string desc, Schema s)
 
 TriggerSchema (std::string name, std::string desc, InlineSchema usage, fable::schema::PropertyList<> props)
 
 TriggerSchema (std::string name, std::string desc, InlineSchema usage, Schema init)
 
const std::string & name () const
 
const std::string & description () const
 
std::string usage_inline () const
 
fable::Json usage () const
 
fable::Json json_schema () const
 

Detailed Description

TriggerSchema describes the schema of a trigger, acting as a usage generator and validator for trigger actions and events.

Constructor & Destructor Documentation

◆ TriggerSchema() [1/5]

cloe::TriggerSchema::TriggerSchema ( std::string  name,
std::string  desc 
)
inline

Construct a TriggerSchema that describes a trigger with no parameters and an implicit inline format.

For example, the definition:

TriggerSchema("stop", "stop the simulation")

will allow the following forms of initialization:

"stop" { "name": "stop" }

◆ TriggerSchema() [2/5]

cloe::TriggerSchema::TriggerSchema ( std::string  name,
std::string  desc,
fable::schema::PropertyList<>  props 
)
inline

Construct a TriggerSchema that describes a trigger with parameters but no inline format.

◆ TriggerSchema() [3/5]

cloe::TriggerSchema::TriggerSchema ( std::string  name,
std::string  desc,
Schema  s 
)
inline

Construct a TriggerSchema that describes a trigger with the given Schema but no inline format.

Here is the call graph for this function:

◆ TriggerSchema() [4/5]

cloe::TriggerSchema::TriggerSchema ( std::string  name,
std::string  desc,
InlineSchema  usage,
fable::schema::PropertyList<>  props 
)
inline

Construct a TriggerSchema that describes a trigger with parameters and a specified inline format.

◆ TriggerSchema() [5/5]

cloe::TriggerSchema::TriggerSchema ( std::string  name,
std::string  desc,
InlineSchema  usage,
Schema  init 
)
inline

Construct a TriggerSchema that describes a trigger with the given Schema and a specified inline format.

Here is the call graph for this function:
The documentation for this struct was generated from the following files: