F´ Flight Software - C/C++ Documentation
devel
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 U32) |
Set the ID base. More... | |
U32 | getIdBase () const |
Friends | |
class | SystemResourcesComponentBaseFriend |
Friend class for white-box testing. More... | |
Auto-generated base for SystemResources component.
Definition at line 34 of file SystemResourcesComponentAc.hpp.
|
protected |
Enumerations for numbers of special input ports.
Enumerator | |
---|---|
NUM_CMDDISP_INPUT_PORTS |
Definition at line 52 of file SystemResourcesComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
Enumerator | |
---|---|
NUM_RUN_INPUT_PORTS |
Definition at line 57 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 62 of file SystemResourcesComponentAc.hpp.
|
protected |
Command opcodes.
Enumerator | |
---|---|
OPCODE_ENABLE | A command to enable or disable system resource telemetry. |
OPCODE_VERSION | Report version as EVR. |
Definition at line 72 of file SystemResourcesComponentAc.hpp.
|
protected |
Event IDs.
Enumerator | |
---|---|
EVENTID_FRAMEWORK_VERSION | Version of the git repository. |
EVENTID_PROJECT_VERSION | Version of the git repository. |
Definition at line 78 of file SystemResourcesComponentAc.hpp.
|
protected |
Channel IDs.
Definition at line 84 of file SystemResourcesComponentAc.hpp.
|
protected |
Construct SystemResourcesComponentBase object.
compName | The component name |
Definition at line 431 of file SystemResourcesComponentAc.cpp.
|
protectedvirtual |
Destroy SystemResourcesComponentBase object.
Definition at line 438 of file SystemResourcesComponentAc.cpp.
|
protected |
Emit command response.
opCode | The opcode |
cmdSeq | The command sequence number |
response | The command response |
Definition at line 617 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 634 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 195 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 210 of file SystemResourcesComponentAc.cpp.
|
protected |
Get the number of CmdDisp input ports
Definition at line 448 of file SystemResourcesComponentAc.cpp.
|
protected |
Get the number of CmdReg output ports
Definition at line 468 of file SystemResourcesComponentAc.cpp.
|
protected |
Get the number of CmdStatus output ports
Definition at line 474 of file SystemResourcesComponentAc.cpp.
|
protected |
Get the number of Log output ports
Definition at line 480 of file SystemResourcesComponentAc.cpp.
|
protected |
Get the number of run input ports
Definition at line 458 of file SystemResourcesComponentAc.cpp.
|
protected |
Get the number of Time output ports
Definition at line 496 of file SystemResourcesComponentAc.cpp.
|
protected |
Get the number of Tlm output ports
Definition at line 502 of file SystemResourcesComponentAc.cpp.
|
protected |
Get the time
\return The current time
Definition at line 1629 of file SystemResourcesComponentAc.cpp.
void Svc::SystemResourcesComponentBase::init | ( | FwEnumStoreType | instance = 0 | ) |
Initialize SystemResourcesComponentBase object.
instance | The instance number |
Definition at line 20 of file SystemResourcesComponentAc.cpp.
|
protected |
Check whether port CmdReg is connected
portNum | The port number |
Definition at line 512 of file SystemResourcesComponentAc.cpp.
|
protected |
Check whether port CmdStatus is connected
portNum | The port number |
Definition at line 523 of file SystemResourcesComponentAc.cpp.
|
protected |
Check whether port Log is connected
portNum | The port number |
Definition at line 534 of file SystemResourcesComponentAc.cpp.
|
protected |
Check whether port Time is connected
portNum | The port number |
Definition at line 560 of file SystemResourcesComponentAc.cpp.
|
protected |
Check whether port Tlm is connected
portNum | The port number |
Definition at line 571 of file SystemResourcesComponentAc.cpp.
|
protectedvirtual |
Lock the guarded mutex.
Definition at line 1649 of file SystemResourcesComponentAc.cpp.
|
protected |
Log event FRAMEWORK_VERSION
Version of the git repository.
version | version string |
Definition at line 718 of file SystemResourcesComponentAc.cpp.
|
protected |
Log event PROJECT_VERSION
Version of the git repository.
version | version string |
Definition at line 790 of file SystemResourcesComponentAc.cpp.
void Svc::SystemResourcesComponentBase::regCommands | ( | ) |
Register commands with the Command Dispatcher.
Connect the dispatcher first
Definition at line 413 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 588 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 225 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 239 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 253 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 285 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 299 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 998 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 1031 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 1064 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 1097 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 1130 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 1163 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 1196 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 1229 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 1262 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 1295 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 1328 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 1361 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 1394 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 1427 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 1460 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 1493 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 1526 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel FRAMEWORK_VERSION
Software framework version
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1559 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 866 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 899 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 965 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 932 of file SystemResourcesComponentAc.cpp.
|
protected |
Write telemetry channel PROJECT_VERSION
Software project version
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1592 of file SystemResourcesComponentAc.cpp.
|
protectedvirtual |
Unlock the guarded mutex.
Definition at line 1655 of file SystemResourcesComponentAc.cpp.
|
protectedpure virtual |
Handler for command VERSION
Report version as EVR
opCode | The opcode |
cmdSeq | The command sequence number |
|
protected |
Base-class handler function for command VERSION
Report version as EVR
opCode | The opcode |
cmdSeq | The command sequence number |
args | The command argument buffer |
Definition at line 685 of file SystemResourcesComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 43 of file SystemResourcesComponentAc.hpp.