fastoad.models.performances.mission.mission_definition.schema module

Schema for mission definition files.

class fastoad.models.performances.mission.mission_definition.schema.MissionDefinition(file_path: Optional[Union[str, os.PathLike]] = None)

Bases: dict

Class for reading a mission definition from a YAML file.

Path of YAML file should be provided at instantiation, or in load().

Parameters

file_path – path of YAML file to read.

load(file_path: Union[str, os.PathLike])

Loads a mission definition from provided file path.

Any existing definition will be overwritten.

Parameters

file_path – path of YAML file to read.

class fastoad.models.performances.mission.mission_definition.schema.SegmentNames(value)

Bases: enum.Enum

Class that lists available flight segments.

Enum values are linked to matching implementation with get_segment_class().

ALTITUDE_CHANGE = 'altitude_change'

TRANSITION = 'transition'

CRUISE = 'cruise'

OPTIMAL_CRUISE = 'optimal_cruise'

BREGUET = 'breguet'

SPEED_CHANGE = 'speed_change'

HOLDING = 'holding'

TAXI = 'taxi'

classmethod string_values() → Set[str]

Returns

the list of available segments as strings

classmethod get_segment_class(value: Union[fastoad.models.performances.mission.mission_definition.schema.SegmentNames, str]) → type

Parameters

value – a SegmentNames instance or a string among possible values of SegmentNames

Returns

the matching implementation class