#include <flxDevGNSS.h>

Inheritance diagram for flxDevGNSS:

Public Member Functions
	flxDevGNSS ()

bool	onInitialize (TwoWire &)

uint32_t	get_epoch (void)

void	set_epoch (const uint32_t &refEpoch)

bool	valid_epoch (void)

Public Member Functions inherited from flxDeviceI2CType< flxDevGNSS >
virtual uint8_t	getDefaultAddress (void)

bool	initialize (TwoWire &wirePort)

bool	initialize (flxBusI2C &i2cDriver)

bool	initialize (void)

bool	initialize (uint8_t address)

virtual bool	onInitialize (TwoWire &)

flxTypeID	getType (void)

bool	isType (flxTypeID type)

flxDeviceKind_t	getKind (void)

Public Member Functions inherited from flxDevice
	flxDevice ()

virtual	~flxDevice ()

virtual bool	execute (void)
	Virtual method called to run the operation - called before data is retrieved. More...

bool	initialize ()

virtual bool	initialize (flxBusI2C &)

virtual bool	initialize (flxBusSPI &)

bool	autoload (void)

void	setAutoload ()

void	setAddress (uint8_t address)

uint8_t	address (void)

void	addAddressToName ()

void	setIsInitialized (bool isInit)

bool	isInitialized (void)

virtual flxDeviceKind_t	getKind (void)

Public Member Functions inherited from flxOperation
virtual flxTypeID	getType (void)

virtual bool	execute (void)
	Virtual method called to run the operation - called before data is retrieved. More...

virtual bool	onSave (flxStorageBlock *stBlk)

virtual bool	onRestore (flxStorageBlock *stBlk)

Public Member Functions inherited from flxObject
	flxObject ()

virtual	~flxObject ()

void	setParent (flxObject *parent)

void	setParent (flxObject &parent)

flxObject *	parent ()

void	setHidden (bool bHide=true)

bool	hidden ()

void	setIsDirty (bool bDirty=true)

bool	isDirty (void)

virtual bool	onSave (flxStorageBlock *stBlk)

virtual bool	save (flxStorage *pStorage)

virtual bool	onRestore (flxStorageBlock *stBlk)

virtual bool	restore (flxStorage *pStorage)

virtual flxTypeID	getType (void)

virtual bool	save (flxStorage *)=0

virtual bool	restore (flxStorage *)=0

Public Member Functions inherited from _flxPropertyContainer
	_flxPropertyContainer ()

void	addProperty (flxProperty *newProperty)

void	addProperty (flxProperty &newProperty)

void	removeProperty (flxProperty *rmProp)

void	removeProperty (flxProperty &rmProp)

flxPropertyList &	getProperties (void)

uint	nProperties (void)

bool	saveProperties (flxStorageBlock *stBlk)

bool	restoreProperties (flxStorageBlock *stBlk)

size_t	propertySaveSize ()

void	hideProperty (flxProperty &theProp)

Public Member Functions inherited from flxDescriptor
	flxDescriptor ()

void	setName (const char *new_name)
	Set the Name object - storing the pointer to the provided string No allocation is performed. If the previous name was allocated, it is freed. More...

void	setName (const char new_name, const char new_desc)
	Set the Name object and the Description for the object. Both strings are constants. More...

void	setName (char *new_name)
	Set the Name object, but makes a copy of the input string since the input is not const. If the previous name was allocated, it is freed. More...

const char *	name ()
	Return a const char pointer to the name of the object. More...

std::string	name_ (void)
	Returns a std::string of the name of the object. More...

void	setDescription (const char *new_desc)
	Set the Description object - the input value is constant and not copied. If the previous description was allocated, it is freed. More...

void	setDescription (char *new_desc)
	Set the Description object - the input value is not constant and is copied. If the previous description was allocated, it is freed. More...

const char *	description ()
	Return the constant C string pointer to the description of the object. More...

std::string	description_ (void)
	Return the description of the object as a std::string. More...

