Enum Class ClauseAction
- All Implemented Interfaces:
Serializable
,Comparable<ClauseAction>
,Constable
Enum specifying clause behavior for a digout slot.
Digout slots may either join with the next index numbered slot (e.g. slot 0 to slot 1) with a boolean operation to connect them in a clause,
or terminate the current chain.
All clauses have to evaluate to true for the digital output to be true.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionLogical AND this slot's value with the next slot's valueLogical OR this slot's value with the next slot's valueDo not join this slot with the next slot -- rather, terminate the clause here.Logical XOR this slot's value with the next slot's value -
Method Summary
Modifier and TypeMethodDescriptionstatic ClauseAction
fromIndex
(int index) Fetches the enum associated with the index value.byte
getIndex()
Fetches the index associated with the enum.static ClauseAction
Returns the enum constant of this class with the specified name.static ClauseAction[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
kTerminate
Do not join this slot with the next slot -- rather, terminate the clause here. If no previous slots are joining to this slot, then we have a single-slot "singleton" clause. -
kOrWithNextSlot
Logical OR this slot's value with the next slot's value -
kAndWithNextSlot
Logical AND this slot's value with the next slot's value -
kXorWithNextSlot
Logical XOR this slot's value with the next slot's value
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
getIndex
public byte getIndex()Fetches the index associated with the enum.- Returns:
- index value
-
fromIndex
Fetches the enum associated with the index value.- Parameters:
index
- int containing index value; only lower 2 bits are used- Returns:
- corresponding enum
-