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

Detailed Description

Todo:
determine if this really belongs with the RINEX files

Definition at line 63 of file RinexSatID.hpp.

#include <RinexSatID.hpp>

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

Public Member Functions

void fromString (const std::string &s)
 
char getfill () const noexcept
 Get the fill character used in output. More...
 
 RinexSatID ()=default
 Empty constructor; creates an invalid object (Unknown, ID = -1). More...
 
 RinexSatID (const SatID &sat) noexcept
 Cast a SatID to a RinexSatID. More...
 
 RinexSatID (const std::string &str)
 
 RinexSatID (int p, SatelliteSystem s) noexcept
 Explicit constructor, no defaults, RINEX systems only. More...
 
char setfill (char c) noexcept
 
char systemChar () const noexcept
 
std::string systemString () const noexcept
 
std::string systemString3 () const noexcept
 
std::string toString () const noexcept
 
- 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

◆ RinexSatID() [1/4]

gnsstk::RinexSatID::RinexSatID ( )
default

Empty constructor; creates an invalid object (Unknown, ID = -1).

◆ RinexSatID() [2/4]

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

Explicit constructor, no defaults, RINEX systems only.

Definition at line 53 of file RinexSatID.cpp.

◆ RinexSatID() [3/4]

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

Constructor from a string.

Exceptions
Exception

Definition at line 76 of file RinexSatID.hpp.

◆ RinexSatID() [4/4]

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

Cast a SatID to a RinexSatID.

Definition at line 83 of file RinexSatID.hpp.

Member Function Documentation

◆ fromString()

void gnsstk::RinexSatID::fromString ( const std::string &  s)

Set the RinexSatID from a string (1 character plus 2-digit integer).

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

Definition at line 122 of file RinexSatID.cpp.

◆ getfill()

char gnsstk::RinexSatID::getfill ( ) const
inlinenoexcept

Get the fill character used in output.

Definition at line 96 of file RinexSatID.hpp.

◆ setfill()

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

Set the fill character used in output and return the current fill character.

Definition at line 90 of file RinexSatID.hpp.

◆ systemChar()

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

Return the single-character system descriptor.

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

Definition at line 62 of file RinexSatID.cpp.

◆ systemString()

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

Definition at line 82 of file RinexSatID.cpp.

◆ systemString3()

std::string gnsstk::RinexSatID::systemString3 ( ) const
noexcept

Return the system name as a string of length 3.

Note
Return only RINEX types or 'Unknown'.

Definition at line 102 of file RinexSatID.cpp.

◆ toString()

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

Convert the RinexSatID to string (1 character plus 2-digit integer).

Definition at line 204 of file RinexSatID.cpp.

◆ validate()

void gnsstk::RinexSatID::validate ( )
private

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

Definition at line 239 of file RinexSatID.cpp.

Member Data Documentation

◆ fillchar

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

Fill character used during stream output.

Definition at line 138 of file RinexSatID.hpp.


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


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