![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for PrmDb component. More...
#include <Svc/PrmDb/PrmDbComponentAc.hpp>
Protected Types | |
enum | { NUM_CMDDISP_INPUT_PORTS = 1 } |
Enumerations for numbers of special input ports. More... | |
enum | { NUM_GETPRM_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1, NUM_SETPRM_INPUT_PORTS = 1 } |
Enumerations for numbers of typed input ports. More... | |
enum | { NUM_CMDREG_OUTPUT_PORTS = 1, NUM_CMDSTATUS_OUTPUT_PORTS = 1, NUM_LOG_OUTPUT_PORTS = 1, NUM_LOGTEXT_OUTPUT_PORTS = 1, NUM_TIME_OUTPUT_PORTS = 1 } |
Enumerations for numbers of special output ports. More... | |
enum | { NUM_PINGOUT_OUTPUT_PORTS = 1 } |
Enumerations for numbers of typed output ports. More... | |
enum | { OPCODE_PRM_SAVE_FILE = 0x0 } |
Command opcodes. More... | |
enum | { EVENTID_PRMIDNOTFOUND = 0x0, EVENTID_PRMIDUPDATED = 0x1, EVENTID_PRMDBFULL = 0x2, EVENTID_PRMIDADDED = 0x3, EVENTID_PRMFILEWRITEERROR = 0x4, EVENTID_PRMFILESAVECOMPLETE = 0x5, EVENTID_PRMFILEREADERROR = 0x6, EVENTID_PRMFILELOADCOMPLETE = 0x7 } |
Event IDs. More... | |
enum | { EVENTID_PRMIDNOTFOUND_THROTTLE = 5 } |
Event throttle values: sets initial value of countdown variables. More... | |
![]() | |
enum | Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE } |
Tracks the lifecycle of the component. More... | |
Protected Member Functions | |
PrmDbComponentBase (const char *compName="") | |
Construct PrmDbComponentBase object. More... | |
virtual | ~PrmDbComponentBase () |
Destroy PrmDbComponentBase object. More... | |
FwIndexType | getNum_CmdDisp_InputPorts () const |
FwIndexType | getNum_getPrm_InputPorts () const |
FwIndexType | getNum_pingIn_InputPorts () const |
FwIndexType | getNum_setPrm_InputPorts () const |
FwIndexType | getNum_CmdReg_OutputPorts () const |
FwIndexType | getNum_CmdStatus_OutputPorts () const |
FwIndexType | getNum_Log_OutputPorts () const |
FwIndexType | getNum_Time_OutputPorts () const |
FwIndexType | getNum_pingOut_OutputPorts () const |
bool | isConnected_CmdReg_OutputPort (FwIndexType portNum) |
bool | isConnected_CmdStatus_OutputPort (FwIndexType portNum) |
bool | isConnected_Log_OutputPort (FwIndexType portNum) |
bool | isConnected_Time_OutputPort (FwIndexType portNum) |
bool | isConnected_pingOut_OutputPort (FwIndexType portNum) |
virtual Fw::ParamValid | getPrm_handler (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)=0 |
Handler for input port getPrm. More... | |
virtual void | pingIn_handler (FwIndexType portNum, U32 key)=0 |
Handler for input port pingIn. More... | |
virtual void | setPrm_handler (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)=0 |
Handler for input port setPrm. More... | |
Fw::ParamValid | getPrm_handlerBase (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val) |
Handler base-class function for input port getPrm. More... | |
void | pingIn_handlerBase (FwIndexType portNum, U32 key) |
Handler base-class function for input port pingIn. More... | |
void | setPrm_handlerBase (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val) |
Handler base-class function for input port setPrm. More... | |
virtual void | pingIn_preMsgHook (FwIndexType portNum, U32 key) |
Pre-message hook for async input port pingIn. More... | |
virtual void | setPrm_preMsgHook (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val) |
Pre-message hook for async input port setPrm. More... | |
void | pingOut_out (FwIndexType portNum, U32 key) |
Invoke output port pingOut. More... | |
void | cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response) |
Emit command response. More... | |
virtual void | PRM_SAVE_FILE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0 |
void | PRM_SAVE_FILE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
virtual void | PRM_SAVE_FILE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq) |
Pre-message hook for command PRM_SAVE_FILE. More... | |
void | log_WARNING_LO_PrmIdNotFound (U32 Id) |
void | log_ACTIVITY_HI_PrmIdUpdated (U32 Id) const |
void | log_FATAL_PrmDbFull (U32 Id) const |
void | log_ACTIVITY_HI_PrmIdAdded (U32 Id) const |
void | log_WARNING_HI_PrmFileWriteError (Svc::PrmDb_PrmWriteError stage, I32 record, I32 error) const |
void | log_ACTIVITY_HI_PrmFileSaveComplete (U32 records) const |
void | log_WARNING_HI_PrmFileReadError (Svc::PrmDb_PrmReadError stage, I32 record, I32 error) const |
void | log_ACTIVITY_HI_PrmFileLoadComplete (U32 records) const |
void | log_WARNING_LO_PrmIdNotFound_ThrottleClear () |
Reset throttle value for PrmIdNotFound. More... | |
Fw::Time | getTime () |
virtual void | lock () |
Lock the guarded mutex. More... | |
virtual void | unLock () |
Unlock the guarded mutex. More... | |
![]() | |
ActiveComponentBase (const char *name) | |
Constructor. More... | |
virtual | ~ActiveComponentBase () |
Destructor. More... | |
void | init (NATIVE_INT_TYPE instance) |
initialization code More... | |
virtual void | preamble () |
A function that will be called before the event loop is entered. More... | |
MsgDispatchStatus | dispatch () |
The function that will dispatching messages. More... | |
virtual void | finalizer () |
A function that will be called after exiting the loop. More... | |
![]() | |
QueuedComponentBase (const char *name) | |
Constructor. More... | |
virtual | ~QueuedComponentBase () |
Destructor. More... | |
void | init (NATIVE_INT_TYPE instance) |
initialization function More... | |
Os::Queue::Status | createQueue (FwSizeType depth, FwSizeType msgSize) |
NATIVE_INT_TYPE | getNumMsgsDropped () |
return number of messages dropped More... | |
void | incNumMsgDropped () |
increment the number of messages dropped More... | |
![]() | |
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 |
![]() | |
ObjBase (const char *name) | |
ObjBase constructor. More... | |
virtual | ~ObjBase () |
Destructor. More... | |
void | init () |
Object initializer. More... | |
Friends | |
class | PrmDbComponentBaseFriend |
Friend class for white-box testing. More... | |
Additional Inherited Members | |
![]() | |
enum | { ACTIVE_COMPONENT_EXIT } |
![]() | |
enum | MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT } |
![]() | |
Os::Task | m_task |
task object for active component More... | |
![]() | |
Os::Queue | m_queue |
queue object for active component More... | |
Auto-generated base for PrmDb component.
A component for storing parameters
Definition at line 37 of file PrmDbComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
Enumerator | |
---|---|
NUM_CMDDISP_INPUT_PORTS |
Definition at line 55 of file PrmDbComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
Enumerator | |
---|---|
NUM_GETPRM_INPUT_PORTS | |
NUM_PINGIN_INPUT_PORTS | |
NUM_SETPRM_INPUT_PORTS |
Definition at line 60 of file PrmDbComponentAc.hpp.
|
protected |
Enumerations for numbers of special output ports.
Enumerator | |
---|---|
NUM_CMDREG_OUTPUT_PORTS | |
NUM_CMDSTATUS_OUTPUT_PORTS | |
NUM_LOG_OUTPUT_PORTS | |
NUM_LOGTEXT_OUTPUT_PORTS | |
NUM_TIME_OUTPUT_PORTS |
Definition at line 67 of file PrmDbComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
Enumerator | |
---|---|
NUM_PINGOUT_OUTPUT_PORTS |
Definition at line 76 of file PrmDbComponentAc.hpp.
|
protected |
Command opcodes.
Enumerator | |
---|---|
OPCODE_PRM_SAVE_FILE | Command to save parameter image to file. Uses file name passed to constructor. |
Definition at line 81 of file PrmDbComponentAc.hpp.
|
protected |
Event IDs.
Definition at line 86 of file PrmDbComponentAc.hpp.
|
protected |
Event throttle values: sets initial value of countdown variables.
Enumerator | |
---|---|
EVENTID_PRMIDNOTFOUND_THROTTLE | Throttle reset count for PrmIdNotFound. |
Definition at line 98 of file PrmDbComponentAc.hpp.
|
protected |
Construct PrmDbComponentBase object.
compName | The component name |
Definition at line 575 of file PrmDbComponentAc.cpp.
|
protectedvirtual |
Destroy PrmDbComponentBase object.
Definition at line 582 of file PrmDbComponentAc.cpp.
|
protected |
Emit command response.
opCode | The opcode |
cmdSeq | The command sequence number |
response | The command response |
Definition at line 948 of file PrmDbComponentAc.cpp.
Fw::InputCmdPort * Svc::PrmDbComponentBase::get_CmdDisp_InputPort | ( | FwIndexType | portNum | ) |
Get special input port at index
portNum | The port number |
Definition at line 309 of file PrmDbComponentAc.cpp.
Fw::InputPrmGetPort * Svc::PrmDbComponentBase::get_getPrm_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 324 of file PrmDbComponentAc.cpp.
Svc::InputPingPort * Svc::PrmDbComponentBase::get_pingIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 335 of file PrmDbComponentAc.cpp.
Fw::InputPrmSetPort * Svc::PrmDbComponentBase::get_setPrm_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 346 of file PrmDbComponentAc.cpp.
|
protected |
Get the number of CmdDisp input ports
Definition at line 592 of file PrmDbComponentAc.cpp.
|
protected |
Get the number of CmdReg output ports
Definition at line 624 of file PrmDbComponentAc.cpp.
|
protected |
Get the number of CmdStatus output ports
Definition at line 630 of file PrmDbComponentAc.cpp.
|
protected |
Get the number of getPrm input ports
Definition at line 602 of file PrmDbComponentAc.cpp.
|
protected |
Get the number of Log output ports
Definition at line 636 of file PrmDbComponentAc.cpp.
|
protected |
Get the number of pingIn input ports
Definition at line 608 of file PrmDbComponentAc.cpp.
|
protected |
Get the number of pingOut output ports
Definition at line 662 of file PrmDbComponentAc.cpp.
|
protected |
Get the number of setPrm input ports
Definition at line 614 of file PrmDbComponentAc.cpp.
|
protected |
Get the number of Time output ports
Definition at line 652 of file PrmDbComponentAc.cpp.
|
protectedpure virtual |
Handler for input port getPrm.
portNum | The port number |
id | Parameter ID |
val | Buffer containing serialized parameter value |
|
protected |
Handler base-class function for input port getPrm.
portNum | The port number |
id | Parameter ID |
val | Buffer containing serialized parameter value |
Definition at line 752 of file PrmDbComponentAc.cpp.
|
protected |
void Svc::PrmDbComponentBase::init | ( | FwSizeType | queueDepth, |
FwEnumStoreType | instance = 0 |
||
) |
Initialize PrmDbComponentBase object.
queueDepth | The queue depth |
instance | The instance number |
Definition at line 73 of file PrmDbComponentAc.cpp.
|
protected |
Check whether port CmdReg is connected
portNum | The port number |
Definition at line 672 of file PrmDbComponentAc.cpp.
|
protected |
Check whether port CmdStatus is connected
portNum | The port number |
Definition at line 683 of file PrmDbComponentAc.cpp.
|
protected |
Check whether port Log is connected
portNum | The port number |
Definition at line 694 of file PrmDbComponentAc.cpp.
|
protected |
Check whether port pingOut is connected
portNum | The port number |
Definition at line 735 of file PrmDbComponentAc.cpp.
|
protected |
Check whether port Time is connected
portNum | The port number |
Definition at line 720 of file PrmDbComponentAc.cpp.
|
protectedvirtual |
Lock the guarded mutex.
Definition at line 1841 of file PrmDbComponentAc.cpp.
|
protected |
Log event PrmFileLoadComplete
Load of parameter file completed
records | The number of records loaded |
Definition at line 1724 of file PrmDbComponentAc.cpp.
|
protected |
Log event PrmFileSaveComplete
Save of parameter file completed
records | The number of records saved |
Definition at line 1519 of file PrmDbComponentAc.cpp.
|
protected |
Log event PrmIdAdded
Parameter ID added to database
Id | The parameter ID |
Definition at line 1314 of file PrmDbComponentAc.cpp.
|
protected |
Log event PrmIdUpdated
Parameter ID updated in database
Id | The parameter ID |
Definition at line 1137 of file PrmDbComponentAc.cpp.
|
protected |
Log event PrmDbFull
Parameter database is full
Id | The parameter ID |
Definition at line 1219 of file PrmDbComponentAc.cpp.
|
protected |
Log event PrmFileReadError
Failed to read parameter file
stage | The read stage |
record | The record that had the failure |
error | The error code |
Definition at line 1601 of file PrmDbComponentAc.cpp.
|
protected |
Log event PrmFileWriteError
Failed to write parameter file
stage | The write stage |
record | The record that had the failure |
error | The error code |
Definition at line 1396 of file PrmDbComponentAc.cpp.
|
protected |
Log event PrmIdNotFound
Parameter ID not found in database.
Id | The parameter ID |
Definition at line 1047 of file PrmDbComponentAc.cpp.
|
protected |
Reset throttle value for PrmIdNotFound.
Definition at line 1810 of file PrmDbComponentAc.cpp.
|
protectedpure virtual |
Handler for input port pingIn.
portNum | The port number |
key | Value to return to pinger |
|
protected |
Handler base-class function for input port pingIn.
portNum | The port number |
key | Value to return to pinger |
Definition at line 783 of file PrmDbComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port pingIn.
portNum | The port number |
key | Value to return to pinger |
Definition at line 906 of file PrmDbComponentAc.cpp.
|
protected |
Invoke output port pingOut.
portNum | The port number |
key | Value to return to pinger |
Definition at line 929 of file PrmDbComponentAc.cpp.
|
protectedpure virtual |
Handler for command PRM_SAVE_FILE
Command to save parameter image to file. Uses file name passed to constructor
opCode | The opcode |
cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command PRM_SAVE_FILE
Command to save parameter image to file. Uses file name passed to constructor
opCode | The opcode |
cmdSeq | The command sequence number |
args | The command argument buffer |
Definition at line 965 of file PrmDbComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for command PRM_SAVE_FILE.
opCode | The opcode |
cmdSeq | The command sequence number |
Definition at line 1032 of file PrmDbComponentAc.cpp.
void Svc::PrmDbComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 561 of file PrmDbComponentAc.cpp.
void Svc::PrmDbComponentBase::set_CmdReg_OutputPort | ( | FwIndexType | portNum, |
Fw::InputCmdRegPort * | port | ||
) |
Connect port to CmdReg[portNum].
portNum | The port number |
port | The input port |
Definition at line 361 of file PrmDbComponentAc.cpp.
void Svc::PrmDbComponentBase::set_CmdStatus_OutputPort | ( | FwIndexType | portNum, |
Fw::InputCmdResponsePort * | port | ||
) |
Connect port to CmdStatus[portNum].
portNum | The port number |
port | The input port |
Definition at line 375 of file PrmDbComponentAc.cpp.
void Svc::PrmDbComponentBase::set_Log_OutputPort | ( | FwIndexType | portNum, |
Fw::InputLogPort * | port | ||
) |
Connect port to Log[portNum].
portNum | The port number |
port | The input port |
Definition at line 389 of file PrmDbComponentAc.cpp.
void Svc::PrmDbComponentBase::set_pingOut_OutputPort | ( | FwIndexType | portNum, |
Svc::InputPingPort * | port | ||
) |
Connect port to pingOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 439 of file PrmDbComponentAc.cpp.
void Svc::PrmDbComponentBase::set_Time_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTimePort * | port | ||
) |
Connect port to Time[portNum].
portNum | The port number |
port | The input port |
Definition at line 421 of file PrmDbComponentAc.cpp.
|
protectedpure virtual |
Handler for input port setPrm.
portNum | The port number |
id | Parameter ID |
val | Buffer containing serialized parameter value |
|
protected |
Handler base-class function for input port setPrm.
portNum | The port number |
id | Parameter ID |
val | Buffer containing serialized parameter value |
Definition at line 836 of file PrmDbComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port setPrm.
portNum | The port number |
id | Parameter ID |
val | Buffer containing serialized parameter value |
Definition at line 915 of file PrmDbComponentAc.cpp.
|
protectedvirtual |
Unlock the guarded mutex.
Definition at line 1847 of file PrmDbComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 46 of file PrmDbComponentAc.hpp.