spike.scenario.data

Scenario data management

Classes

ScenarioData()

Class managing simulation data

class spike.scenario.data.ScenarioData

Class managing simulation data

__init__()

Contructor for each instantiation / do nothing

configure(filename, sheet)

Read scenario data from excel file

Parameters:
  • filename (string) – path to excel file in which the scenario data are located

  • sheet (string) – sheet from which data shall be retrieved

extrapolate(header, time)

Extrapolate a given data at a given time

Parameters:
  • header (string) – header of the data to extrapolate

  • time (float) – extrapolation date in seconds

Raises:

ValueError – header not found in data

Returns:

The extrapolated value at the input time

Return type:

depending on data type

is_loaded()

Loaded status return function :

Returns:

True if data are loaded, False otherwise

Return type:

boolean

__load_data(sheet)

Reads data from the excel sheet

Parameters:

sheet (string) – sheet to read object status from