Public Member Functions | Private Member Functions | Static Private Attributes | List of all members
gnsstk::SP3SatID Class Reference

Detailed Description

Todo:
determine if this really belongs with the SP3 files

Definition at line 63 of file SP3SatID.hpp.

#include <SP3SatID.hpp>

Inheritance diagram for gnsstk::SP3SatID:
Inheritance graph
[legend]

Public Member Functions

void fromString (const std::string s)
 
char getfill () noexcept
 get the fill character used in output More...
 
bool operator!= (const SP3SatID &right) const
 operator != for SP3SatID More...
 
bool operator< (const SP3SatID &right) const
 operator < (less than) for SP3SatID : order by system, then number More...
 
bool operator<= (const SP3SatID &right) const
 operator <= (less than or equal) for SP3SatID More...
 
bool operator== (const SP3SatID &right) const
 operator == for SP3SatID More...
 
bool operator> (const SP3SatID &right) const
 operator > (greater than) for SP3SatID More...
 
bool operator>= (const SP3SatID &right) const
 operator >= (greater than or equal) for SP3SatID More...
 
char setfill (char c) noexcept
 
 SP3SatID ()=default
 empty constructor, creates an invalid object More...
 
 SP3SatID (const SatID &sat) noexcept
 cast SatID to SP3SatID More...
 
 SP3SatID (const std::string &str)
 
 SP3SatID (int p, SatelliteSystem s) noexcept
 explicit constructor, no defaults, SP3 systems only More...
 
char systemChar () const noexcept
 
std::string systemString () const noexcept
 
std::string toString () const noexcept
 convert to string More...
 
- Public Member Functions inherited from gnsstk::SatID
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)
 

Private Member Functions

void validate ()
 If an unsupported system is used, set to unknown and PRN -1. More...
 

Static Private Attributes

static GNSSTK_EXPORT char fillchar = '0'
 fill character used during stream output More...
 

Additional Inherited Members

- Public Attributes inherited from gnsstk::SatID
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

◆ SP3SatID() [1/4]

gnsstk::SP3SatID::SP3SatID ( )
default

empty constructor, creates an invalid object

◆ SP3SatID() [2/4]

gnsstk::SP3SatID::SP3SatID ( int  p,
SatelliteSystem  s 
)
noexcept

explicit constructor, no defaults, SP3 systems only

Definition at line 52 of file SP3SatID.cpp.

◆ SP3SatID() [3/4]

gnsstk::SP3SatID::SP3SatID ( const std::string &  str)
inline

constructor from string

Exceptions
Exception

Definition at line 76 of file SP3SatID.hpp.

◆ SP3SatID() [4/4]

gnsstk::SP3SatID::SP3SatID ( const SatID sat)
inlinenoexcept

cast SatID to SP3SatID

Definition at line 83 of file SP3SatID.hpp.

Member Function Documentation

◆ fromString()

void gnsstk::SP3SatID::fromString ( const std::string  s)

read from string

Note
GPS is default system (no or unknown system char)
Exceptions
Exception

Definition at line 95 of file SP3SatID.cpp.

◆ getfill()

char gnsstk::SP3SatID::getfill ( )
inlinenoexcept

get the fill character used in output

Definition at line 93 of file SP3SatID.hpp.

◆ operator!=()

bool gnsstk::SP3SatID::operator!= ( const SP3SatID right) const
inline

operator != for SP3SatID

Definition at line 105 of file SP3SatID.hpp.

◆ operator<()

bool gnsstk::SP3SatID::operator< ( const SP3SatID right) const
inline

operator < (less than) for SP3SatID : order by system, then number

Definition at line 111 of file SP3SatID.hpp.

◆ operator<=()

bool gnsstk::SP3SatID::operator<= ( const SP3SatID right) const
inline

operator <= (less than or equal) for SP3SatID

Definition at line 131 of file SP3SatID.hpp.

◆ operator==()

bool gnsstk::SP3SatID::operator== ( const SP3SatID right) const
inline

operator == for SP3SatID

Definition at line 99 of file SP3SatID.hpp.

◆ operator>()

bool gnsstk::SP3SatID::operator> ( const SP3SatID right) const
inline

operator > (greater than) for SP3SatID

Definition at line 119 of file SP3SatID.hpp.

◆ operator>=()

bool gnsstk::SP3SatID::operator>= ( const SP3SatID right) const
inline

operator >= (greater than or equal) for SP3SatID

Definition at line 125 of file SP3SatID.hpp.

◆ setfill()

char gnsstk::SP3SatID::setfill ( char  c)
inlinenoexcept

set the fill character used in output return the current fill character

Definition at line 89 of file SP3SatID.hpp.

◆ systemChar()

char gnsstk::SP3SatID::systemChar ( ) const
noexcept

return a character based on the system return the single-character system descriptor

Note
return only SP3 types, for non-SP3 systems return '?'

Definition at line 60 of file SP3SatID.cpp.

◆ systemString()

std::string gnsstk::SP3SatID::systemString ( ) const
noexcept

Definition at line 78 of file SP3SatID.cpp.

◆ toString()

std::string gnsstk::SP3SatID::toString ( ) const
noexcept

convert to string

Definition at line 159 of file SP3SatID.cpp.

◆ validate()

void gnsstk::SP3SatID::validate ( )
private

If an unsupported system is used, set to unknown and PRN -1.

Definition at line 178 of file SP3SatID.cpp.

Member Data Documentation

◆ fillchar

char gnsstk::SP3SatID::fillchar = '0'
staticprivate

fill character used during stream output

Definition at line 157 of file SP3SatID.hpp.


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


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:46