![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for SystemResources component. More...
#include <Svc/SystemResources/SystemResourcesComponentAc.hpp>
Public Member Functions | |
| void | init (FwEnumStoreType instance=0) |
| Initialize SystemResourcesComponentBase object. More... | |
| Fw::InputCmdPort * | get_CmdDisp_InputPort (FwIndexType portNum) |
| Svc::InputSchedPort * | get_run_InputPort (FwIndexType portNum) |
| void | set_CmdReg_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port) |
| Connect port to CmdReg[portNum]. More... | |
| void | set_CmdStatus_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port) |
| Connect port to CmdStatus[portNum]. More... | |
| void | set_Log_OutputPort (FwIndexType portNum, Fw::InputLogPort *port) |
| Connect port to Log[portNum]. More... | |
| void | set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port) |
| Connect port to Time[portNum]. More... | |
| void | set_Tlm_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port) |
| Connect port to Tlm[portNum]. More... | |
| void | regCommands () |
| Register commands with the Command Dispatcher. More... | |
Public Member Functions inherited from Fw::PassiveComponentBase | |
| void | setIdBase (const FwIdType) |
| Set the ID base. More... | |
| FwIdType | getIdBase () const |
Protected Member Functions | |
| SystemResourcesComponentBase (const char *compName="") | |
| Construct SystemResourcesComponentBase object. More... | |
| virtual | ~SystemResourcesComponentBase () |
| Destroy SystemResourcesComponentBase object. More... | |
| 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_Tlm_OutputPort (FwIndexType portNum) |
| virtual void | run_handler (FwIndexType portNum, U32 context)=0 |
| Handler for input port run. More... | |
| void | run_handlerBase (FwIndexType portNum, U32 context) |
| Handler base-class function for input port run. More... | |
| void | cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response) |
| Emit command response. More... | |
| virtual void | ENABLE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, Svc::SystemResourceEnabled enable)=0 |
| void | ENABLE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args) |
| void | tlmWrite_MEMORY_TOTAL (U64 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_MEMORY_USED (U64 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_NON_VOLATILE_TOTAL (U64 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_NON_VOLATILE_FREE (U64 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_00 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_01 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_02 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_03 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_04 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_05 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_06 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_07 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_08 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_09 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_10 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_11 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_12 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_13 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_14 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| void | tlmWrite_CPU_15 (F32 arg, Fw::Time _tlmTime=Fw::Time()) const |
| Fw::Time | getTime () const |
| 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 (FwEnumStoreType instance) |
| Initialization function. More... | |
| FwEnumStoreType | 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... | |
Static Protected Member Functions | |
| static constexpr FwIndexType | getNum_CmdDisp_InputPorts () |
| static constexpr FwIndexType | getNum_run_InputPorts () |
| static constexpr FwIndexType | getNum_CmdReg_OutputPorts () |
| static constexpr FwIndexType | getNum_CmdStatus_OutputPorts () |
| static constexpr FwIndexType | getNum_Log_OutputPorts () |
| static constexpr FwIndexType | getNum_Time_OutputPorts () |
| static constexpr FwIndexType | getNum_Tlm_OutputPorts () |
Friends | |
| class | SystemResourcesTesterBase |
| Friend class tester to support autocoded test harness. More... | |
| class | SystemResourcesTester |
| Friend class tester implementation to support white-box testing. More... | |
Auto-generated base for SystemResources component.
Definition at line 33 of file SystemResourcesComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
| Enumerator | |
|---|---|
| NUM_CMDDISP_INPUT_PORTS | |
Definition at line 53 of file SystemResourcesComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
| Enumerator | |
|---|---|
| NUM_RUN_INPUT_PORTS | |
Definition at line 58 of file SystemResourcesComponentAc.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 | |
| NUM_TLM_OUTPUT_PORTS | |
Definition at line 63 of file SystemResourcesComponentAc.hpp.
|
protected |
Command opcodes.
| Enumerator | |
|---|---|
| OPCODE_ENABLE | A command to enable or disable system resource telemetry. |
Definition at line 73 of file SystemResourcesComponentAc.hpp.
|
protected |
Channel IDs.
Definition at line 78 of file SystemResourcesComponentAc.hpp.
|
protected |
Construct SystemResourcesComponentBase object.
| compName | The component name |
Definition at line 428 of file SystemResourcesComponentAc.cpp.
|
protectedvirtual |
Destroy SystemResourcesComponentBase object.
Definition at line 435 of file SystemResourcesComponentAc.cpp.
|
protected |
Emit command response.
| opCode | The opcode |
| cmdSeq | The command sequence number |
| response | The command response |
Definition at line 550 of file SystemResourcesComponentAc.cpp.
|
protectedpure virtual |
Handler for command ENABLE
A command to enable or disable system resource telemetry
| opCode | The opcode |
| cmdSeq | The command sequence number |
| enable | whether or not system resource telemetry is enabled |
|
protected |
Base-class handler function for command ENABLE
A command to enable or disable system resource telemetry
| opCode | The opcode |
| cmdSeq | The command sequence number |
| args | The command argument buffer |
Definition at line 567 of file SystemResourcesComponentAc.cpp.
| Fw::InputCmdPort * Svc::SystemResourcesComponentBase::get_CmdDisp_InputPort | ( | FwIndexType | portNum | ) |
Get special input port at index
| portNum | The port number |
Definition at line 196 of file SystemResourcesComponentAc.cpp.
| Svc::InputSchedPort * Svc::SystemResourcesComponentBase::get_run_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
| portNum | The port number |
Definition at line 211 of file SystemResourcesComponentAc.cpp.
|
inlinestaticprotected |
Get the number of CmdDisp input ports
Definition at line 269 of file SystemResourcesComponentAc.hpp.
|
inlinestaticprotected |
Get the number of CmdReg output ports
Definition at line 295 of file SystemResourcesComponentAc.hpp.
|
inlinestaticprotected |
Get the number of CmdStatus output ports
Definition at line 302 of file SystemResourcesComponentAc.hpp.
|
inlinestaticprotected |
Get the number of Log output ports
Definition at line 309 of file SystemResourcesComponentAc.hpp.
|
inlinestaticprotected |
Get the number of run input ports
Definition at line 282 of file SystemResourcesComponentAc.hpp.
|
inlinestaticprotected |
Get the number of Time output ports
Definition at line 327 of file SystemResourcesComponentAc.hpp.
|
inlinestaticprotected |
Get the number of Tlm output ports
Definition at line 334 of file SystemResourcesComponentAc.hpp.
|
protected |
Get the time
\return The current time
Definition at line 1319 of file SystemResourcesComponentAc.cpp.
| void Svc::SystemResourcesComponentBase::init | ( | FwEnumStoreType | instance = 0 | ) |
Initialize SystemResourcesComponentBase object.
| instance | The instance number |
Definition at line 21 of file SystemResourcesComponentAc.cpp.
|
protected |
Check whether port CmdReg is connected
| portNum | The port number |
Definition at line 445 of file SystemResourcesComponentAc.cpp.
|
protected |
Check whether port CmdStatus is connected
| portNum | The port number |
Definition at line 456 of file SystemResourcesComponentAc.cpp.
|
protected |
Check whether port Log is connected
| portNum | The port number |
Definition at line 467 of file SystemResourcesComponentAc.cpp.
|
protected |
Check whether port Time is connected
| portNum | The port number |
Definition at line 493 of file SystemResourcesComponentAc.cpp.
|
protected |
Check whether port Tlm is connected
| portNum | The port number |
Definition at line 504 of file SystemResourcesComponentAc.cpp.
|
protectedvirtual |
Lock the guarded mutex.
Definition at line 1339 of file SystemResourcesComponentAc.cpp.
| void Svc::SystemResourcesComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 414 of file SystemResourcesComponentAc.cpp.
|
protectedpure virtual |
Handler for input port run.
| portNum | The port number |
| context | The call order |
|
protected |
Handler base-class function for input port run.
| portNum | The port number |
| context | The call order |
Definition at line 521 of file SystemResourcesComponentAc.cpp.
| void Svc::SystemResourcesComponentBase::set_CmdReg_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdRegPort * | port | ||
| ) |
Connect port to CmdReg[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 226 of file SystemResourcesComponentAc.cpp.
| void Svc::SystemResourcesComponentBase::set_CmdStatus_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputCmdResponsePort * | port | ||
| ) |
Connect port to CmdStatus[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 240 of file SystemResourcesComponentAc.cpp.
| void Svc::SystemResourcesComponentBase::set_Log_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputLogPort * | port | ||
| ) |
Connect port to Log[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 254 of file SystemResourcesComponentAc.cpp.
| void Svc::SystemResourcesComponentBase::set_Time_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTimePort * | port | ||
| ) |
Connect port to Time[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 286 of file SystemResourcesComponentAc.cpp.
| void Svc::SystemResourcesComponentBase::set_Tlm_OutputPort | ( | FwIndexType | portNum, |
| Fw::InputTlmPort * | port | ||
| ) |
Connect port to Tlm[portNum].
| portNum | The port number |
| port | The input port |
Definition at line 300 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 754 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_00
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 787 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_01
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 820 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_02
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 853 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_03
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 886 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_04
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 919 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_05
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 952 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_06
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 985 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_07
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1018 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_08
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1051 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_09
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1084 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_10
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1117 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_11
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1150 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_12
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1183 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_13
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1216 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_14
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1249 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel CPU_15
System's CPU Percentage
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1282 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel MEMORY_TOTAL
Total system memory in KB
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 622 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel MEMORY_USED
System memory used in KB
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 655 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel NON_VOLATILE_FREE
System non-volatile available in KB
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 721 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel NON_VOLATILE_TOTAL
System non-volatile available in KB
| arg | The telemetry value |
| _tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 688 of file SystemResourcesComponentAc.cpp.
|
protectedvirtual |
Unlock the guarded mutex.
Definition at line 1345 of file SystemResourcesComponentAc.cpp.
|
friend |
Friend class tester implementation to support white-box testing.
Definition at line 44 of file SystemResourcesComponentAc.hpp.
|
friend |
Friend class tester to support autocoded test harness.
Definition at line 42 of file SystemResourcesComponentAc.hpp.