src.system.projection.time_steps.TimeSteps

class src.system.projection.time_steps.TimeSteps(start_t: date, end_t: date, time_step: relativedelta)

Time-keeping class, used to synchronize time across model objects in a Projection.

Inheritance Diagram

Variables & Properties

max_t	Last, or latest time step.
min_t	First, or earliest time step.
next_t	Next time step during a Projection.
prev_t	Previous time step during a Projection.
t	Current time step during a Projection.
time_step	Interval of time between time steps.

Methods

__init__(start_t, end_t, time_step)

Constructor method.

Details

__init__(start_t: date, end_t: date, time_step: relativedelta)

Constructor method. Creates a list of time steps a Projection would iterate over.

Parameters:

• start_t – Starting time step.

• end_t – Ending time step.

• time_step – Interval between time steps.

property max_t: date

Last, or latest time step.

Returns:

Last time step.

property min_t: date

First, or earliest time step.

Returns:

First time step.

property next_t: date

Next time step during a Projection.

Returns:

Next time step.

property prev_t: date

Previous time step during a Projection.

Returns:

Previous time step.

property t: date

Current time step during a Projection.

Returns:

Current time step.

property time_step: relativedelta

Interval of time between time steps.

Returns:

Time step interval.