root/fi.utu.tech.powergoblin.drivers.model/PowerMeter

PowerMeter

data class PowerMeter(val meterType: MeterType, val protocol: String, val description: String, val channels: List<String>, val outputChannels: List<String> = channels, val pollPeriod: Int, val sampleRate: Int, val logEvents: Boolean, val present: Boolean = true, val extra: PowerMeterData, val capabilities: List<MeterCapability>, val id: String = "-", val shortId: String? = null, val describe: List<String> = extra.describe)

Power meter descriptor with abstract informative content.

Constructors

constructor(meterType: MeterType, protocol: String, description: String, channels: List<String>, outputChannels: List<String> = channels, pollPeriod: Int, sampleRate: Int, logEvents: Boolean, present: Boolean = true, extra: PowerMeterData, capabilities: List<MeterCapability>, id: String = "-", shortId: String? = null, describe: List<String> = extra.describe)

Properties

val capabilities: List<MeterCapability>

Meter's capabilities

val channels: List<String>

List of channel ids

val describe: List<String>

val description: String

Description of the power meter

val extra: PowerMeterData

Handler dependent extra data

Identifier, typically calculated from the hash value derived from the other metadata fields

val logEvents: Boolean

Enable observers to log the events

val meterType: MeterType

Describes a power meter type (id & description)

val outputChannels: List<String>

List of channel ids for output channels

val pollPeriod: Int

Polling period in milliseconds

val present: Boolean = true

Is this meter physically present

val protocol: String

Name of the protocol

val sampleRate: Int

Samples per second

val shortId: String? = null

Short version of the id if any

Functions

fun channelId(name: String): Int

fun channelName(id: Int): String

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

fun dummyHandler(meterState: MeterState? = null): MeterHandler

initialChannelState

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

open override fun toString(): String