gnsstk::SatID Class Reference

Detailed Description

Class used to uniquely identify the transmitter of a signal being broadcast, either by satellite or by ground station (sometimes referred to as a "pseudolite"). The meaning of the identifier id depends on the context of the system. The meanings are as follows:

system	id
GPS	PRN ID
Galileo	?
Glonass	Slot Number
Geosync	PRN ID - 100
LEO	?
Transit	?
BeiDou	?
QZSS	PRN ID
IRNSS	?

For equality and ordering, any of the fields may be treated as a wildcard, which means that a wildcard value for a given field will match any other field value. The system and id fields use boolean flags (wildSys and wildId, respectively).

Todo:

Update the above table for the proper nomenclature for identification.

Definition at line 89 of file SatID.hpp.

#include <SatID.hpp>

Inheritance diagram for gnsstk::SatID:

Public Member Functions
void	dump (std::ostream &s) const
	Convenience output method. More...
bool	isValid () const
bool	isWild () const
	return true if any of the fields are set to match wildcards. More...
void	makeWild ()
bool	operator!= (const SatID &right) const
	operator != for SatID More...
bool	operator< (const SatID &right) const
	operator < for SatID : order by system, id More...
bool	operator<= (const SatID &right) const
	operator <= for SatID More...
bool	operator== (const SatID &right) const
	operator == for SatID More...
bool	operator> (const SatID &right) const
	operator > for SatID More...
bool	operator>= (const SatID &right) const
	operator >= for SatID More...
	SatID ()
	Initialize with invalid data with no wildcards. More...
	SatID (int p)
	SatID (int p, SatelliteSystem s)
	SatID (SatelliteSystem s)

Public Attributes
int	id
	Satellite identifier, e.g. PRN. More...
SatelliteSystem	system
	System for this satellite. More...
bool	wildId
	If true, any satellite matches. More...
bool	wildSys
	If true, any system matches. More...

Constructor & Destructor Documentation

SatID() [1/4]

gnsstk::SatID::SatID

(

)

Initialize with invalid data with no wildcards.

Definition at line 44 of file SatID.cpp.

SatID() [2/4]

gnsstk::SatID::SatID	(	int	p,
		SatelliteSystem	s
	)

explicit constructor, no defaults

Note

if s is given a default value here, some compilers will silently cast int to SatID.

Definition at line 52 of file SatID.cpp.

SatID() [3/4]

gnsstk::SatID::SatID ( int  p )

explicit

Initialize with a set id number and a wild system (weird).

Note

explicit keyword to prevent assignment with unexpected results.

Parameters

[in]

p

The satellite number to specifically match.

Definition at line 59 of file SatID.cpp.

SatID() [4/4]

gnsstk::SatID::SatID ( SatelliteSystem  s )

explicit

Initialize with a set system and a wild satellite number.

Note

explicit keyword to prevent assignment with unexpected results.

Parameters

[in]

s

The satellite system to specifically match.

Definition at line 67 of file SatID.cpp.

Member Function Documentation

dump()

void gnsstk::SatID::dump

(

std::ostream &

s

)

const

Convenience output method.

Definition at line 88 of file SatID.cpp.

isValid()

bool gnsstk::SatID::isValid

(

)

const

return true if this is a valid SatID

Note

assumes all id's are positive and less than 100; plus GPS id's are less than or equal to MAX_PRN (32).

this is not used internally in the gnsstk library

Definition at line 135 of file SatID.cpp.

isWild()

bool gnsstk::SatID::isWild

(

)

const

return true if any of the fields are set to match wildcards.

Definition at line 81 of file SatID.cpp.

makeWild()

void gnsstk::SatID::makeWild

(

)

Set all values to wildcard values, meaning that this SatID will equal any other SatID object. This method attempts to obviate knowledge about the details of wildcard implementation.

Definition at line 74 of file SatID.cpp.

operator!=()

bool gnsstk::SatID::operator!= ( const SatID &  right ) const

inline

operator != for SatID

Definition at line 130 of file SatID.hpp.

operator<()

bool gnsstk::SatID::operator<

(

const SatID &

right

)

const

operator < for SatID : order by system, id

Definition at line 113 of file SatID.cpp.

operator<=()

bool gnsstk::SatID::operator<= ( const SatID &  right ) const

inline

operator <= for SatID

Definition at line 141 of file SatID.hpp.

operator==()

bool gnsstk::SatID::operator==

(

const SatID &

right

)

const

operator == for SatID

Definition at line 103 of file SatID.cpp.

operator>()

bool gnsstk::SatID::operator> ( const SatID &  right ) const

inline

operator > for SatID

Definition at line 137 of file SatID.hpp.

operator>=()

bool gnsstk::SatID::operator>= ( const SatID &  right ) const

inline

operator >= for SatID

Definition at line 145 of file SatID.hpp.

Member Data Documentation

id

int gnsstk::SatID::id

Satellite identifier, e.g. PRN.

Definition at line 154 of file SatID.hpp.

system

SatelliteSystem gnsstk::SatID::system

System for this satellite.

Definition at line 156 of file SatID.hpp.

wildId

bool gnsstk::SatID::wildId

If true, any satellite matches.

Definition at line 155 of file SatID.hpp.

wildSys

bool gnsstk::SatID::wildSys

If true, any system matches.

Definition at line 157 of file SatID.hpp.

---

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

• SatID.hpp
• SatID.cpp