Interface Sensor.Builder

    • Method Detail

      • fullyQualifiedName

        Sensor.Builder fullyQualifiedName​(String fullyQualifiedName)

        The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery.

        Parameters:
        fullyQualifiedName - The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dataType

        Sensor.Builder dataType​(String dataType)

        The specified data type of the sensor.

        Parameters:
        dataType - The specified data type of the sensor.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NodeDataType, NodeDataType
      • dataType

        Sensor.Builder dataType​(NodeDataType dataType)

        The specified data type of the sensor.

        Parameters:
        dataType - The specified data type of the sensor.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NodeDataType, NodeDataType
      • description

        Sensor.Builder description​(String description)

        A brief description of a sensor.

        Parameters:
        description - A brief description of a sensor.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • unit

        Sensor.Builder unit​(String unit)

        The scientific unit of measurement for data collected by the sensor.

        Parameters:
        unit - The scientific unit of measurement for data collected by the sensor.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • allowedValues

        Sensor.Builder allowedValues​(Collection<String> allowedValues)

        A list of possible values a sensor can take.

        Parameters:
        allowedValues - A list of possible values a sensor can take.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • allowedValues

        Sensor.Builder allowedValues​(String... allowedValues)

        A list of possible values a sensor can take.

        Parameters:
        allowedValues - A list of possible values a sensor can take.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • min

        Sensor.Builder min​(Double min)

        The specified possible minimum value of the sensor.

        Parameters:
        min - The specified possible minimum value of the sensor.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • max

        Sensor.Builder max​(Double max)

        The specified possible maximum value of the sensor.

        Parameters:
        max - The specified possible maximum value of the sensor.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • deprecationMessage

        Sensor.Builder deprecationMessage​(String deprecationMessage)

        The deprecation message for the node or the branch that was moved or deleted.

        Parameters:
        deprecationMessage - The deprecation message for the node or the branch that was moved or deleted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • comment

        Sensor.Builder comment​(String comment)

        A comment in addition to the description.

        Parameters:
        comment - A comment in addition to the description.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • structFullyQualifiedName

        Sensor.Builder structFullyQualifiedName​(String structFullyQualifiedName)

        The fully qualified name of the struct node for a sensor if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of a sensor might be Vehicle.ADAS.CameraStruct.

        Parameters:
        structFullyQualifiedName - The fully qualified name of the struct node for a sensor if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of a sensor might be Vehicle.ADAS.CameraStruct.
        Returns:
        Returns a reference to this object so that method calls can be chained together.