Detailed Description

This class encapsulates a collection of RINEX 3 OBS header field flags. It is only used to keep track of the presence of a field, but not the field values themselves, which are contained within Rinex3ObsHeader.

Definition at line 369 of file Rinex3ObsHeader.hpp.

#include <Rinex3ObsHeader.hpp>

Public Member Functions
void	clear ()
	Clear all set fields. More...

Fields &	clear (Field f)
	Clear a specific field. More...

void	describeMissing (const Fields &valid, Exception &exc)

bool	empty () const
	Return true if fieldsSet is empty, false otherwise. More...

	Fields ()=default
	Only implicit constructors to do. More...

	Fields (const FieldSet &fields)

bool	isSet (Field f) const
	Return true if the specific field is set (preferred to operator&). More...

bool	isValid (const Fields &present) const

bool	operator!= (const Fields &rhs) const
	Return true if the set of fields differs between this and rhs. More...

Fields	operator& (const Fields &rhs) const

Field	operator& (Field rhs) const

bool	operator== (const Fields &rhs) const
	Compare field sets. More...

Fields &	operator^= (Field rhs)

Fields	operator\| (const Fields &rhs) const

Fields &	operator\|= (Field rhs)

Fields &	set (Field f)
	Set a specific field. More...

Static Public Member Functions
static Fields	getRequired (double version)

static bool	isValid (double version, const Fields &present)

Public Attributes
FieldSet	fieldsSet
	All the header fields set in this object. More...

Constructor & Destructor Documentation

◆ Fields() [1/2]

gnsstk::Rinex3ObsHeader::Fields::Fields ( )

default

Only implicit constructors to do.

◆ Fields() [2/2]

gnsstk::Rinex3ObsHeader::Fields::Fields ( const FieldSet & fields )

inline

Construct a Fields class from a set of Field.

Parameters

[in] fields The set of fields to populate this object with.

Definition at line 377 of file Rinex3ObsHeader.hpp.

Member Function Documentation

◆ clear() [1/2]

void gnsstk::Rinex3ObsHeader::Fields::clear ( )

inline

Clear all set fields.

Definition at line 396 of file Rinex3ObsHeader.hpp.

◆ clear() [2/2]

Fields& gnsstk::Rinex3ObsHeader::Fields::clear ( Field f )

inline

Clear a specific field.

Definition at line 390 of file Rinex3ObsHeader.hpp.

◆ describeMissing()

void gnsstk::Rinex3ObsHeader::Fields::describeMissing	(	const Fields &	valid,
		Exception &	exc
	)

Add descriptive information to an exception about which header fields are missing. This object is assumed to be the set of header fields that are expected.

Parameters

[in]	valid	The set of present header fields.
[out]	exc	The exception to add descriptive text to.

Postcondition: exc will have text entries added to it for each of the missing header fields, i.e. each field set in allValid that is not set in valid.

Definition at line 2747 of file Rinex3ObsHeader.cpp.

◆ empty()

bool gnsstk::Rinex3ObsHeader::Fields::empty ( ) const

inline

Return true if fieldsSet is empty, false otherwise.

Definition at line 399 of file Rinex3ObsHeader.hpp.

◆ getRequired()

Rinex3ObsHeader::Fields gnsstk::Rinex3ObsHeader::Fields::getRequired ( double version )

static

Get a reference to the set of required header fields for a given RINEX version.

Definition at line 2692 of file Rinex3ObsHeader.cpp.

◆ isSet()

bool gnsstk::Rinex3ObsHeader::Fields::isSet ( Field f ) const

inline

Return true if the specific field is set (preferred to operator&).

Definition at line 393 of file Rinex3ObsHeader.hpp.

◆ isValid() [1/2]

bool gnsstk::Rinex3ObsHeader::Fields::isValid ( const Fields & present ) const

Determine if a header is valid.

