Ginan
Loading...
Searching...
No Matches
KFKey Struct Reference

Keys used to interface with Kalman filter objects. More...

Detailed Description

Keys used to interface with Kalman filter objects.

These have parameters to separate states of different 'type', for different 'Sat's, with different receiver id 'str's and may have a different 'num' (eg xyz->0,1,2)

Keys should be used rather than indices for accessing kalman filter state parameters.

Collaboration diagram for KFKey:

Public Member Functions

bool operator== (const KFKey &b) const
 
bool operator< (const KFKey &b) const
 
 operator string () const
 
string commaString () const
 
template<class ARCHIVE >
void serialize (ARCHIVE &ar, const unsigned int &version)
 

Static Public Member Functions

static string emptyString ()
 Create a string with the same spacing as ordinary outputs.
 

Data Fields

short int type = 0
 Key type (From enum)
 
SatSys Sat = {}
 Satellite.
 
string str
 String (receiver ID)
 
int num = 0
 Subkey number (eg xyz => 0,1,2)
 
string comment
 Optional comment.
 
Receiverrec_ptr = 0
 Pointer to station object for dereferencing.
 

Friends

ostream & operator<< (ostream &os, const KFKey &kfKey)
 

Member Function Documentation

◆ commaString()

string KFKey::commaString ( ) const
inline
Here is the call graph for this function:

◆ emptyString()

static string KFKey::emptyString ( )
inlinestatic

Create a string with the same spacing as ordinary outputs.

Here is the caller graph for this function:

◆ operator string()

KFKey::operator string ( ) const
inline
Here is the call graph for this function:

◆ operator<()

bool KFKey::operator< ( const KFKey & b) const

◆ operator==()

bool KFKey::operator== ( const KFKey & b) const

◆ serialize()

template<class ARCHIVE >
void KFKey::serialize ( ARCHIVE & ar,
const unsigned int & version )
inline

Friends And Related Symbol Documentation

◆ operator<<

ostream & operator<< ( ostream & os,
const KFKey & kfKey )
friend

Field Documentation

◆ comment

string KFKey::comment

Optional comment.

◆ num

int KFKey::num = 0

Subkey number (eg xyz => 0,1,2)

◆ rec_ptr

Receiver* KFKey::rec_ptr = 0

Pointer to station object for dereferencing.

◆ Sat

SatSys KFKey::Sat = {}

Satellite.

◆ str

string KFKey::str

String (receiver ID)

◆ type

short int KFKey::type = 0

Key type (From enum)


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