OpenemsComponent.ChannelId (OpenEMS Javadoc)

java.lang.Object
- java.lang.Enum<OpenemsComponent.ChannelId>
- - io.openems.edge.common.component.OpenemsComponent.ChannelId

All Implemented Interfaces:

ChannelId, java.io.Serializable, java.lang.Comparable<OpenemsComponent.ChannelId>

Enclosing interface:

OpenemsComponent
```
public static enum OpenemsComponent.ChannelId
extends java.lang.Enum<OpenemsComponent.ChannelId>
implements ChannelId
```

Enum Constant Summary

Enum Constants
Enum Constant Description

STATE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Doc`	`doc()`	Gets the Channel Doc for this ChannelId.
`static OpenemsComponent.ChannelId`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static OpenemsComponent.ChannelId[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.openems.edge.common.channel.ChannelId
id, name

- Enum Constant Detail
  - STATE
```
public static final OpenemsComponent.ChannelId STATE
```
- Method Detail
  - values
```
public static OpenemsComponent.ChannelId[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (OpenemsComponent.ChannelId c : OpenemsComponent.ChannelId.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OpenemsComponent.ChannelId valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - doc
```
public Doc doc()
```
    Description copied from interface: ChannelId
    
    Gets the Channel Doc for this ChannelId.
    
    Specified by:
    
    doc in interface ChannelId
    
    Returns:
    
    the Channel-Doc