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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaccessMode
(AccessMode accessMode) Sets the Access-Mode for the Channel.Gets theChannelCategory
of the Channel of this Doc.getUnit()
Gets the Unit.static OpenemsTypeDoc<?>
of
(OpenemsType type) Gets theOpenemsTypeDoc
for the givenOpenemsType
.Unit.Methods inherited from class io.openems.edge.common.channel.internal.AbstractDoc
createChannelInstance, debug, getAccessMode, getInitialValue, getOnInitCallbacks, getPersistencePriority, getText, getType, initialValue, isDebug, onChannelChange, onChannelChange, onChannelSetNextValue, onChannelSetNextWrite, onChannelSetNextWriteMirrorToDebugChannel, onChannelUpdate, onInit, persistencePriority, self, text
-
Constructor Details
-
OpenemsTypeDoc
-
-
Method Details
-
of
Gets theOpenemsTypeDoc
for the givenOpenemsType
.- Parameters:
type
- theOpenemsType
- Returns:
- the
OpenemsTypeDoc
-
getChannelCategory
Description copied from interface:Doc
Gets theChannelCategory
of the Channel of this Doc.- Returns:
- the ChannelCategory
-
accessMode
Sets the Access-Mode for the Channel.This is validated on construction of the Channel by
AbstractReadChannel
- Overrides:
accessMode
in classAbstractDoc<T>
- Parameters:
accessMode
- theAccessMode
- Returns:
- myself
-
unit
Unit. Default: none- Parameters:
unit
- the Unit- Returns:
- myself
-
getUnit
Gets the Unit.- Specified by:
getUnit
in interfaceDoc
- Overrides:
getUnit
in classAbstractDoc<T>
- Returns:
- the unit
-