$darkmode
vtd::VtdComponentConfig Struct Reference

#include <vtd_conf.hpp>

Inheritance diagram for vtd::VtdComponentConfig:
Collaboration diagram for vtd::VtdComponentConfig:

Public Member Functions

 CONFABLE_SCHEMA (VtdComponentConfig)
 
- Public Member Functions inherited from fable::Confable
 Confable (const Confable &) noexcept
 
 Confable (Confable &&) noexcept=default
 
Confableoperator= (const Confable &other) noexcept
 
Confableoperator= (Confable &&other) noexcept
 
virtual void reset_schema ()
 
Schemaschema ()
 
const Schemaschema () const
 
virtual void validate_or_throw (const Conf &c) const
 
virtual bool validate (const Conf &c, std::optional< SchemaError > &err) const
 
virtual void from_conf (const Conf &c)
 
virtual void to_json (Json &j) const
 
Json to_json () const
 

Public Attributes

std::string from
 
std::string type
 
bool override = false
 

Additional Inherited Members

- Protected Member Functions inherited from fable::Confable
virtual Schema schema_impl ()
 

Detailed Description

Definition of a single vehicle's VTD sensor.

In future we may support different formats to specify the sensor properties in order to perform simple things in a simple way. Currently the only way is to define it in terms of the VTD module manager XML configuration as described in the following section. Sensor and component type definition. Defines the exact sensor and selects a component type to instantiate.

Member Data Documentation

◆ from

std::string vtd::VtdComponentConfig::from

Sensor name

Refers to the sensorname as defined in sensors section. This defines the VTD sensor to take a particular type of data (i.e. this component) from. The VTD sensor names are defined by the keys in the sensors configuration.

◆ override

bool vtd::VtdComponentConfig::override = false

Override an existing sensor with that name.

If a component with that name already exists this can be set to true to override the existing component.

Defaults to false.

◆ type

std::string vtd::VtdComponentConfig::type

Component type

One of

  • lane_sensor
  • object_sensor

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