OpenemsTypeDoc (OpenEMS Javadoc)

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 Description

protected OpenemsTypeDoc(OpenemsType type)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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)`	Gets the `OpenemsTypeDoc` for the given `OpenemsType`.
`OpenemsTypeDoc<T>`	`unit(Unit unit)`	Unit.

Methods inherited from class io.openems.edge.common.channel.internal.AbstractDoc
createChannelInstance, debug, getAccessMode, getInitialValue, getOnInitCallbacks, getPersistencePriority, getText, getType, initialValue, isDebug, onInit, persistencePriority, self, text

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OpenemsTypeDoc
```
protected OpenemsTypeDoc(OpenemsType type)
```
- Method Detail
  - of
```
public static OpenemsTypeDoc<?> of(OpenemsType type)
```
    Gets the OpenemsTypeDoc for the given OpenemsType.
    
    Parameters:
    
    type - the OpenemsType
    
    Returns:
    
    the 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>
    
    Parameters:
    
    accessMode - the AccessMode
    
    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