GlSettings Class Reference

This class is used to set user configurable parameters within the GLL. More...

#include <glgpsapi.h>

List of all members.

Public Member Functions

virtual ~GlSettings (void)
 Define virtual destructor.
RF front end and hardware configuration
virtual void SetRfType (GL_RF_TYPE etRfType)=0
 Sets the RF type.
virtual void SetFrequencyPlan (GL_FREQ_PLAN eFreqPlan)=0
 Sets the frequency plan.
virtual void SetRfAtt (GL_RF_ATT eRfAtt)=0
 Sets the internal RF attenuator.
virtual void SetRfLoss (double dRfLoss)=0
 Signal loss in RF from antenna connector to the ME baseband (RF noise figure).
virtual void SetDegreeThresholdForPhn (float fDegreeThresholdForPhn)=0
virtual void SetPadNum (unsigned char ucPadNum)=0
 Number of zero bytes prepend to the very first packet (wake's up sleepy host cpu) Valid range is 0..63.
virtual void SetPMMSettings (unsigned short usPmm1secMs)=0
virtual void SetUartFlowControlSettings (etUartFlowControl eFlowControl, unsigned char ucXonChar, unsigned char ucXoffChar)=0
 UART Flow Control settings.
Logging configuration
virtual void SetLogFacMask (unsigned long lFacMask)=0
 Set the facility mask for log message generation See GL Logging facility and priority codes.
virtual void SetLogPriMask (unsigned long lPriMask)=0
 Set the mask level for log message.
Internal use only
virtual void SetDynamicMode (GL_DYNAMIC_MODE_SETTING etDynMode)=0
 Sets dynamic mode.
virtual void SetFeature (GL_FEATURE etFeature, bool bEnable)=0
 Enable features.
virtual void SetMeConfigParameters (const plain_char *pLine)=0
virtual void EnableLtoCbeeQATest ()=0
virtual void SetFarStart (bool bEnable, unsigned long ulTrustedPosAgeSec, unsigned long ulInvalidatePosAfterSec, unsigned long ulFarStartPeriodSec, unsigned long ulFarStartDurationSec)=0
virtual void SetNvMemWritePeriodMs (unsigned long ulNvMemWritePeriodMs)=0
 Periodically write to NVMEM (not needed in the case of graceful shutdowns) By default this is set to zero, which means that NVMEM will only be updated at critical points such as when shutting down.
virtual void SetAsstFlags (unsigned long ulMask)=0
 Suppress GLL's use of assistance data.
virtual void SetCntinOffsetPpb (signed short ssCntinOffsetPpb)=0
 Introduce an offset to the estimated frequency provided by count in.
virtual void SetGlnsHardwareDelayInMeters (const float afGlnsIntChnDelayInMeters[])=0
 Provide explicit hardware delays for glonass.
virtual void SetBurstMode (bool bEnable, unsigned char ucDummyBytes, unsigned char usMinimumDelayMs, unsigned char ucDummyByte, unsigned char ucCtrl, unsigned char ucPin, unsigned char ucPinPolarity)=0
 Sets the burst mode.
virtual void SetPlatformSpecificFlags (GL_PLATFORM_SPECIFIC_FLAGS otPlatformFlags)=0
 Set platform-specific flags.
virtual void DisableGpsMeasurementEngine (void)=0
 Disables the GPS Measurement engine. Call this method if there is no GPS chip connected to the host.
virtual void SetWait4UserTimeoutMs (unsigned long ulWait4UserTimeoutSeconds)=0
 Period to wait after completing last request before shutting down the engine.
virtual void SetWarmStandbyTimeoutsMs (unsigned long ulWarmStandbyTimeout1Seconds, unsigned long ulWarmStandbyTimeout2Seconds)=0
 Warm standby periods.
virtual void SetLsqEnableFlag (bool bEnableLsq)=0
 Specifies the use of Least Squares Method for position computation.
virtual void SetNotchFiltersConfiguration (const NOTCH_FILTER_CONFIG *const filters)=0
 Specifies the notch filters configuration.
virtual void SetAGCFreezeState (bool freeze)=0
 Specifies the AGC freeze enable / disable.
virtual void SetAGCForceValue (bool force, long value)=0
virtual void SetDbgParam (const plain_char(&acName)[GL_MAX_DBG_NAME_LEN], const plain_char(&acValue)[GL_MAX_DBG_VALUE_LEN])=0
 Specifies debug parameters.
virtual void SetTimeSyncGroupDelay (float fTimeSyncGroupDelay)=0
virtual void SetSyncInPolarityHigh (bool bPolarityHigh)=0
 Specifies SyncIn Pulse Polarity.
virtual void SetEnableLTEFilter (bool bEnableLteFilter)=0
 Specifies whether we need to program the LTE filter or not.
virtual void SetDbgMode (int iMode)=0
 Specifies certain debug modes.

Detailed Description

This class is used to set user configurable parameters within the GLL.


Member Function Documentation

virtual void GlSettings::SetAsstFlags ( unsigned long  ulMask) [pure virtual]

Suppress GLL's use of assistance data.

Parameters:
ulMasklogical OR of ASST_IGNORE_xxx flags. See the ASST_IGNORE_xxx for details.
virtual void GlSettings::SetBurstMode ( bool  bEnable,
unsigned char  ucDummyBytes,
unsigned char  usMinimumDelayMs,
unsigned char  ucDummyByte,
unsigned char  ucCtrl,
unsigned char  ucPin,
unsigned char  ucPinPolarity 
) [pure virtual]

Sets the burst mode.

If enabled, the ASIC communication will happen in burst.(Not supported for all platforms, check with your AE) Before the burst, ucDummyBytes will be sent, and the first data packet will be sent after usMinimumDelayMs milliseconds.

virtual void GlSettings::SetNvMemWritePeriodMs ( unsigned long  ulNvMemWritePeriodMs) [pure virtual]

Periodically write to NVMEM (not needed in the case of graceful shutdowns) By default this is set to zero, which means that NVMEM will only be updated at critical points such as when shutting down.

Parameters:
ulNvMemWritePeriodMs,:Period to write the NVMEM in milliseconds
virtual void GlSettings::SetPadNum ( unsigned char  ucPadNum) [pure virtual]

Number of zero bytes prepend to the very first packet (wake's up sleepy host cpu) Valid range is 0..63.

ucPadNum ~ (BAUDRATE * wakeup_latency_s) / 10

virtual void GlSettings::SetRfLoss ( double  dRfLoss) [pure virtual]

Signal loss in RF from antenna connector to the ME baseband (RF noise figure).

The GLL subtracts this value from the signal levels measured.

virtual void GlSettings::SetUartFlowControlSettings ( etUartFlowControl  eFlowControl,
unsigned char  ucXonChar,
unsigned char  ucXoffChar 
) [pure virtual]

UART Flow Control settings.

It might be needed for some chipset, check with your AE. Note that all Xon/Xoff are not allowed. The default settings should be used if possible (i.e. Xon == 0x11, Xoff == 0x13)


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines