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

SessionSummaryAdapter

class SessionSummaryAdapter(summary: SessionSummary, val logPath: String) : SessionData

Constructors

constructor(summary: SessionSummary, logPath: String)

Properties

logPath

open override val logPath: String

Relative path of the log directory

Functions

activeSources

open override fun activeSources(): List<ActiveSource>

Active meter/channel - friendly name mappings

author

open fun author(): String

Author of the session

configuration

open fun configuration(): SessionConfiguration

Configuration associated with this session

counters

open override fun counters(): SessionCounters

Various session related counters

description

open fun description(): String

Description of the session

formattedStartTime

open fun formattedStartTime(): String

globalConfiguration

open override fun globalConfiguration(): GlobalConfiguration

Global app configuration

loadEventStream

open fun loadEventStream(path: <Error class: unknown class> = LogFilePaths(this).eventJsonPath): <Error class: unknown class><SessionEvent>

Fetches the session's events from the log file.

loadMeterScatter

open fun loadMeterScatter(): ScatterGraph

loadResourceScatter

open fun loadResourceScatter(): ScatterGraph

loadStatistics

open fun loadStatistics(): SessionStatistics

logs

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

measurements

open override fun measurements(): List<MeasurementSummary>

Summary of past measurements

meterDataSources

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

meterSpecs

open override fun meterSpecs(): List<PowerMeter>

Specifications for all the meters

meterStates

open override fun meterStates(): List<MeterState>

Specifications for all the meters

name

open fun name(): String

Name of the session

nodes

open override fun nodes(): List<NodeSummary>

Associated nodes

readSessionErrorLog

open fun readSessionErrorLog(): String?

Processes the session log and returns the error message if any. Otherwise, return null.

readSessionLog

open fun readSessionLog(): String

The session log contains list of generated files or detailed error messages.

readSessionPlan

open fun readSessionPlan(): String

The session plan contains session related parameters in the front-matter, and a report template at the bottom.

reconstructSession

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

Reconstruct a session.

reportTemplate

open override fun reportTemplate(): ReportTemplate?

Template associated with the session

resourceDumps

open override fun resourceDumps(): List<String>

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

resourceFilters

open override fun resourceFilters(): List<String>

Field filters for resource consumption data

resourceSources

open override fun resourceSources(): List<ResourceDataSource>

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

restore

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

Restore a session from disk.

startTime

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

The start time of this session in LocalDateTime format

stopTime

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

The stop time of this session, if any.

summary

open override fun summary(): SessionSummary

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

timeSync

open override fun timeSync(): List<TimeSync>

Time sync values for different systems

timeSyncer

open fun timeSyncer(unit: String): TimeSyncer

toString

open override fun toString(): String

triggerEvents

open override fun triggerEvents(): List<TriggerEvent>

A filtered list of trigger events for this session.

validate

open fun validate()

validationTime

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

The time of validation, if any

variables

open override fun variables(): Variables

Misc variables

version

open override fun version(): String