void	setTitle (const char *title)
	Set the Title object - the title is optional and is used mostly for UX or organizational purposes. The input value is constant and not copied. If the previous title was allocated, it is freed. More...

void	setTitleAlloc (char *new_title)
	Set the Title of the object , but make an explict copy of the provided string. More...

const char *	title (void)
	Return the C constant string pointer to the title of the object. More...

Public Member Functions inherited from _flxParameterContainer
void	addParameter (flxParameterIn *newParam, bool head=false)

void	addParameter (flxParameterIn &newParam, bool head=false)

void	removeParameter (flxParameterIn *rmParam)

void	removeParameter (flxParameterIn &rmParam)

size_t	nInputParameters ()

void	addParameter (flxParameterOut *newParam, bool head=false)

void	addParameter (flxParameterOut &newParam, bool head=false)

void	removeParameter (flxParameterOut *rmParam)

void	removeParameter (flxParameterOut &rmParam)

size_t	nOutputParameters ()

flxParameterOutList &	getOutputParameters (void)

flxParameterInList &	getInputParameters (void)

virtual uint32_t	get_epoch (void)=0

virtual void	set_epoch (const uint32_t &)=0

virtual bool	valid_epoch (void)=0

Static Public Member Functions
static bool	isConnected (flxBusI2C &i2cDriver, uint8_t address)

static flxDeviceConfidence_t	connectedConfidence (void)

static const char *	getDeviceName ()

static const uint8_t *	getDefaultAddresses ()

Static Public Member Functions inherited from flxDeviceI2CType< flxDevGNSS >
static flxTypeID	type (void)

static flxDeviceKind_t	kind (void)

Static Public Member Functions inherited from flxObject
static flxTypeID	type (void)

Public Attributes
flxPropertyRWUInt32< flxDevGNSS, &flxDevGNSS::get_measurement_rate, &flxDevGNSS::set_measurement_rate >	measurementRate

flxParameterInVoid< flxDevGNSS, &flxDevGNSS::factory_default >	factoryDefault

flxParameterOutUInt32< flxDevGNSS, &flxDevGNSS::read_year >	year

flxParameterOutUInt32< flxDevGNSS, &flxDevGNSS::read_month >	month

flxParameterOutUInt32< flxDevGNSS, &flxDevGNSS::read_day >	day

flxParameterOutUInt32< flxDevGNSS, &flxDevGNSS::read_hour >	hour

flxParameterOutUInt32< flxDevGNSS, &flxDevGNSS::read_min >	min

flxParameterOutUInt32< flxDevGNSS, &flxDevGNSS::read_sec >	sec

flxParameterOutDouble< flxDevGNSS, &flxDevGNSS::read_latitude >	latitude

flxParameterOutDouble< flxDevGNSS, &flxDevGNSS::read_longitude >	longitude

flxParameterOutDouble< flxDevGNSS, &flxDevGNSS::read_altitude >	altitude

flxParameterOutDouble< flxDevGNSS, &flxDevGNSS::read_altitude_msl >	altitudeMSL

flxParameterOutUInt32< flxDevGNSS, &flxDevGNSS::read_siv >	SIV

flxParameterOutUInt32< flxDevGNSS, &flxDevGNSS::read_fix >	fixType

flxParameterOutUInt32< flxDevGNSS, &flxDevGNSS::read_carrier_soln >	carrierSolution

flxParameterOutFloat< flxDevGNSS, &flxDevGNSS::read_ground_speed >	groundSpeed

flxParameterOutFloat< flxDevGNSS, &flxDevGNSS::read_heading >	heading

flxParameterOutFloat< flxDevGNSS, &flxDevGNSS::read_pdop >	PDOP

flxParameterOutFloat< flxDevGNSS, &flxDevGNSS::read_horiz_acc >	horizontalAccEst

flxParameterOutFloat< flxDevGNSS, &flxDevGNSS::read_vert_acc >	verticalAccEst

