com.prosysopc.ua.stack.builtintypes

Interface Enumeration

All Known Implementing Classes:

ActionState, ApplicationType, AxisScaleEnumeration, BrokerTransportQualityOfService, BrowseDirection, BrowseResultMask, ChassisIdSubtype, ConfigurationUpdateType, ConversionLimitEnum, DataChangeTrigger, DataSetOrderingType, DeadbandType, DiagnosticsLevel, Duplex, DynamicEnumeration, ExceptionDeviationFormat, FilterOperator, HistoryUpdateType, IdentityCriteriaType, IdType, InterfaceAdminStatus, InterfaceOperStatus, ManAddrIfSubtype, MessageSecurityMode, ModelChangeStructureVerbMask, MonitoringMode, NamingRuleType, NegotiationStatus, NodeAttributesMask, NodeClass, OpenFileMode, OverrideValueHandling, PerformUpdateType, PortIdSubtype, PubSubDiagnosticsCounterClassification, PubSubState, RedundancySupport, RedundantServerMode, SecurityTokenRequestType, ServerState, SortOrderType, StructureType, TimestampsToReturn, TrustListMasks, TsnFailureCode, TsnListenerStatus, TsnStreamState, TsnTalkerStatus, UserTokenType

public interface Enumeration

Interface for all UA Enumerations DataTypes. Instances are either in a generated java Enum type, such as ServerState or handled by DynamicEnumeration. In either case, the enum constants are also in an EnumerationSpecification obtainable from an EncoderContext. In general only the SDK or Codegen should implement this interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Enumeration.Builder Builder for making Enumerations dynamically.

Method Summary

Modifier and Type	Method and Description
default LocalizedText	getDescription() Returns description of the Enumeration or LocalizedText.EMPTY if not available.
int	getValue() Return the integer value of this enumeration value.
default String	getValueAsString() Returns the string value of this enumeration value.
EnumerationSpecification	specification() Returns the specification of the Enumeration.
Enumeration.Builder	toBuilder() Returns a builder which can be used to make other instances of the Enumeration.

Method Detail

getDescription

default LocalizedText getDescription()

Returns description of the Enumeration or LocalizedText.EMPTY if not available.

getValue

int getValue()

Return the integer value of this enumeration value. This value is what is encoded to be binary stream, as OPC UA Enumerations are encoded as Int32 values.

getValueAsString

default String getValueAsString()

Returns the string value of this enumeration value.

specification

EnumerationSpecification specification()

Returns the specification of the Enumeration.

toBuilder

Enumeration.Builder toBuilder()

Returns a builder which can be used to make other instances of the Enumeration.