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

Schema for mission definition files.

class fastoad.models.performances.mission.mission_definition.schema.MissionDefinition(file_path: str | PathLike = None)[source]

Bases: OrderedDict

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: str | PathLike)[source]

Loads a mission definition from provided file path.

Any existing definition will be overwritten.

Parameters:

file_path – path of YAML file to read.

force_all_block_fuel_usage(mission_name)[source]

Sets target fuel consumption to variable “~:block_fuel”.

clear() → None.  Remove all items from od.
copy() → a shallow copy of od
fromkeys(value=None)

Create a new ordered dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
move_to_end(key, last=True)

Move an existing element to the end (or beginning if last is false).

Raise KeyError if the element does not exist.

pop(key[, default]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(last=True)

Remove and return a (key, value) pair from the dictionary.

Pairs are returned in LIFO order if last is true or FIFO order if false.

setdefault(key, default=None)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values