flxParameterOutUInt32< flxDevGNSS, &flxDevGNSS::read_tow >	TOW

flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_iso8601 >	iso8601

flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_yyyy_mm_dd >	YYYYMMDD

flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_yyyy_dd_mm >	YYYYDDMM

flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_dd_mm_yyyy >	DDMMYYYY

flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_hh_mm_ss >	HHMMSS

flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_fix_string >	fixTypeStr

flxParameterOutString< flxDevGNSS, &flxDevGNSS::read_carrier_soln_string >	carrierSolutionStr

Public Attributes inherited from flxDevice
flxParameterInVoid< flxDevice, &flxDevice::disable_all_parameters >	disableAllParameters

flxParameterInVoid< flxDevice, &flxDevice::enable_all_parameters >	enableAllParameters

Static Public Attributes
static uint8_t	defaultDeviceAddress [] = {kGNSSAddressDefault, kSparkDeviceAddressNull}

Additional Inherited Members
Protected Attributes inherited from flxDescriptor
const char *	_name

bool	_nameAlloc

const char *	_desc

bool	_descAlloc

const char *	_title

bool	_titleAlloc

Constructor & Destructor Documentation

◆ flxDevGNSS()

flxDevGNSS::flxDevGNSS ( )

Member Function Documentation

◆ connectedConfidence()

static flxDeviceConfidence_t flxDevGNSS::connectedConfidence ( void )

inlinestatic

◆ get_epoch()

uint32_t flxDevGNSS::get_epoch ( void )

inlinevirtual

Implements flxIClock.

◆ getDefaultAddresses()

static const uint8_t * flxDevGNSS::getDefaultAddresses ( )

inlinestatic

◆ getDeviceName()

static const char * flxDevGNSS::getDeviceName ( )

inlinestatic

◆ isConnected()

bool flxDevGNSS::isConnected	(	flxBusI2C &	i2cDriver,
		uint8_t	address
	)

static

◆ onInitialize()

bool flxDevGNSS::onInitialize ( TwoWire & wirePort )

virtual

Reimplemented from flxDeviceI2CType< flxDevGNSS >.

◆ set_epoch()

void flxDevGNSS::set_epoch ( const uint32_t & refEpoch )

inlinevirtual

Implements flxIClock.

◆ valid_epoch()

bool flxDevGNSS::valid_epoch ( void )

inlinevirtual

Implements flxIClock.

Member Data Documentation

◆ altitude

flxParameterOutDouble<flxDevGNSS, &flxDevGNSS::read_altitude> flxDevGNSS::altitude

◆ altitudeMSL

flxParameterOutDouble<flxDevGNSS, &flxDevGNSS::read_altitude_msl> flxDevGNSS::altitudeMSL

◆ carrierSolution

flxParameterOutUInt32<flxDevGNSS, &flxDevGNSS::read_carrier_soln> flxDevGNSS::carrierSolution

◆ carrierSolutionStr

flxParameterOutString<flxDevGNSS, &flxDevGNSS::read_carrier_soln_string> flxDevGNSS::carrierSolutionStr

◆ day

flxParameterOutUInt32<flxDevGNSS, &flxDevGNSS::read_day> flxDevGNSS::day

◆ DDMMYYYY

flxParameterOutString<flxDevGNSS, &flxDevGNSS::read_dd_mm_yyyy> flxDevGNSS::DDMMYYYY

◆ defaultDeviceAddress

uint8_t flxDevGNSS::defaultDeviceAddress = {kGNSSAddressDefault, kSparkDeviceAddressNull}

static

◆ factoryDefault

flxParameterInVoid<flxDevGNSS, &flxDevGNSS::factory_default> flxDevGNSS::factoryDefault

◆ fixType

flxParameterOutUInt32<flxDevGNSS, &flxDevGNSS::read_fix> flxDevGNSS::fixType

◆ fixTypeStr

flxParameterOutString<flxDevGNSS, &flxDevGNSS::read_fix_string> flxDevGNSS::fixTypeStr

