Interface StandardField


  • public interface StandardField
    Generate introspection object for standard fields.
    Author:
    mrk
    • Method Detail

      • scalar

        Structure scalar​(ScalarType scalarType,
                         String properties)
        Create a Scalar field with additional properties.
        Parameters:
        scalarType - the scalar type
        properties - the list of additional properties, which is some combination of the strings alarm, timeStamp, display, control and valueAlarm separated by commas
        Returns:
        the Scalar
      • scalarArray

        Structure scalarArray​(ScalarType elementType,
                              String properties)
        Create a ScalarArray with additional properties.
        Parameters:
        elementType - the scalar type for each element
        properties - the list of additional properties, which is some combination of the strings alarm, timeStamp, display, control and valueAlarm separated by commas
        Returns:
        the ScalarArray
      • structureArray

        Structure structureArray​(Structure structure,
                                 String properties)
        Create a StructureArray.
        Parameters:
        structure - the introspection interface for each array element.
        properties - the list of additional properties, which is some combination of the strings alarm and timeStamp separated by commas
        Returns:
        the StructureArray
      • enumerated

        Structure enumerated()
        Create an enumerated structure.
        Returns:
        the enumerated type Structure
      • enumerated

        Structure enumerated​(String properties)
        Create a structure that has an enumerated structure with name value an additional properties.
        Parameters:
        properties - the additional properties
        Returns:
        a structure that has an enumerated structure field with name value and the additional properties
      • alarm

        Structure alarm()
        Returns:
        the Structure object of an alarm field
      • timeStamp

        Structure timeStamp()
        Returns:
        the Structure object of a time stamp field
      • display

        Structure display()
        Returns:
        the Structure object of a display field
      • control

        Structure control()
        Returns:
        the Structure object of a control field
      • booleanAlarm

        Structure booleanAlarm()
        Returns:
        the Structure object of a boolean value alarm limit field
      • byteAlarm

        Structure byteAlarm()
        Returns:
        the Structure object of a byte value alarm limit field
      • shortAlarm

        Structure shortAlarm()
        Returns:
        the Structure object of a short value alarm limit field
      • intAlarm

        Structure intAlarm()
        Returns:
        the Structure object of an int value alarm limit field
      • longAlarm

        Structure longAlarm()
        Returns:
        the Structure object of a long value alarm limit field
      • floatAlarm

        Structure floatAlarm()
        Returns:
        the Structure object of a float value alarm limit field
      • doubleAlarm

        Structure doubleAlarm()
        Returns:
        the Structure object of a double value alarm limit field
      • enumeratedAlarm

        Structure enumeratedAlarm()
        Returns:
        the Structure object of an enumerated value alarm limit field