Rule::State Struct Reference

Detailed Description

Defines a base state for a Rule.

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

Inheritance diagram for Rule::State:

Public Member Functions
	MALIPUT_DEFAULT_COPY_AND_MOVE_AND_ASSIGN (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
int	severity {}
	Severity of the Rule::State. More...
RelatedRules	related_rules
RelatedUniqueIds	related_unique_ids

Static Public Attributes
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

State() [1/2]

State ( )

default

Default constructor.

State() [2/2]

State	(	int	severity,
		RelatedRules	related_rules,
		RelatedUniqueIds	related_unique_ids
	)

Creates a Rule::State.

Parameters

severity	A non-negative quantity that specifies the level of enforcement. The smaller it is, the more strictly the rule is enforced.
related_rules	Contains groups of related rules.
related_unique_ids	Contains groups of related unique ids.

Member Function Documentation

MALIPUT_DEFAULT_COPY_AND_MOVE_AND_ASSIGN()

MALIPUT_DEFAULT_COPY_AND_MOVE_AND_ASSIGN

(

State

)

operator!=()

bool operator!=

(

const State &

other

)

const

operator==()

bool operator==

(

const State &

other

)

const

Member Data Documentation

kBestEffort

constexpr int kBestEffort {1}

staticconstexpr

Rule should be obeyed on a best-effort basis.

kStrict

constexpr int kStrict {0}

staticconstexpr

Defines common Rule severity levels.

Specific rule types can choose to use these, or define their own custom levels. Rule must always be obeyed.

related_rules

RelatedRules related_rules

related_unique_ids

RelatedUniqueIds related_unique_ids

severity

int severity {}

Severity of the Rule::State.

A non-negative quantity that specifies the level of enforcement. The smaller it is, the more strictly the rule is enforced. Each rule type can define its own set of severity level semantics. See kStrict and kBestEffort for two commonly used severity levels.

---

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

• rule.h
• rule.cc