Class Sensor

    • Method Detail

      • fullyQualifiedName

        public final String fullyQualifiedName()

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

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

        public final String description()

        A brief description of a sensor.

        Returns:
        A brief description of a sensor.
      • unit

        public final String unit()

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

        Returns:
        The scientific unit of measurement for data collected by the sensor.
      • hasAllowedValues

        public final boolean hasAllowedValues()
        For responses, this returns true if the service returned a value for the AllowedValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • allowedValues

        public final List<String> allowedValues()

        A list of possible values a sensor can take.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowedValues() method.

        Returns:
        A list of possible values a sensor can take.
      • min

        public final Double min()

        The specified possible minimum value of the sensor.

        Returns:
        The specified possible minimum value of the sensor.
      • max

        public final Double max()

        The specified possible maximum value of the sensor.

        Returns:
        The specified possible maximum value of the sensor.
      • deprecationMessage

        public final String deprecationMessage()

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

        Returns:
        The deprecation message for the node or the branch that was moved or deleted.
      • comment

        public final String comment()

        A comment in addition to the description.

        Returns:
        A comment in addition to the description.
      • structFullyQualifiedName

        public final 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.

        Returns:
        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.
      • serializableBuilderClass

        public static Class<? extends Sensor.Builder> serializableBuilderClass()
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)