root/fi.utu.tech.powergoblin.measurement/Session

Session

class Session(val id: Int, globalConfiguration: GlobalConfiguration, configuration: SessionConfiguration = globalConfiguration.session, startTime: <Error class: unknown class>, stopTime: <Error class: unknown class>? = null, validationTime: <Error class: unknown class>? = null, version: String = globalAppVersion, val sessionContext: SessionContext, oldLogWriter: LogWriter? = null, initialLogPath: String? = null, initialHandlers: Collection<MeterHandler>, initialTimeSync: List<TimeSync>, initialResourceFilters: List<String> = globalConfiguration.session.resourceFilters, initialResourceSources: Collection<ResourceDataSource>, initialResourceDumps: Collection<String>, initialActiveSources: List<ActiveSource>, initialNodes: List<NodeSummary>, initialMeasurements: Collection<MeasurementSummary>, initialCounters: SessionCounters, initialTriggerEvents: List<TriggerEvent>, initialVariables: Variables, initialReportTemplate: ReportTemplate?) : SessionData, ReadingObserver

The controller class for a single session.

Constructors

constructor(id: Int, globalConfiguration: GlobalConfiguration, initialHandlers: Collection<MeterHandler> = listOf(), oldLogWriter: LogWriter? = null, sessionContext: SessionContext)

constructor(id: Int, globalConfiguration: GlobalConfiguration, configuration: SessionConfiguration = globalConfiguration.session, startTime: <Error class: unknown class>, stopTime: <Error class: unknown class>? = null, validationTime: <Error class: unknown class>? = null, version: String = globalAppVersion, sessionContext: SessionContext, oldLogWriter: LogWriter? = null, initialLogPath: String? = null, initialHandlers: Collection<MeterHandler>, initialTimeSync: List<TimeSync>, initialResourceFilters: List<String> = globalConfiguration.session.resourceFilters, initialResourceSources: Collection<ResourceDataSource>, initialResourceDumps: Collection<String>, initialActiveSources: List<ActiveSource>, initialNodes: List<NodeSummary>, initialMeasurements: Collection<MeasurementSummary>, initialCounters: SessionCounters, initialTriggerEvents: List<TriggerEvent>, initialVariables: Variables, initialReportTemplate: ReportTemplate?)

Properties

val id: Int

open override val logPath: String

Relative path of the log directory

val sessionContext: SessionContext

Functions

activeMeasurement

fun activeMeasurement(): <Error class: unknown class>?

open override fun activeSources(): <Error class: unknown class>

Active meter/channel - friendly name mappings

fun addHandlers(handlers: Collection<MeterHandler>)

Add and assign new handlers.

open fun author(): String

Author of the session

fun busy(): Boolean

open fun close()

Only used when closing the whole application since writing will block.

open fun configuration(): SessionConfiguration

Configuration associated with this session

open override fun counters(): SessionCounters

Various session related counters

open fun description(): String

Description of the session

fun entry(): SessionEntry

fun errors(): String?

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

formattedStartTime

open fun formattedStartTime(): String

globalConfiguration

open override fun globalConfiguration(): GlobalConfiguration

Global app configuration

fun handleCommand(cmd: SessionCommand, newHandlers: List<MeterHandler> = listOf()): JsonResponse<*>

The SetupHandler delegates session related commands to the session handlers. These are handled here.

fun handleEvent(event: SessionEvent): JsonResponse<*>

Handles trigger events + meter events.

fun isMeasuring(): Boolean

fun isStopped(): Boolean

fun liveData(): SessionLiveData

loadEventStream

open fun loadEventStream(): <Error class: unknown class><SessionEvent>

Fetches the session's events from the log file.

loadMeterScatter

open fun loadMeterScatter(): ScatterGraph

loadResourceScatter

open fun loadResourceScatter(): ScatterGraph

open fun loadStatistics(): SessionStatistics

fun logFiles(): List<String>?

loggedEventCount

fun loggedEventCount(): <Error class: unknown class>

fun logPaths(): LogFilePaths

open fun logs(): <Error class: unknown class>

open override fun measurements(): <Error class: unknown class>

Summary of past measurementss

fun merge(other: Session)

meterDataSources

open fun meterDataSources(): <Error class: unknown class>

fun meterIDs(): <Error class: unknown class>

open override fun meterSpecs(): <Error class: unknown class>

Specifications for all the meters

open override fun meterStates(): <Error class: unknown class>

Specifications for all the meters

open fun name(): String

Name of the session

open override fun nodes(): <Error class: unknown class>

Returns the associated nodes.

open override fun observe(meterReading: MeterReading)

Observes the meter reading.

fun pool(): MeterHandlerPool

fun reconstruct()

Reconstruct the session.

reconstructSession

open fun reconstructSession(sessionContext: SessionContext): <Error class: unknown class>

Reconstruct a session.

registerResourceEvent

fun registerResourceEvent(event: ResourceConsumptionEvent)

open override fun reportTemplate(): ReportTemplate?

Template associated with the session

fun reset(): Session

open override fun resourceDumps(): <Error class: unknown class>

The names of units/resources for which we have received resource readings

resourceFilters

open override fun resourceFilters(): <Error class: unknown class>

Field filters for resource consumption data

resourceSources

open override fun resourceSources(): <Error class: unknown class>

The names of units/resources for which we have received resource readings

open fun restore(sessionCounter: <Error class: unknown class>, sessionContext: SessionContext): Session

Restore a session from disk.

fun setHandlers(handlers: List<MeterHandler>)

Sets the new handlers for this session. Old handlers that are not included in the new list are turned into dummy instances.

open override fun startTime(): <Error class: unknown class>

The start time of this session in LocalDateTime format

open override fun stopTime(): <Error class: unknown class>?

The stop time of this session, if any.

fun store()

Closes the current writer and reopens a new one.

open fun summary(): <Error class: unknown class>

Static data for exports (note the uptime is still ticking)

open override fun timeSync(): <Error class: unknown class>

Time sync values for different systems

open fun timeSyncer(unit: String): TimeSyncer

open override fun toString(): String

open override fun triggerEvents(): <Error class: unknown class>

A filtered list of trigger events for this session.

open fun validate()

open override fun validationTime(): <Error class: unknown class>?

The time of validation, if any

open override fun variables(): Variables

Misc variables

open override fun version(): String

fun writeAssets(inputStream: <Error class: unknown class>, maxSize: Long): Int

fun writeDumpFile(unit: String, input: <Error class: unknown class>): <Error class: unknown class>?