Class Gnss
- java.lang.Object
-
- software.amazon.awssdk.services.iotwireless.model.Gnss
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Gnss.Builder,Gnss>
@Generated("software.amazon.awssdk:codegen") public final class Gnss extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Gnss.Builder,Gnss>
Global navigation satellite system (GNSS) object used for positioning.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGnss.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FloatassistAltitude()Optional assistance altitude, which is the altitude of the device at capture time, specified in meters above the WGS84 reference ellipsoid.List<Float>assistPosition()Optional assistance position information, specified using latitude and longitude values in degrees.static Gnss.Builderbuilder()FloatcaptureTime()Optional parameter that gives an estimate of the time when the GNSS scan information is taken, in seconds GPS time (GPST).FloatcaptureTimeAccuracy()Optional value that gives the capture time estimate accuracy, in seconds.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAssistPosition()For responses, this returns true if the service returned a value for the AssistPosition property.inthashCode()Stringpayload()Payload that contains the GNSS scan result, or NAV message, in hexadecimal notation.List<SdkField<?>>sdkFields()static Class<? extends Gnss.Builder>serializableBuilderClass()Gnss.BuildertoBuilder()StringtoString()Returns a string representation of this object.Booleanuse2DSolver()Optional parameter that forces 2D solve, which modifies the positioning algorithm to a 2D solution problem.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
payload
public final String payload()
Payload that contains the GNSS scan result, or NAV message, in hexadecimal notation.
- Returns:
- Payload that contains the GNSS scan result, or NAV message, in hexadecimal notation.
-
captureTime
public final Float captureTime()
Optional parameter that gives an estimate of the time when the GNSS scan information is taken, in seconds GPS time (GPST). If capture time is not specified, the local server time is used.
- Returns:
- Optional parameter that gives an estimate of the time when the GNSS scan information is taken, in seconds GPS time (GPST). If capture time is not specified, the local server time is used.
-
captureTimeAccuracy
public final Float captureTimeAccuracy()
Optional value that gives the capture time estimate accuracy, in seconds. If capture time accuracy is not specified, default value of 300 is used.
- Returns:
- Optional value that gives the capture time estimate accuracy, in seconds. If capture time accuracy is not specified, default value of 300 is used.
-
hasAssistPosition
public final boolean hasAssistPosition()
For responses, this returns true if the service returned a value for the AssistPosition property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
assistPosition
public final List<Float> assistPosition()
Optional assistance position information, specified using latitude and longitude values in degrees. The coordinates are inside the WGS84 reference frame.
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
hasAssistPosition()method.- Returns:
- Optional assistance position information, specified using latitude and longitude values in degrees. The coordinates are inside the WGS84 reference frame.
-
assistAltitude
public final Float assistAltitude()
Optional assistance altitude, which is the altitude of the device at capture time, specified in meters above the WGS84 reference ellipsoid.
- Returns:
- Optional assistance altitude, which is the altitude of the device at capture time, specified in meters above the WGS84 reference ellipsoid.
-
use2DSolver
public final Boolean use2DSolver()
Optional parameter that forces 2D solve, which modifies the positioning algorithm to a 2D solution problem. When this parameter is specified, the assistance altitude should have an accuracy of at least 10 meters.
- Returns:
- Optional parameter that forces 2D solve, which modifies the positioning algorithm to a 2D solution problem. When this parameter is specified, the assistance altitude should have an accuracy of at least 10 meters.
-
toBuilder
public Gnss.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Gnss.Builder,Gnss>
-
builder
public static Gnss.Builder builder()
-
serializableBuilderClass
public static Class<? extends Gnss.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-