BunkFilter2 Class Reference

Detailed Description

Definition at line 106 of file NavFilterMgr_T.cpp.

Inheritance diagram for BunkFilter2:

Public Member Functions
	BunkFilter2 ()
virtual std::string	filterName () const noexcept
virtual void	finalize (NavMsgList &msgBitsOut)
virtual unsigned	processingDepth () const noexcept
virtual void	validate (NavMsgList &msgBitsIn, NavMsgList &msgBitsOut)
Public Member Functions inherited from gnsstk::NavFilter
virtual void	dumpRejected (std::ostream &out) const
	Debug support. More...
	NavFilter ()
virtual std::string	reasonTerse () const noexcept
virtual std::vector< std::string >	reasonVerbose () const noexcept

Public Attributes
NavMsgList	cache
Public Attributes inherited from gnsstk::NavFilter
NavMsgList	rejected

Additional Inherited Members
Public Types inherited from gnsstk::NavFilter
typedef std::list< NavFilterKey * >	NavMsgList
Protected Member Functions inherited from gnsstk::NavFilter
void	accept (const NavMsgList &valid, NavMsgList &msgBitsOut)
void	accept (NavFilterKey *data, NavMsgList &msgBitsOut)
void	reject (const NavMsgList &invalid)
void	reject (NavFilterKey *data)

Constructor & Destructor Documentation

BunkFilter2()

BunkFilter2::BunkFilter2 ( )

inline

Definition at line 109 of file NavFilterMgr_T.cpp.

Member Function Documentation

filterName()

virtual std::string BunkFilter2::filterName ( ) const

inlinevirtualnoexcept

Return a simple string containing the name of the filter for the purposes of providing some user feedback as to which filter rejected a message. As an example, LNavEmptyFilter would return "Empty". The reason for using this method instead of type_id.name() is that the latter often returns compiler-munged names rather than human-readable ones.

Implements gnsstk::NavFilter.

Definition at line 129 of file NavFilterMgr_T.cpp.

finalize()

virtual void BunkFilter2::finalize ( NavMsgList &  msgBitsOut )

inlinevirtual

Flush the filter's stored data, if any. This method is called by NavFilterMgr::finalize() which is in turn called by the user. This method allows any lingering data stored internally by filters to be output.

Parameters

[out]

msgBitsOut

The messages successfully passing the filter.

Implements gnsstk::NavFilter.

Definition at line 121 of file NavFilterMgr_T.cpp.

processingDepth()

virtual unsigned BunkFilter2::processingDepth ( ) const

inlinevirtualnoexcept

Return the number of epochs worth of navigation data that the filter child class stores internally to function properly. This can be used to determine the size of a nav data buffer to allocate. A return value of 0 means that the subframes in msgBitsIn for the validate() call are immediately put in msgBitsOut or in rejected. A return value of 1 means that nav subframes of time t will not be accepted or rejected until validate is called with a nav subframe of time t+1 or later, and so on. Most filters will return a value of 0, indicating an immediate validation of the data.

Implements gnsstk::NavFilter.

Definition at line 127 of file NavFilterMgr_T.cpp.

validate()

virtual void BunkFilter2::validate ( NavMsgList &  msgBitsIn, NavMsgList &  msgBitsOut  )

inlinevirtual

Validate/filter navigation messages. This method is called by NavFilterMgr. Messages are ingested and filtered results returned, but not necessarily all in a single call to this method. Multiple calls may be required to accumulate sufficient data to give meaningful results. This behavior is filter-specific.

Parameters

[in,out]	msgBitsIn	A list of NavFilterKey* objects containing navigation messages.
[out]	msgBitsOut	The messages successfully passing the filter. The data from msgBitsIn will not appear here until it successfully passes the filter, which may require multiple calls of validate with multiple epochs of data.

Implements gnsstk::NavFilter.

Definition at line 110 of file NavFilterMgr_T.cpp.

Member Data Documentation

cache

NavMsgList BunkFilter2::cache

Definition at line 131 of file NavFilterMgr_T.cpp.

---

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

• NavFilterMgr_T.cpp