root/fi.utu.tech.powergoblin.data/SessionLiveData

SessionLiveData

data class SessionLiveData(val id: Int, val name: String, val author: String, val description: String, val startTime: String, val stopTime: String?, val validationTime: String?, val counters: SessionCounters, val measurements: List<MeasurementSummary>, val resourceSources: List<ResourceDataSource>, val variables: Variables, val timeSync: List<TimeSync>, val activeSources: List<ActiveSource>, val version: String, val resourceFilters: List<String>, val meterStates: List<MeterState>, val meterSpecs: List<PowerMeter>, val activeMeasurement: ActiveMeasurement?, val writingLogs: Boolean?, val logPath: String? = null, val flags: List<SessionFlag>, val nodes: List<NodeEntry>, val planId: String?)

Live session data contains the rapidly changing session data that can be serialized as JSON messages for communicating with different frontends via an external API.

Constructors

SessionLiveData

constructor(id: Int, name: String, author: String, description: String, startTime: String, stopTime: String?, validationTime: String?, counters: SessionCounters, measurements: List<MeasurementSummary>, resourceSources: List<ResourceDataSource>, variables: Variables, timeSync: List<TimeSync>, activeSources: List<ActiveSource>, version: String, resourceFilters: List<String>, meterStates: List<MeterState>, meterSpecs: List<PowerMeter>, activeMeasurement: ActiveMeasurement?, writingLogs: Boolean?, logPath: String? = null, flags: List<SessionFlag>, nodes: List<NodeEntry>, planId: String?)

Properties

activeMeasurement

val activeMeasurement: ActiveMeasurement?

Active measurement if any

val activeSources: List<ActiveSource>

Active meter/channels

val author: String

Author of the session; mutable property; can be changed with commands

val counters: SessionCounters

Various session related counters

val description: String

Description of the session; mutable property; can be changed with commands

val flags: List<SessionFlag>

State flags

val id: Int

ID of the session

val logPath: String? = null

List of active log files

val measurements: List<MeasurementSummary>

Past measurements

val meterSpecs: List<PowerMeter>

States of the meters

val meterStates: List<MeterState>

States of the meters

val name: String

Name of the session; mutable property; can be changed with commands

val nodes: List<NodeEntry>

Associated nodes

val planId: String?

Plan ID (unique UUID)

resourceFilters

val resourceFilters: List<String>

Field filters for resource consumption data

resourceSources

val resourceSources: List<ResourceDataSource>

Resource consumption of different units

val startTime: String

The timestamp of the start of the session, @see System.currentTimeMillis()

val stopTime: String?

The timestamp of the end of the session, @see System.currentTimeMillis()

val timeSync: List<TimeSync>

Timestamps of different units for synchronization

val validationTime: String?

The time of validation, if any

val variables: Variables

Misc variables

val version: String

Build version of the application

val writingLogs: Boolean?

Tells whether the writer instance is active

Functions

open override fun toString(): String