fpsdk::common::gnss::SatSig Struct Reference

Satellite plus frequency band and signal ("satsig"), suitable for indexing and sorting. More...

#include <gnss.hpp>

Public Member Functions
	SatSig ()=default
	Default ctor: invalid SatSig (INVALID_SATSIG)
	SatSig (const Gnss gnss, const SvNr svnr, const Band band, const Signal signal)
	Ctor: create SatSig.
	SatSig (const Sat sat, const Signal signal)
	Ctor: create SatSig.
Sat	GetSat () const
	Get satellite.
Gnss	GetGnss () const
	Get GNSS.
SvNr	GetSvNr () const
	Get satellite number.
Band	GetBand () const
	Get band.
Signal	GetSignal () const
	Get signal.
bool	operator< (const SatSig &rhs) const
	Less-than operator.
bool	operator== (const SatSig &rhs) const
	Equal operator.
bool	operator!= (const SatSig &rhs) const
	Not equal operator.

Public Attributes
uint32_t	id_ = 0x00000000
	Internal representation of Gnss+SvNr+Band+Signal.

Detailed Description

Satellite plus frequency band and signal ("satsig"), suitable for indexing and sorting.

Definition at line 397 of file gnss.hpp.

Constructor & Destructor Documentation

SatSig() [1/2]

fpsdk::common::gnss::SatSig::SatSig ( const Gnss gnss, const SvNr svnr, const Band band, const Signal signal )

inline

Ctor: create SatSig.

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
[in]	band	Frequency band
[in]	signal	Signal

Definition at line 414 of file gnss.hpp.

References id_.

SatSig() [2/2]

fpsdk::common::gnss::SatSig::SatSig ( const Sat sat, const Signal signal )

inline

Ctor: create SatSig.

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]	sat	Satellite (GNSS + satellite number)
[in]	signal	Signal (implies band)

Definition at line 424 of file gnss.hpp.

References id_, and fpsdk::common::gnss::SignalToBand().

Member Function Documentation

GetSat()

Sat fpsdk::common::gnss::SatSig::GetSat ( ) const

inline

Get satellite.

Returns

the satellite

Definition at line 431 of file gnss.hpp.

References GetGnss(), and GetSvNr().

GetGnss()

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

inline

Get GNSS.

Returns

the GNSS

Definition at line 438 of file gnss.hpp.

References id_.

Referenced by GetSat().

GetSvNr()

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

inline

Get satellite number.

Returns

the satellite number

Definition at line 445 of file gnss.hpp.

References id_.

Referenced by GetSat().

GetBand()

Band fpsdk::common::gnss::SatSig::GetBand ( ) const

inline

Get band.

Returns

the band

Definition at line 452 of file gnss.hpp.

References id_.

GetSignal()

Signal fpsdk::common::gnss::SatSig::GetSignal ( ) const

inline

Get signal.

Returns

the signal

Definition at line 459 of file gnss.hpp.

References id_.

operator<()

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

inline

Less-than operator.

Definition at line 463 of file gnss.hpp.

References id_, and SatSig().

operator==()

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

inline

Equal operator.

Definition at line 464 of file gnss.hpp.

References id_, and SatSig().

operator!=()

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

inline

Not equal operator.

Definition at line 465 of file gnss.hpp.

References id_, and SatSig().

Member Data Documentation

id_

uint32_t fpsdk::common::gnss::SatSig::id_ = 0x00000000

Internal representation of Gnss+SvNr+Band+Signal.

Definition at line 461 of file gnss.hpp.

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

---

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

• fpsdk_common/include/fpsdk_common/gnss.hpp