Class ROS2PrimitiveMessageDefinition
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ROS2PrimitiveMessageDefinition.Builder,
ROS2PrimitiveMessageDefinition>
Represents a ROS 2 compliant primitive type message of the complex data structure.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Double
offset()
The offset used to calculate the signal value.final ROS2PrimitiveType
The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.final String
The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.final Double
scaling()
A multiplier used to decode the message.static Class
<? extends ROS2PrimitiveMessageDefinition.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Long
An optional attribute specifying the upper bound forSTRING
andWSTRING
.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
primitiveType
The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
If the service returns an enum value that is not available in the current SDK version,
primitiveType
will returnROS2PrimitiveType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprimitiveTypeAsString()
.- Returns:
- The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
- See Also:
-
primitiveTypeAsString
The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
If the service returns an enum value that is not available in the current SDK version,
primitiveType
will returnROS2PrimitiveType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprimitiveTypeAsString()
.- Returns:
- The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
- See Also:
-
offset
The offset used to calculate the signal value. Combined with scaling, the calculation is
value = raw_value * scaling + offset
.- Returns:
- The offset used to calculate the signal value. Combined with scaling, the calculation is
value = raw_value * scaling + offset
.
-
scaling
A multiplier used to decode the message.
- Returns:
- A multiplier used to decode the message.
-
upperBound
An optional attribute specifying the upper bound for
STRING
andWSTRING
.- Returns:
- An optional attribute specifying the upper bound for
STRING
andWSTRING
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ROS2PrimitiveMessageDefinition.Builder,
ROS2PrimitiveMessageDefinition> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-