Note: This object is assumed to be a set of required fields. Generally you would call this method on one of the allValid2, etc. static objects defined above.

See also: isValid(double,const Fields&)
if (Fields::allValid2.isValid(flags))

Parameters

[in] present The set of flags present in an existing header to be compared with this set of required flags.

Returns: true If all the fields in fieldsSet are also contained in present.fieldsSet.

Definition at line 2736 of file Rinex3ObsHeader.cpp.

◆ isValid() [2/2]

static bool gnsstk::Rinex3ObsHeader::Fields::isValid	(	double	version,
		const Fields &	present
	)

inlinestatic

Determine if a header is valid.

Parameters

[in]	version	The RINEX version being validated.
[in]	present	The set of flags present in an existing header to be compared with this set of required flags.

Returns: true If all the fields in the fieldsSet value appropriate for the specified version are also contained in present.fieldsSet.

Definition at line 443 of file Rinex3ObsHeader.hpp.

◆ operator!=()

bool gnsstk::Rinex3ObsHeader::Fields::operator!= ( const Fields & rhs ) const

inline

Return true if the set of fields differs between this and rhs.

Definition at line 384 of file Rinex3ObsHeader.hpp.

◆ operator&() [1/2]

Rinex3ObsHeader::Fields gnsstk::Rinex3ObsHeader::Fields::operator& ( const Fields & rhs ) const

Backwards compatibility method for code still implemented around bit flags.

Definition at line 2706 of file Rinex3ObsHeader.cpp.

◆ operator&() [2/2]

Rinex3ObsHeader::Field gnsstk::Rinex3ObsHeader::Fields::operator& ( Rinex3ObsHeader::Field rhs ) const

Backwards compatibility method for code still implemented around bit flags.

Deprecated:: Please use isSet() instead.

Definition at line 2727 of file Rinex3ObsHeader.cpp.

◆ operator==()

bool gnsstk::Rinex3ObsHeader::Fields::operator== ( const Fields & rhs ) const

inline

Compare field sets.

Definition at line 381 of file Rinex3ObsHeader.hpp.

◆ operator^=()

Fields& gnsstk::Rinex3ObsHeader::Fields::operator^= ( Field rhs )

inline

Alias for clear(Field)

Deprecated:: Please use clear(Field) instead.

Definition at line 419 of file Rinex3ObsHeader.hpp.

◆ operator|()

Rinex3ObsHeader::Fields gnsstk::Rinex3ObsHeader::Fields::operator| ( const Fields & rhs ) const

Backwards compatibility method for code still implemented around bit flags.

Definition at line 2716 of file Rinex3ObsHeader.cpp.

◆ operator|=()

Fields& gnsstk::Rinex3ObsHeader::Fields::operator|= ( Field rhs )

inline

Alias for set() for backwards compatibility.

Deprecated:: Please use set() instead.

Definition at line 415 of file Rinex3ObsHeader.hpp.

◆ set()

Fields& gnsstk::Rinex3ObsHeader::Fields::set ( Field f )

inline

Set a specific field.

Definition at line 387 of file Rinex3ObsHeader.hpp.

Member Data Documentation

◆ fieldsSet

FieldSet gnsstk::Rinex3ObsHeader::Fields::fieldsSet

All the header fields set in this object.

Definition at line 460 of file Rinex3ObsHeader.hpp.

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

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Constructor & Destructor Documentation

◆ Fields() [1/2]

◆ Fields() [2/2]

Member Function Documentation

◆ clear() [1/2]

◆ clear() [2/2]

◆ describeMissing()

◆ empty()

◆ getRequired()

◆ isSet()

◆ isValid() [1/2]

◆ isValid() [2/2]

◆ operator!=()

◆ operator&() [1/2]

◆ operator&() [2/2]

◆ operator==()

◆ operator^=()

◆ operator|()

◆ operator|=()

◆ set()

Member Data Documentation

◆ fieldsSet