`nrel.hive.model.vehicle.schedules`

Submodules

Package Contents

Classes

ScheduleType

Generic enumeration.

Functions

`time_range_schedules_from_file`(...)	given a CSV file of time ranges by ScheduleId, construct a time range schedule table
`build_schedules_table`(...)	builds the schedule table based on the provided schedule type and file

Attributes

`ScheduleFunction`
`ScheduleId`
`_constructors`

nrel.hive.model.vehicle.schedules.ScheduleFunction

class nrel.hive.model.vehicle.schedules.ScheduleType[source]

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

TIME_RANGE = 0

static from_string(string: str) → ScheduleType[source]

parses an input configuration string as a ChargingSearchType

Parameters:: string – the input string
Returns:: a ChargingSearchType or an Error
Raises:: ValueError when the charging search type is unknown

nrel.hive.model.vehicle.schedules.time_range_schedules_from_file(file: str) → immutables.Map[nrel.hive.util.typealiases.ScheduleId, nrel.hive.model.vehicle.schedules.schedule.ScheduleFunction][source]

given a CSV file of time ranges by ScheduleId, construct a time range schedule table

Parameters:: file – the CSV file
Returns:: the schedules

nrel.hive.model.vehicle.schedules.ScheduleId

nrel.hive.model.vehicle.schedules._constructors

nrel.hive.model.vehicle.schedules.build_schedules_table(schedule_type: schedule_type.ScheduleType, schedules_file: str) → immutables.Map[nrel.hive.util.typealiases.ScheduleId, schedule.ScheduleFunction][source]

builds the schedule table based on the provided schedule type and file

Parameters:: schedule_type – the type of schedule to load. different schedule types require

different programmatic implementations and argument types/structures

Parameters:: schedules_file – the file providing parameters for the schedule type
Returns:: a schedule lookup table for the simulation environment

nrel.hive.model.vehicle.schedules