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

Class BaseType

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String browseName  
      private java.lang.String description  
      private java.lang.String displayName  
      private java.lang.String nodeId  
      private boolean optional  
      private java.lang.String varName  

    • Constructor Summary

      Constructors 
      Constructor Description
      BaseType​(java.lang.String nodeId, java.lang.String browseName, java.lang.String displayname, java.lang.String description, boolean optional)
      Creates an OPC UA type representation.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String formatNodeId​(java.lang.String nodeId)
      Formats a node id in IVML.
      java.lang.String getBrowseName()
      Returns the OPC UA browse name.
      java.lang.String getDescription()
      Returns the OPC UA node description.
      java.lang.String getDisplayname()
      Returns the OPC UA display name.
      java.lang.String getNodeId()
      Returns the OPC UA node id.
      java.lang.String getVarName()
      Returns the (IVML) variable name.
      boolean isOptional()
      Returns the OPC UA optional status.
      void setVarName​(java.lang.String varName)
      Defines the (IVML) variable name.
      java.lang.String toString()
      Formats the respective OPC UA type in IVML.
      static java.lang.String validateVarName​(java.lang.String varName)
      Validates and fixes a variable name.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • varName

        private java.lang.String varName

      • nodeId

        private java.lang.String nodeId

      • browseName

        private java.lang.String browseName

      • displayName

        private java.lang.String displayName

      • description

        private java.lang.String description

      • optional

        private boolean optional

    • Constructor Detail

      • BaseType

        public BaseType​(java.lang.String nodeId,
                java.lang.String browseName,
                java.lang.String displayname,
                java.lang.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 Detail

      • getVarName

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

      • setVarName

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

      • getNodeId

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

      • getBrowseName

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

      • getDisplayname

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

      • getDescription

        public java.lang.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 java.lang.String toString()
        Formats the respective OPC UA type in IVML.
        Overrides:
        toString in class java.lang.Object
        Returns:
        the IVML representation of the OPC UA type

      • formatNodeId

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

      • validateVarName

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