fpsdk::common::gnss::Sat Struct Reference

Satellite ("sat"), consisting of GNSS and satellite number, suitable for indexing and sorting. More...

#include <gnss.hpp>

Public Member Functions
	Sat ()=default
	Default ctor: invalid satellite (INVALID_SAT)
	Sat (const Gnss gnss, const SvNr svnr)
	Ctor: from GNSS and satellite number.
	Sat (const char *str)
	Ctor: from string.
Gnss	GetGnss () const
	Get GNSS.
SvNr	GetSvNr () const
	Get satellite number.
const char *	GetStr () const
	Stringify satellite.
bool	operator< (const Sat &rhs) const
	Less-than operator.
bool	operator== (const Sat &rhs) const
	Equal operator.
bool	operator!= (const Sat &rhs) const
	Not equal operator.

Public Attributes
uint16_t	id_ = 0x0000
	Internal representation of Gnss+SvNr.

Detailed Description

Satellite ("sat"), consisting of GNSS and satellite number, suitable for indexing and sorting.

Definition at line 334 of file gnss.hpp.

Constructor & Destructor Documentation

Sat() [1/2]

fpsdk::common::gnss::Sat::Sat ( const Gnss gnss, const SvNr svnr )

inline

Ctor: from GNSS and satellite number.

Note

This does not do any range checking and it's up to the user to provide a valid satellite ID for the given GNSS.

Parameters

[in]	gnss	GNSS
[in]	svnr	Satellite number

Definition at line 349 of file gnss.hpp.

References id_.

Sat() [2/2]

fpsdk::common::gnss::Sat::Sat

(

const char *

str

)

Ctor: from string.

Note

Invalid strings create an INVALID_SAT

Parameters

[in]

str

The string ("G03", "R22", "C12", ...)

Member Function Documentation

GetGnss()

Gnss fpsdk::common::gnss::Sat::GetGnss ( ) const

inline

Get GNSS.

Returns

the GNSS

Definition at line 365 of file gnss.hpp.

References id_.

GetSvNr()

SvNr fpsdk::common::gnss::Sat::GetSvNr ( ) const

inline

Get satellite number.

Returns

the satellit nuber

Definition at line 372 of file gnss.hpp.

References id_.

GetStr()

const char * fpsdk::common::gnss::Sat::GetStr

(

)

const

Stringify satellite.

Returns

a unique string identifying the satellite

operator<()

bool fpsdk::common::gnss::Sat::operator< ( const Sat & rhs ) const

inline

Less-than operator.

Definition at line 383 of file gnss.hpp.

References id_, and Sat().

operator==()

bool fpsdk::common::gnss::Sat::operator== ( const Sat & rhs ) const

inline

Equal operator.

Definition at line 384 of file gnss.hpp.

References id_, and Sat().

operator!=()

bool fpsdk::common::gnss::Sat::operator!= ( const Sat & rhs ) const

inline

Not equal operator.

Definition at line 385 of file gnss.hpp.

References id_, and Sat().

Member Data Documentation

id_

uint16_t fpsdk::common::gnss::Sat::id_ = 0x0000

Internal representation of Gnss+SvNr.

Definition at line 381 of file gnss.hpp.

Referenced by GetGnss(), GetSvNr(), operator!=(), std::hash< fpsdk::common::gnss::Sat >::operator()(), operator<(), operator==(), and Sat().

---

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

• fpsdk_common/include/fpsdk_common/gnss.hpp