SatID Class Reference

#include <SatID.hpp>

Inheritance diagram for SatID:

Inheritance graph
[legend]
List of all members.

Detailed Description

Satellite identifier consisting of a satellite number (PRN, etc.) and a satellite system.

Definition at line 60 of file SatID.hpp.

Public Types

enum  SatelliteSystem {
  systemGPS = 1, systemGalileo, systemGlonass, systemGeosync,
  systemLEO, systemTransit, systemCompass, systemMixed,
  systemUserDefined, systemUnknown
}
 Supported satellite systems. More...

Public Member Functions

 SatID ()
 empty constructor, creates an invalid object
 SatID (int p, SatelliteSystem s)
 explicit constructor, no defaults
void dump (std::ostream &s) const
 Convenience output method.
bool operator== (const SatID &right) const
 operator == for SatID
bool operator!= (const SatID &right) const
 operator != for SatID
bool operator< (const SatID &right) const
 operator < for SatID : order by system, then number
bool operator> (const SatID &right) const
 operator > for SatID
bool operator<= (const SatID &right) const
 operator <= for SatID
bool operator>= (const SatID &right) const
 operator >= for SatID
bool isValid () const
 return true if this is a valid SatID

Static Public Member Functions

std::string convertSatelliteSystemToString (SatelliteSystem s)
 Convenience method used by dump().

Public Attributes

int id
 satellite identifier, e.g. PRN
SatelliteSystem system
 system for this satellite


Member Enumeration Documentation

enum SatelliteSystem
 

Supported satellite systems.

Enumeration values:
systemGPS 
systemGalileo 
systemGlonass 
systemGeosync 
systemLEO 
systemTransit 
systemCompass 
systemMixed 
systemUserDefined 
systemUnknown 

Definition at line 64 of file SatID.hpp.


Constructor & Destructor Documentation

SatID  )  [inline]
 

empty constructor, creates an invalid object

Definition at line 79 of file SatID.hpp.

SatID int  p,
SatelliteSystem  s
[inline]
 

explicit constructor, no defaults

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

Definition at line 84 of file SatID.hpp.


Member Function Documentation

std::string convertSatelliteSystemToString SatelliteSystem  s  )  [inline, static]
 

Convenience method used by dump().

Definition at line 89 of file SatID.hpp.

void dump std::ostream &  s  )  const [inline]
 

Convenience output method.

Definition at line 108 of file SatID.hpp.

Referenced by gpstk::StringUtils::asString(), and gpstk::operator<<().

bool isValid void   )  const [inline]
 

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 gpstk library

Definition at line 145 of file SatID.hpp.

bool operator!= const SatID right  )  const [inline]
 

operator != for SatID

Definition at line 118 of file SatID.hpp.

References gpstk::operator==().

bool operator< const SatID right  )  const [inline]
 

operator < for SatID : order by system, then number

Definition at line 122 of file SatID.hpp.

References SatID::id, and SatID::system.

bool operator<= const SatID right  )  const [inline]
 

operator <= for SatID

Definition at line 134 of file SatID.hpp.

References gpstk::operator<(), and gpstk::operator==().

bool operator== const SatID right  )  const [inline]
 

operator == for SatID

Definition at line 114 of file SatID.hpp.

References SatID::id, and SatID::system.

bool operator> const SatID right  )  const [inline]
 

operator > for SatID

Definition at line 130 of file SatID.hpp.

References gpstk::operator<(), and gpstk::operator==().

bool operator>= const SatID right  )  const [inline]
 

operator >= for SatID

Definition at line 138 of file SatID.hpp.

References gpstk::operator<().


Member Data Documentation

int id
 

satellite identifier, e.g. PRN

Definition at line 159 of file SatID.hpp.

Referenced by GPSOrbElemStore::addOrbElem(), OWid::compare(), SDid::compare(), DDid::compare(), DDid::DDid(), ATSData::dump(), CommandLine::DumpConfiguration(), gpstk::makeMDPEpoch(), SP3SatID::operator<(), SatID::operator<(), SP3SatID::operator==(), SatID::operator==(), SP3Header::reallyPutRecord(), and Rinex3NavData::Rinex3NavData().

SatelliteSystem system
 

system for this satellite

Definition at line 160 of file SatID.hpp.

Referenced by gpstk::ConvertToTypeID(), DDid::DDid(), RinexObsHeader::dump(), Rinex3ObsHeader::dump(), SP3SatID::operator<(), SatID::operator<(), SP3SatID::operator==(), SatID::operator==(), and Rinex3NavHeader::setFileSystem().


The documentation for this class was generated from the following file:
Generated on Tue May 21 03:31:56 2013 for GPS ToolKit Software Library by  doxygen 1.3.9.1