root/fi.utu.tech.powergoblin.common/Plan

Plan

data class Plan(val name: String, val author: String, val description: String, val activeChannels: List<ActiveSource>, val activeResources: List<ActiveSource>, val collectors: List<CollectorFlags>, val activeNodes: List<String>, val resourceFilters: List<String>, val planId: String?, val initializationStrategy: SessionInitializationStrategy, val scripts: List<String>, val runs: String, val timeOut: Long, val calibrationTargets: List<CalibrationTarget>, val calibrationDelta: Double?, val calibrationThreshold: Double?, val units: List<String>, val excludeUnits: List<String>)

Describes a measurement plan.

Constructors

constructor(name: String, author: String, description: String, activeChannels: List<ActiveSource>, activeResources: List<ActiveSource>, collectors: List<CollectorFlags>, activeNodes: List<String>, resourceFilters: List<String>, planId: String?, initializationStrategy: SessionInitializationStrategy, scripts: List<String>, runs: String, timeOut: Long, calibrationTargets: List<CalibrationTarget>, calibrationDelta: Double?, calibrationThreshold: Double?, units: List<String>, excludeUnits: List<String>)

Types

object Companion

Properties

val activeChannels: List<ActiveSource>

active meter/channels for the session

val activeNodes: List<String>

Active nodes for the session

activeResources

val activeResources: List<ActiveSource>

active unit/resources for the session

val author: String

Author of the plan

calibrationDelta

val calibrationDelta: Double?

Calibration mode: floating point value representing a significant change

calibrationTargets

val calibrationTargets: List<CalibrationTarget>

Calibration mode: are we in a special calibration mode

calibrationThreshold

val calibrationThreshold: Double?

Calibration mode: floating point value representing the minimum consumption

val collectors: List<CollectorFlags>

Collection rules for nodes

val description: String

Description of the plan

val excludeUnits: List<String>

Calibration mode: units to be excluded

initializationStrategy

val initializationStrategy: SessionInitializationStrategy

Agent plan mode: initialization strategy for the session

val name: String

Name of the plan

val planId: String?

Plan id (unique UUID, if any)

resourceFilters

val resourceFilters: List<String>

List of included resources in the session

val runs: String

How many runs (a single value or comma separated list)

val scripts: List<String>

List of scripts (must be nonempty)

val timeOut: Long

General timeout for the whole session

val units: List<String>

Calibration mode: units to be included

Functions

fun flags(node: String): <Error class: unknown class>

fun render(content: String): String

fun toVariables(): Variables