Detailed Description
This is the abstract base class for all PackedNavBits decoders for theNavData tree. Only one method is declared, addData(), which is the intended interface to be used. This particular tree of classes implement the code necessary to convert a stream of PackedNavBits objects into the appropriate NavData objects. This is not a 1:1 correlation.
Definition at line 61 of file PNBNavDataFactory.hpp.
#include <PNBNavDataFactory.hpp>
Public Member Functions | |
| virtual bool | addData (const PackedNavBitsPtr &navIn, NavDataPtrList &navOut, double cadence=-1)=0 |
| PNBNavDataFactory () | |
| virtual void | resetState ()=0 |
| virtual void | setControl (const FactoryControl &ctrl) |
| virtual void | setTypeFilter (const NavMessageTypeSet &nmts) |
| virtual void | setValidityFilter (NavValidityType nvt) |
Protected Attributes | |
| FactoryControl | factControl |
| Configuration for the behavior of this factory. More... | |
| NavValidityType | navValidity |
| Determines how the factory should filter added data. More... | |
| bool | processAlm |
| If true, almanac data will be output by addData. More... | |
| bool | processEph |
| If true, ephemeris data will be output by addData. More... | |
| bool | processHea |
| If true, health data will be output by addData. More... | |
| bool | processIono |
| If true, ionospheric data will be output by addData. More... | |
| bool | processISC |
| If true, inter-signal correction data will be output by addData. More... | |
| bool | processTim |
| If true, time offset data will be output by addData. More... | |
Constructor & Destructor Documentation
◆ PNBNavDataFactory()
| gnsstk::PNBNavDataFactory::PNBNavDataFactory | ( | ) |
Initialize navValidity to All and procNavTypes to all known message types.
Definition at line 46 of file PNBNavDataFactory.cpp.
Member Function Documentation
◆ addData()
|
pure virtual |
Process a PackedNavBits object, producing NavData objects as appropriate.
- Parameters
-
[in] navIn The PackedNavBits data to process. [out] navOut Any resulting NavData objects that were completed, usually as a result of adding navIn to the set of data. [in] cadence The data rate of the navigation messages being processed. If cadence < 0, The default values of NavData::msgLenSec will be used. Values >= 0 will override the default.
- Returns
- false on error.
Implemented in gnsstk::PNBMultiGNSSNavDataFactory, gnsstk::PNBBDSD2NavDataFactory, gnsstk::PNBBDSD1NavDataFactory, gnsstk::PNBGLOCNavDataFactory, gnsstk::PNBGPSLNavDataFactory, gnsstk::PNBGPSCNavDataFactory, gnsstk::PNBGalFNavDataFactory, gnsstk::PNBGalINavDataFactory, gnsstk::PNBGLOFNavDataFactory, gnsstk::PNBGPSCNav2DataFactory, and PNBTestFactory.
◆ resetState()
|
pure virtual |
Reset the state of the data accumulator. Most PNBNavDataFactory child classes will maintain some state to assemble data prior to processing. This method is intended to be used to clear out that intermediate data to start from a fresh state, e.g. if you're loading discontinuous data.
Implemented in gnsstk::PNBGalINavDataFactory, gnsstk::PNBGalFNavDataFactory, gnsstk::PNBBDSD2NavDataFactory, gnsstk::PNBBDSD1NavDataFactory, gnsstk::PNBGPSCNavDataFactory, gnsstk::PNBGPSLNavDataFactory, gnsstk::PNBGPSCNav2DataFactory, gnsstk::PNBMultiGNSSNavDataFactory, gnsstk::PNBGLOCNavDataFactory, PNBTestFactory, and gnsstk::PNBGLOFNavDataFactory.
◆ setControl()
|
inlinevirtual |
Set the configuration parameters for this and any child PNBNavDataFactory objects.
- Parameters
-
[in] ctrl The configuration for the factory/factories.
Reimplemented in gnsstk::PNBMultiGNSSNavDataFactory.
Definition at line 113 of file PNBNavDataFactory.hpp.
◆ setTypeFilter()
|
virtual |
Indicate what nav message types the factories should be loading. This should be called before any addData() calls.
- Warning
- You MUST include Health data in the type filter if you intend to look up data by health status other than "Any" (exceptions: if you're ONLY looking up orbit data that has self-contained health status).
- Parameters
-
[in] nmts The set of nav message types to be processed by the factories.
Reimplemented in gnsstk::PNBMultiGNSSNavDataFactory.
Definition at line 54 of file PNBNavDataFactory.cpp.
◆ setValidityFilter()
|
inlinevirtual |
Set the factory's handling of valid and invalid navigation data. This should be called before any addData() calls.
- Parameters
-
[in] nvt The new nav data loading filter method.
Reimplemented in gnsstk::PNBMultiGNSSNavDataFactory.
Definition at line 72 of file PNBNavDataFactory.hpp.
Member Data Documentation
◆ factControl
|
protected |
Configuration for the behavior of this factory.
Definition at line 118 of file PNBNavDataFactory.hpp.
◆ navValidity
|
protected |
Determines how the factory should filter added data.
Definition at line 121 of file PNBNavDataFactory.hpp.
◆ processAlm
|
protected |
If true, almanac data will be output by addData.
Definition at line 126 of file PNBNavDataFactory.hpp.
◆ processEph
|
protected |
If true, ephemeris data will be output by addData.
Definition at line 124 of file PNBNavDataFactory.hpp.
◆ processHea
|
protected |
If true, health data will be output by addData.
Definition at line 128 of file PNBNavDataFactory.hpp.
◆ processIono
|
protected |
If true, ionospheric data will be output by addData.
Definition at line 132 of file PNBNavDataFactory.hpp.
◆ processISC
|
protected |
If true, inter-signal correction data will be output by addData.
Definition at line 134 of file PNBNavDataFactory.hpp.
◆ processTim
|
protected |
If true, time offset data will be output by addData.
Definition at line 130 of file PNBNavDataFactory.hpp.
The documentation for this class was generated from the following files: