ra2ce.analysis.losses.time_values package

Submodules

ra2ce.analysis.losses.time_values.time_values module

GNU GENERAL PUBLIC LICENSE

Version 3, 29 June 2007

Risk Assessment and Adaptation for Critical Infrastructure (RA2CE). Copyright (C) 2023 Stichting Deltares This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

class TimeValues(*, time_values=<factory>)

Bases: object

Class to store the time values for different trip types.

Parameters:

time_values (dict[TripPurposeEnum, tuple[int, int]])

get_occupants(trip_type)

Get the occupants for a given trip type.

Return type:

int

Parameters:

trip_type (TripPurposeEnum)

Args:

trip_type (TripPurposeEnum): The type of the trip.

Returns:

int: The occupants.

get_value_of_time(trip_type)

Get the value of time for a given trip type.

Return type:

int

Parameters:

trip_type (TripPurposeEnum)

Args:

trip_type (TripPurposeEnum): The type of the trip.

Returns:

int: The value of time.

time_values: dict[TripPurposeEnum, tuple[int, int]]

ra2ce.analysis.losses.time_values.time_values_reader module

GNU GENERAL PUBLIC LICENSE

Version 3, 29 June 2007

Risk Assessment and Adaptation for Critical Infrastructure (RA2CE). Copyright (C) 2023 Stichting Deltares This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

class TimeValuesReader(*args, **kwargs)

Bases: LossesInputDataReaderBase

Class to read the time values from a csv file.

csv_columns: list[str] = ['trip_types', 'value_of_time', 'occupants']

object_type

alias of TimeValues

read(file_path)

Reads from a given file and converts the data into Any type.

Return type:

TimeValues

Parameters:

file_path (Path | None)

Args:

file_path (Path): Path to a file containing data to be read.

Returns:

Any: Object mapped from the data in the file.

Module contents