Package de.iip_ecosphere.platform.configuration.easyProducer.opcua.data

Class BaseType

java.lang.Object
de.iip_ecosphere.platform.configuration.easyProducer.opcua.data.BaseType
Direct Known Subclasses:
DataType, EnumType, FieldType, MethodType, ObjectType, ObjectTypeType, RootVariableType, VariableTypeType
public abstract class BaseType extends Object
Representation of an OPC UA type.
Author:
Jan-Hendrik Cepok, SSE

  • Field Details

    • varName

      private String varName

    • nodeId

      private String nodeId

    • browseName

      private String browseName

    • displayName

      private String displayName

    • description

      private String description

    • optional

      private boolean optional

  • Constructor Details

    • BaseType

      public BaseType(String nodeId, String browseName, String displayname, String description, boolean optional)
      Creates an OPC UA type representation.
      Parameters:
      nodeId - the node id
      browseName - the browse name
      displayname - the display name
      description - the description
      optional - whether the type is optional

  • Method Details

    • getVarName

      public String getVarName()
      Returns the (IVML) variable name.
      Returns:
      the variable name

    • setVarName

      public void setVarName(String varName)
      Defines the (IVML) variable name.
      Parameters:
      varName - the variable name

    • getNodeId

      public String getNodeId()
      Returns the OPC UA node id.
      Returns:
      the node id

    • getBrowseName

      public String getBrowseName()
      Returns the OPC UA browse name.
      Returns:
      the browse name

    • getDisplayname

      public String getDisplayname()
      Returns the OPC UA display name.
      Returns:
      the display name

    • getDescription

      public String getDescription()
      Returns the OPC UA node description.
      Returns:
      the node description

    • isOptional

      public boolean isOptional()
      Returns the OPC UA optional status.
      Returns:
      the optional status

    • toString

      public String toString()
      Formats the respective OPC UA type in IVML.
      Overrides:
      toString in class Object
      Returns:
      the IVML representation of the OPC UA type

    • formatNodeId

      public static String formatNodeId(String nodeId)
      Formats a node id in IVML.
      Parameters:
      nodeId - the node id
      Returns:
      the IVML representation of a node id

    • validateVarName

      public static String validateVarName(String varName)
      Validates and fixes a variable name.
      Parameters:
      varName - the variable name
      Returns:
      the (potentially modified) variable name