SourceID Class Reference

#include <SourceID.hpp>

Collaboration diagram for SourceID:

[legend]List of all members.

Public Types
enum	SourceType {   Unknown, GPS, Galileo, Glonass,   Geosync, LEO, Transit, DGPS,   RTK, INS, Mixed, Last,   Placeholder = Last+1000 }
	The type of source. More...
Public Member Functions
	SourceID ()
	empty constructor, creates an unknown source data object
	SourceID (SourceType st, std::string name)
	Explicit constructor.
	SourceID (const SourceID &s)
	Copy constructor.
virtual bool	operator== (const SourceID &right) const
	Equality operator requires all fields to be the same.
virtual bool	operator< (const SourceID &right) const
	Ordering is arbitrary but required to be able to use a SourceID as an index to a std::map.
bool	operator!= (const SourceID &right) const
	Inequality operator.
bool	operator> (const SourceID &right) const
	'Greater than' operator
bool	operator<= (const SourceID &right) const
	'Less or equal than' operator
bool	operator>= (const SourceID &right) const
	'Greater or equal than' operator
SourceID &	operator= (const SourceID &right)
	Assignment operator.
virtual std::ostream &	dump (std::ostream &s) const
	Convenience output method.
virtual bool	isValid () const
	Returns true if this is a valid SourceID.
virtual	~SourceID ()
	Destructor.
Static Public Member Functions
SourceType	newSourceType (const std::string &s)
	Method to create a new source type.
Public Attributes
SourceType	type
	Type of the data source (GPS receiver, Inertial system, etc).
std::string	sourceName
	Name of the data source.
Static Public Attributes
Initializer	SourceIDsingleton

---

Member Enumeration Documentation

enum SourceType

The type of source. Enumeration values: Unknown  GPS  GPS data. Galileo  Galileo data. Glonass  Glonass data. Geosync  Geostationary data. LEO  LEO data. Transit  Transit data. DGPS  Differential GPS data. RTK  Real Time Kinematic data. INS  Inertial System data. Mixed  Mixed data. Last  used to extend this... Placeholder  Definition at line 52 of file SourceID.hpp. Referenced by SourceID::newSourceType().

---

Constructor & Destructor Documentation

SourceID (   )  [inline]

empty constructor, creates an unknown source data object Definition at line 71 of file SourceID.hpp.

SourceID (  SourceType  st, std::string  name )  [inline]

Explicit constructor. Definition at line 77 of file SourceID.hpp.

SourceID (  const SourceID &  s  )  [inline]

Copy constructor. Definition at line 84 of file SourceID.hpp.

virtual ~SourceID (   )  [inline, virtual]

Destructor. Definition at line 133 of file SourceID.hpp.

---

Member Function Documentation

std::ostream & dump (  std::ostream &  s  )  const [virtual]

Convenience output method. Definition at line 79 of file SourceID.cpp. Referenced by gpstk::StringUtils::asString(), and gpstk::operator<<().

bool isValid (   )  const [virtual]

Returns true if this is a valid SourceID. Basically just checks that none of the fields are undefined. Definition at line 93 of file SourceID.cpp. References SourceID::sourceName, SourceID::type, and SourceID::Unknown.

SourceID::SourceType newSourceType (  const std::string &  s  )  [static]

Method to create a new source type. Definition at line 103 of file SourceID.cpp. References SourceID::SourceType.

bool operator!= (  const SourceID &  right  )  const [inline]

Inequality operator. Definition at line 100 of file SourceID.hpp. References gpstk::operator==().

bool operator< (  const SourceID &  right  )  const [virtual]

Ordering is arbitrary but required to be able to use a SourceID as an index to a std::map. If an application needs some other ordering, inherit and override this function. Definition at line 130 of file SourceID.cpp. References SourceID::sourceName, and SourceID::type.

bool operator<= (  const SourceID &  right  )  const [inline]

'Less or equal than' operator Definition at line 110 of file SourceID.hpp. References gpstk::operator<(), and gpstk::operator==().

SourceID & operator= (  const SourceID &  right  )

Assignment operator. Definition at line 61 of file SourceID.cpp. References SourceID::sourceName, and SourceID::type.

bool operator== (  const SourceID &  right  )  const [virtual]

Equality operator requires all fields to be the same. Definition at line 118 of file SourceID.cpp. References SourceID::sourceName, and SourceID::type.

bool operator> (  const SourceID &  right  )  const [inline]

'Greater than' operator Definition at line 105 of file SourceID.hpp. References gpstk::operator<(), and gpstk::operator==().

bool operator>= (  const SourceID &  right  )  const [inline]

'Greater or equal than' operator Definition at line 115 of file SourceID.hpp. References gpstk::operator<().

---

Member Data Documentation

Initializer SourceIDsingleton [static]

Definition at line 164 of file SourceID.hpp.

std::string sourceName

Name of the data source. Definition at line 147 of file SourceID.hpp. Referenced by SourceID::isValid(), SourceID::operator<(), SourceID::operator=(), SourceID::operator==(), gpstk::operator>>(), sourceEpochHeader::sourceEpochHeader(), sourceEpochRinexHeader::sourceEpochRinexHeader(), sourceEpochSatHeader::sourceEpochSatHeader(), sourceEpochTypeHeader::sourceEpochTypeHeader(), sourceHeader::sourceHeader(), sourceSatHeader::sourceSatHeader(), and sourceTypeHeader::sourceTypeHeader().

SourceType type

Type of the data source (GPS receiver, Inertial system, etc). Definition at line 143 of file SourceID.hpp. Referenced by SourceID::isValid(), SourceID::operator<(), SourceID::operator=(), SourceID::operator==(), gpstk::operator>>(), sourceEpochHeader::sourceEpochHeader(), sourceEpochRinexHeader::sourceEpochRinexHeader(), sourceEpochSatHeader::sourceEpochSatHeader(), sourceEpochTypeHeader::sourceEpochTypeHeader(), sourceHeader::sourceHeader(), sourceSatHeader::sourceSatHeader(), and sourceTypeHeader::sourceTypeHeader().

---

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

• SourceID.hpp
• SourceID.cpp

---