Detailed Description

Defines a range for a RangeValueRule.

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

Inheritance diagram for RangeValueRule::Range:

Public Member Functions
	MALIPUT_DEFAULT_COPY_AND_MOVE_AND_ASSIGN (Range)

	Range ()=default
	Default constructor. More...

	Range (int severity, RelatedRules related_rules, RelatedUniqueIds related_unique_ids, std::string description, double min, double max)
	Creates a Rule::State. More...

bool	operator== (const Range &other) const

bool	operator!= (const Range &other) const

bool	operator< (const Range &other) const
	Returns true when this range is less than `other`. More...

Public Member Functions inherited from Rule::State
	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
std::string	description
	Semantics of the range quantity. More...

double	min {}
	Minimum value of the range. More...

double	max {}
	Maximum value of the range. 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

◆ Range() [1/2]

Range ( )

default

Default constructor.

◆ Range() [2/2]

Range	(	int	severity,
		RelatedRules	related_rules,
		RelatedUniqueIds	related_unique_ids,
		std::string	description,
		double	min,
		double	max
	)

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.
description	Semantics of the range quantity.
min	Minimum value of the range.
max	Maximum value of the range.

Member Function Documentation

◆ MALIPUT_DEFAULT_COPY_AND_MOVE_AND_ASSIGN()

MALIPUT_DEFAULT_COPY_AND_MOVE_AND_ASSIGN ( Range )

◆ operator!=()

bool operator!= ( const Range & other ) const

◆ operator<()

bool operator< ( const Range & other ) const

Returns true when this range is less than other.

It compares severity, description, min and max in the described order.

Used for strict ordering in collections such as std::set.

◆ operator==()

bool operator== ( const Range & other ) const

Member Data Documentation

◆ description

std::string description

Semantics of the range quantity.

◆ max

double max {}

Maximum value of the range.

◆ min

double min {}

Minimum value of the range.

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