14 intervals (release)

The intervals object holds all interval objects, identified by user defined identifiers. Various commands require a discrete event trigger, provided by an interval object.

Name

 

Type

 

Description

 

Default

label

 

STRING

 

User provided identifier for this interval definition.

 

use_start_stop_from_interval [optional]

 

STRING

 

Specifies another interval from which to inherit the interval bounds.

 

start_time [optional]

 

DOUBLE

 

Defines the lower limit of the interval range as a user-specified value of the simulation's global time value.

 

start_step [optional]

 

INTEGER

 

Defines the lower limit of the interval range as a user-specified value of the simulation's global step value.

 

stop_time [optional]

 

DOUBLE

 

Defines the upper limit of the interval range as a user-specified value of the simulation's global time value.

 

stop_step [optional]

 

INTEGER

 

Defines the upper limit of the interval range as a user-specified value of the simulation's global step value.

 

time_increment [optional]

 

DOUBLE

 

Defines a constant time value to increment from the lower limit of the interval range. The upper and lower limits of an interval are always included, even if the time increment would skip the upper limit. A time increment value of 0 is always active, while a negative time increment is only active at the limits of the interval.

 

1.0

step_increment [optional]

 

INTEGER

 

Defines a constant step value to increment from the lower limit of the interval range. The upper and lower limits of an interval are always included, even if the step increment would skip the upper limit. Step increment values of 0 or 1 are equivalent and are always active, while a negative step increment is only active at the limits of the interval.

 

additional_time_values [optional] (beta)

 

[ DOUBLE, ... ]

 

Defines additional time values at which the interval is considered active.

 

additional_step_values [optional] (beta)

 

[ NONNEGATIVE INTEGER, ... ]

 

Defines additional step values at which the interval is considered active.

 

number_equally_spaced_values [optional]

 

INTEGER

 

Specifies the number of equally-spaced values distributed within the interval. The number of points, N, includes the interval boundaries as points. The values N in all have the same effect of including the interval boundaries. For N>2 this behaves similarly to linspace routines that are common in programming environments such as Matlab or NumPy. For example, for on an interval from the active values are , for , etc.

 

Example Usage:

intervals: [ { label: "apply_load", start_time: 0, stop_time: 1, time_increment: 1 }, { label: "output_interval", use_start_stop_from_interval: "apply_load", time_increment: 1, step_increment: 1 } ]