DiscreteValueRule::DiscreteValue Struct Reference

Detailed Description

Defines a discrete value for a DiscreteValueRule.

#include <include/maliput/api/rules/discrete_value_rule.h>

Inheritance diagram for DiscreteValueRule::DiscreteValue:

Public Member Functions

 DiscreteValue ()=default
 Default constructor. More...
 DiscreteValue (int severity, RelatedRules related_rules, RelatedUniqueIds related_unique_ids, std::string value)
 Creates a Rule::State. More...
bool operator== (const DiscreteValue &other) const
bool operator!= (const DiscreteValue &other) const
- Public Member Functions inherited from Rule::State
 State ()=default
 Default constructor. More...
 State (int severity, RelatedRules related_rules, RelatedUniqueIds related_unique_ids)
 Creates a Rule::State. More...
bool operator== (const State &other) const
bool operator!= (const State &other) const

Public Attributes

std::string value
 Value of the DiscreteValue. More...
- Public Attributes inherited from Rule::State
int severity {}
 Severity of the Rule::State. More...
RelatedRules related_rules
RelatedUniqueIds related_unique_ids

Additional Inherited Members

- Static Public Attributes inherited from Rule::State
static constexpr int kStrict {0}
 Defines common Rule severity levels. More...
static constexpr int kBestEffort {1}
 Rule should be obeyed on a best-effort basis. More...

Constructor & Destructor Documentation

◆ DiscreteValue() [1/2]

DiscreteValue ( )

Default constructor.

◆ DiscreteValue() [2/2]

DiscreteValue ( int  severity,
RelatedRules  related_rules,
RelatedUniqueIds  related_unique_ids,
std::string  value 

Creates a Rule::State.

severityA non-negative quantity that specifies the level of enforcement. The smaller it is, the more strictly the rule is enforced.
related_rulesContains groups of related rules.
related_unique_idsContains groups of related unique ids.
valueIs the discrete value contained in the rule.

Member Function Documentation



◆ operator!=()

bool operator!= ( const DiscreteValue other) const

◆ operator==()

bool operator== ( const DiscreteValue other) const

Member Data Documentation

◆ value

std::string value

Value of the DiscreteValue.

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