F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Classes | Public Member Functions | List of all members
Svc::PolyDb Class Reference

PolyDb Component Class. More...

#include <Svc/PolyDb/PolyDb.hpp>

Inheritance diagram for Svc::PolyDb:
Svc::PolyDbComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 PolyDb (const char *const name)
 PolyDbImpl constructor. More...
 
virtual ~PolyDb ()
 PolyDbImpl destructor. More...
 
- Public Member Functions inherited from Svc::PolyDbComponentBase
void init (FwEnumStoreType instance=0)
 Initialize PolyDbComponentBase object. More...
 
Svc::InputPolyPort * get_getValue_InputPort (FwIndexType portNum)
 
Svc::InputPolyPort * get_setValue_InputPort (FwIndexType portNum)
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base. More...
 
U32 getIdBase () const
 

Additional Inherited Members

- Protected Types inherited from Svc::PolyDbComponentBase
enum  { NUM_GETVALUE_INPUT_PORTS = 1, NUM_SETVALUE_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
- Protected Member Functions inherited from Svc::PolyDbComponentBase
 PolyDbComponentBase (const char *compName="")
 Construct PolyDbComponentBase object. More...
 
virtual ~PolyDbComponentBase ()
 Destroy PolyDbComponentBase object. More...
 
FwIndexType getNum_getValue_InputPorts () const
 
FwIndexType getNum_setValue_InputPorts () const
 
void getValue_handlerBase (FwIndexType portNum, const Svc::PolyDbCfg::PolyDbEntry &entry, Svc::MeasurementStatus &status, Fw::Time &time, Fw::PolyType &val)
 Handler base-class function for input port getValue. More...
 
void setValue_handlerBase (FwIndexType portNum, const Svc::PolyDbCfg::PolyDbEntry &entry, Svc::MeasurementStatus &status, Fw::Time &time, Fw::PolyType &val)
 Handler base-class function for input port setValue. More...
 
virtual void lock ()
 Lock the guarded mutex. More...
 
virtual void unLock ()
 Unlock the guarded mutex. More...
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor. More...
 
virtual ~PassiveComponentBase ()
 Destructor. More...
 
void init (NATIVE_INT_TYPE instance)
 Initialization function. More...
 
NATIVE_INT_TYPE getInstance () const
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor. More...
 
virtual ~ObjBase ()
 Destructor. More...
 
void init ()
 Object initializer. More...
 

Detailed Description

PolyDb Component Class.

This component allows the setting and retrieving of PolyType telemetry values. It be used as a central analog database that can decouple measurement sources from measurement users. The intent is that measurement sources would convert DNs (data numbers) to ENs (Engineering Numbers) to decouple the conversion as well.

Definition at line 30 of file PolyDb.hpp.

Constructor & Destructor Documentation

◆ PolyDb()

Svc::PolyDb::PolyDb ( const char *const  name)
explicit

PolyDbImpl constructor.

The constructor initializes the database to "MeasurementStatus::STALE." All values retrieved will have this status until the first update is received.

Definition at line 13 of file PolyDb.cpp.

◆ ~PolyDb()

Svc::PolyDb::~PolyDb ( )
virtual

PolyDbImpl destructor.

The destructor is empty.

Definition at line 48 of file PolyDb.cpp.

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