◆ groundSpeed

flxParameterOutFloat<flxDevGNSS, &flxDevGNSS::read_ground_speed> flxDevGNSS::groundSpeed

◆ heading

flxParameterOutFloat<flxDevGNSS, &flxDevGNSS::read_heading> flxDevGNSS::heading

◆ HHMMSS

flxParameterOutString<flxDevGNSS, &flxDevGNSS::read_hh_mm_ss> flxDevGNSS::HHMMSS

◆ horizontalAccEst

flxParameterOutFloat<flxDevGNSS, &flxDevGNSS::read_horiz_acc> flxDevGNSS::horizontalAccEst

◆ hour

flxParameterOutUInt32<flxDevGNSS, &flxDevGNSS::read_hour> flxDevGNSS::hour

◆ iso8601

flxParameterOutString<flxDevGNSS, &flxDevGNSS::read_iso8601> flxDevGNSS::iso8601

◆ latitude

flxParameterOutDouble<flxDevGNSS, &flxDevGNSS::read_latitude> flxDevGNSS::latitude

◆ longitude

flxParameterOutDouble<flxDevGNSS, &flxDevGNSS::read_longitude> flxDevGNSS::longitude

◆ measurementRate

flxPropertyRWUInt32<flxDevGNSS, &flxDevGNSS::get_measurement_rate, &flxDevGNSS::set_measurement_rate> flxDevGNSS::measurementRate

◆ min

flxParameterOutUInt32<flxDevGNSS, &flxDevGNSS::read_min> flxDevGNSS::min

◆ month

flxParameterOutUInt32<flxDevGNSS, &flxDevGNSS::read_month> flxDevGNSS::month

◆ PDOP

flxParameterOutFloat<flxDevGNSS, &flxDevGNSS::read_pdop> flxDevGNSS::PDOP

◆ sec

flxParameterOutUInt32<flxDevGNSS, &flxDevGNSS::read_sec> flxDevGNSS::sec

◆ SIV

flxParameterOutUInt32<flxDevGNSS, &flxDevGNSS::read_siv> flxDevGNSS::SIV

◆ TOW

flxParameterOutUInt32<flxDevGNSS, &flxDevGNSS::read_tow> flxDevGNSS::TOW

◆ verticalAccEst

flxParameterOutFloat<flxDevGNSS, &flxDevGNSS::read_vert_acc> flxDevGNSS::verticalAccEst

◆ year

flxParameterOutUInt32<flxDevGNSS, &flxDevGNSS::read_year> flxDevGNSS::year

◆ YYYYDDMM

flxParameterOutString<flxDevGNSS, &flxDevGNSS::read_yyyy_dd_mm> flxDevGNSS::YYYYDDMM

◆ YYYYMMDD

flxParameterOutString<flxDevGNSS, &flxDevGNSS::read_yyyy_mm_dd> flxDevGNSS::YYYYMMDD

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

src/device/device_gnss/flxDevGNSS.h
src/device/device_gnss/flxDevGNSS.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ flxDevGNSS()

Member Function Documentation

◆ connectedConfidence()

◆ get_epoch()

◆ getDefaultAddresses()

◆ getDeviceName()

◆ isConnected()

◆ onInitialize()

◆ set_epoch()

◆ valid_epoch()

Member Data Documentation

◆ altitude

◆ altitudeMSL

◆ carrierSolution

◆ carrierSolutionStr

◆ day

◆ DDMMYYYY

◆ defaultDeviceAddress

◆ factoryDefault

◆ fixType

◆ fixTypeStr

◆ groundSpeed

◆ heading

◆ HHMMSS

◆ horizontalAccEst

◆ hour

◆ iso8601

◆ latitude

◆ longitude

◆ measurementRate

◆ min

◆ month

◆ PDOP

◆ sec

◆ SIV

◆ TOW

◆ verticalAccEst

◆ year

◆ YYYYDDMM

◆ YYYYMMDD