Module org.eclipse.milo.opcua.stack.core
Package org.eclipse.milo.opcua.stack.core.types.enumerated

Enum Class PortIdSubtype

java.lang.Object
java.lang.Enum<PortIdSubtype>
org.eclipse.milo.opcua.stack.core.types.enumerated.PortIdSubtype
All Implemented Interfaces:
Serializable, Comparable<PortIdSubtype>, Constable, UaDataType, UaEnumeratedType
public enum PortIdSubtype extends Enum<PortIdSubtype> implements UaEnumeratedType
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PortIdSubtype.TypeInfo
     

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AgentCircuitId
    Represents a port identifier based on the agent-local identifier of the circuit (defined in IETF RFC 3046), detected by the agent and associated with a particular port.
    InterfaceAlias
    Represents a port identifier based on the ifAlias MIB object defined in IETF RFC 2863.
    InterfaceName
    Represents a port identifier based on the ifName MIB object, defined in IETF RFC 2863.
    Local
    Represents a port identifier based on a value locally assigned.
    MacAddress
    Represents a port identifier based on a unicast source address (encoded in network byte order and IEEE 802.3 canonical bit order) which has been detected by the agent and associated with a particular port (IEEE Std 802-2014).
    NetworkAddress
    Represents a port identifier based on a network address, detected by the agent and associated with a particular port.
    PortComponent
    Represents a port identifier based on the value of entPhysicalAlias (defined in IETF RFC 2737) for a port component (i.e., entPhysicalClass value of port(10) or backplane(4)), within the containing chassis.

  • Method Summary

    Modifier and Type
    Method
    Description
    static EnumDefinition
    definition()
     
    static @Nullable PortIdSubtype
    from(int value)
     
    ExpandedNodeId
    getTypeId()
    Get the ExpandedNodeId identifying this DataType.
    int
    getValue()
    Get the numeric value associated with this enumerated value.
    static PortIdSubtype
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static PortIdSubtype[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, 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 org.eclipse.milo.opcua.stack.core.types.UaDataType

    getTypeName

    Methods inherited from interface org.eclipse.milo.opcua.stack.core.types.UaEnumeratedType

    getName

  • Enum Constant Details

    • InterfaceAlias

      public static final PortIdSubtype InterfaceAlias
      Represents a port identifier based on the ifAlias MIB object defined in IETF RFC 2863.

    • PortComponent

      public static final PortIdSubtype PortComponent
      Represents a port identifier based on the value of entPhysicalAlias (defined in IETF RFC 2737) for a port component (i.e., entPhysicalClass value of port(10) or backplane(4)), within the containing chassis.

    • MacAddress

      public static final PortIdSubtype MacAddress
      Represents a port identifier based on a unicast source address (encoded in network byte order and IEEE 802.3 canonical bit order) which has been detected by the agent and associated with a particular port (IEEE Std 802-2014).

    • NetworkAddress

      public static final PortIdSubtype NetworkAddress
      Represents a port identifier based on a network address, detected by the agent and associated with a particular port.

    • InterfaceName

      public static final PortIdSubtype InterfaceName
      Represents a port identifier based on the ifName MIB object, defined in IETF RFC 2863.

    • AgentCircuitId

      public static final PortIdSubtype AgentCircuitId
      Represents a port identifier based on the agent-local identifier of the circuit (defined in IETF RFC 3046), detected by the agent and associated with a particular port.

    • Local

      public static final PortIdSubtype Local
      Represents a port identifier based on a value locally assigned.

  • Method Details

    • values

      public static PortIdSubtype[] 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

      public static PortIdSubtype valueOf(String name)
      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 name
      NullPointerException - if the argument is null

    • getValue

      public int getValue()
      Description copied from interface: UaEnumeratedType
      Get the numeric value associated with this enumerated value.
      Specified by:
      getValue in interface UaEnumeratedType
      Returns:
      the numeric value associated with this enumerated value.

    • getTypeId

      public ExpandedNodeId getTypeId()
      Description copied from interface: UaDataType
      Get the ExpandedNodeId identifying this DataType.
      Specified by:
      getTypeId in interface UaDataType
      Returns:
      the ExpandedNodeId identifying this DataType.

    • from

      public static @Nullable PortIdSubtype from(int value)

    • definition

      public static EnumDefinition definition()