SpecialVariable

Variables with special meaning.

Entries

Link copied to clipboard

name of the session

Link copied to clipboard

author of the session

Link copied to clipboard

description of the session

Link copied to clipboard

active meter/channels for the session

Link copied to clipboard

active unit/resources for the session

Link copied to clipboard

active nodes for the session

Link copied to clipboard

List of included resources in the session

Link copied to clipboard

Unique ID of the plan if any

Link copied to clipboard

Agent plan mode: initialization strategy for the session

Link copied to clipboard

Agent plan mode: Enabled collector flags for this session

Link copied to clipboard

Agent plan mode: Scripts to be executed by the agent

Link copied to clipboard

Agent plan mode: Runs to be used for the measurements in the session

Link copied to clipboard

Agent plan mode: Generic timeout for all things in the session

Link copied to clipboard

Calibration mode: are we in a special calibration mode

Link copied to clipboard

Calibration mode: floating point value representing a significant change

Link copied to clipboard

Calibration mode: floating point value representing the minimum consumption

Link copied to clipboard

Calibration mode: node to be tested

Link copied to clipboard

Calibration mode: units to be included

Link copied to clipboard

Calibration mode: units to be excluded

Link copied to clipboard

Report document: sections of the document

Link copied to clipboard

Report document: visible sections in different modes

Link copied to clipboard

Report document: expanded sections in different modes

Link copied to clipboard

Report document: supported modes in the report

Link copied to clipboard

Report document: palette to be used

Properties

Link copied to clipboard
val defaultValue: List<String>? = null
Link copied to clipboard
val key: String
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun get(variables: Variables?): List<String>?
Link copied to clipboard
fun require(variables: Variables?): List<String>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.