revrt.models.routing.TransitionCostRule

class TransitionCostRule(*, between: tuple[str, str], cost: TransitionCostValue)

Bases: BaseModel

Config for one pairwise transition cost rule

The rest of this docstring is inserted by Pydantic and can be ignored.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

Attributes

between	Routing option names
cost	The transition cost

between: tuple[str, str]

Routing option names

These two routing option names define the options between which this transition cost applies.

cost: TransitionCostValue

The transition cost

This is the transition cost (in $) applied when a route switches between the specified options. It may be a scalar, a mapping from voltage to scalar cost, or a mapping from voltage and polarity to scalar cost.