QuectelGnssRK::LocationConfiguration Class Reference

LocationConfiguration class to configure Location class options. More...

#include <QuectelGnssRK.h>

Public Member Functions
	LocationConfiguration ()
	Construct a new Location Configuration object.
	LocationConfiguration (LocationConfiguration &&)=default
	Construct a new Location Configuration object.
LocationConfiguration &	constellations (LocationConstellation constellations)
	Set GNSS constellations.
LocationConstellation	constellations () const
	Get GNSS constellations.
LocationConfiguration &	enableAntennaPower (pin_t pin)
	Set the pin assignment for GNSS antenna power.
pin_t	enableAntennaPower () const
	Get the pin assignment for GNSS antenna power.
LocationConfiguration &	hdopThreshold (int hdop)
	Set the HDOP threshold for a stable position fix.
int	hdopThreshold () const
	Get the HDOP threshold for a stable position fix.
LocationConfiguration &	haccThreshold (float hacc)
	Set the horizontal accuracy threshold, in meters, for a stable position fix (if supported)
float	haccThreshold () const
	Get the horizontal accuracy threshold, in meters, for a stable position fix (if supported)
LocationConfiguration &	maximumFixTime (unsigned int fixSeconds)
	Set the maximum amount of time to wait for a position fix.
unsigned int	maximumFixTime () const
	Get the maximum amount of time to wait for a position fix.
LocationConfiguration &	operator= (const LocationConfiguration &rhs)
	Copy an existing configuration object.

Detailed Description

LocationConfiguration class to configure Location class options.

Member Function Documentation

constellations() [1/2]

LocationConstellation QuectelGnssRK::LocationConfiguration::constellations ( ) const

inline

Get GNSS constellations.

Returns

LocationConstellation Bitmap of supported GNSS constellations

constellations() [2/2]

LocationConfiguration & QuectelGnssRK::LocationConfiguration::constellations ( LocationConstellation constellations )

inline

Set GNSS constellations.

Parameters

constellations

Bitmap of supported GNSS constellations

Returns

LocationConfiguration&

enableAntennaPower() [1/2]

pin_t QuectelGnssRK::LocationConfiguration::enableAntennaPower ( ) const

inline

Get the pin assignment for GNSS antenna power.

Returns

pin_t Powered at initialization

enableAntennaPower() [2/2]

LocationConfiguration & QuectelGnssRK::LocationConfiguration::enableAntennaPower ( pin_t pin )

inline

Set the pin assignment for GNSS antenna power.

Parameters

pin	Pin number to enable GNSS antenna power

Returns

LocationConfiguration&

haccThreshold() [1/2]

float QuectelGnssRK::LocationConfiguration::haccThreshold ( ) const

inline

Get the horizontal accuracy threshold, in meters, for a stable position fix (if supported)

Returns

float Value to check for position stability

haccThreshold() [2/2]

LocationConfiguration & QuectelGnssRK::LocationConfiguration::haccThreshold ( float hacc )

inline

Set the horizontal accuracy threshold, in meters, for a stable position fix (if supported)

Parameters

hacc	Value to check for position stability, 1.0 to 1000.0 meters

Returns

LocationConfiguration&

hdopThreshold() [1/2]

int QuectelGnssRK::LocationConfiguration::hdopThreshold ( ) const

inline

Get the HDOP threshold for a stable position fix.

Returns

int Value to check for position stability

hdopThreshold() [2/2]

LocationConfiguration & QuectelGnssRK::LocationConfiguration::hdopThreshold ( int hdop )

inline

Set the HDOP threshold for a stable position fix.

Parameters

hdop	Value to check for position stability, 0 to 100

Returns

LocationConfiguration&

maximumFixTime() [1/2]

unsigned int QuectelGnssRK::LocationConfiguration::maximumFixTime ( ) const

inline

Get the maximum amount of time to wait for a position fix.

Returns

Number of seconds to allow for a position fix

maximumFixTime() [2/2]

LocationConfiguration & QuectelGnssRK::LocationConfiguration::maximumFixTime ( unsigned int fixSeconds )

inline

Set the maximum amount of time to wait for a position fix.

Parameters

fixSeconds

Number of seconds to allow for a position fix

Returns

TrackerConfiguration&

operator=()

LocationConfiguration & QuectelGnssRK::LocationConfiguration::operator= ( const LocationConfiguration & rhs )

inline

Copy an existing configuration object.

Parameters

rhs

Returns

LocationConfiguration&

---

The documentation for this class was generated from the following file:

• src/QuectelGnssRK.h