io.openems.edge.common.channel.internal

Class OpenemsTypeDoc<T>

java.lang.Object

io.openems.edge.common.channel.internal.AbstractDoc<T>

io.openems.edge.common.channel.internal.OpenemsTypeDoc<T>

All Implemented Interfaces:

Doc

Direct Known Subclasses:

BooleanDoc, DoubleDoc, FloatDoc, IntegerDoc, LongDoc, ShortDoc, StringDoc

public abstract class OpenemsTypeDoc<T>
extends AbstractDoc<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpenemsTypeDoc(OpenemsType type)

Method Summary

Modifier and Type	Method and Description
OpenemsTypeDoc<T>	accessMode(AccessMode accessMode) Sets the Access-Mode for the Channel.
ChannelCategory	getChannelCategory() Gets the ChannelCategory of the Channel of this Doc.
Unit	getUnit() Gets the Unit.
static OpenemsTypeDoc<?>	of(OpenemsType type) Create a Channel-Doc with a specific OpenemsType.
OpenemsTypeDoc<T>	unit(Unit unit) Unit.

Methods inherited from class io.openems.edge.common.channel.internal.AbstractDoc

createChannelInstance, debug, getAccessMode, getInitialValue, getOnInitCallbacks, getText, getType, initialValue, isDebug, onInit, self, text

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.openems.edge.common.channel.Doc

of, of

Constructor Detail

OpenemsTypeDoc

protected OpenemsTypeDoc(OpenemsType type)

Method Detail

of

public static OpenemsTypeDoc<?> of(OpenemsType type)

Description copied from interface: Doc

Create a Channel-Doc with a specific OpenemsType.

use like this:

 Doc.of(OpenemsType.INTEGER)
 

Parameters:

type - the OpenemsType

Returns:

an instance of OpenemsTypeDoc

getChannelCategory

public ChannelCategory getChannelCategory()

Description copied from interface: Doc

Gets the ChannelCategory of the Channel of this Doc.

Returns:

the ChannelCategory

accessMode

public OpenemsTypeDoc<T> accessMode(AccessMode accessMode)

Sets the Access-Mode for the Channel.

This is validated on construction of the Channel by AbstractReadChannel

Overrides:

accessMode in class AbstractDoc<T>

Returns:

myself

unit

public OpenemsTypeDoc<T> unit(Unit unit)

Unit. Default: none

Parameters:

unit - the Unit

Returns:

myself

getUnit

public Unit getUnit()

Gets the Unit.

Specified by:

getUnit in interface Doc

Overrides:

getUnit in class AbstractDoc<T>

Returns:

the unit