F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Svc::SystemResourcesComponentBase Class Referenceabstract

Auto-generated base for SystemResources component. More...

#include <Svc/SystemResources/SystemResourcesComponentAc.hpp>

Inheritance diagram for Svc::SystemResourcesComponentBase:
Fw::PassiveComponentBase Fw::ObjBase Svc::SystemResources

Public Member Functions

void init (FwEnumStoreType instance=0)
 Initialize SystemResourcesComponentBase object. More...
 
Fw::InputCmdPortget_CmdDisp_InputPort (FwIndexType portNum)
 
Svc::InputSchedPortget_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
 

Protected Types

enum  { NUM_CMDDISP_INPUT_PORTS = 1 }
 Enumerations for numbers of special input ports. More...
 
enum  { NUM_RUN_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 , NUM_TLM_OUTPUT_PORTS = 1
}
 Enumerations for numbers of special output ports. More...
 
enum  { OPCODE_ENABLE = 0x0 , OPCODE_VERSION = 0x1 }
 Command opcodes. More...
 
enum  { EVENTID_FRAMEWORK_VERSION = 0x0 , EVENTID_PROJECT_VERSION = 0x1 }
 Event IDs. More...
 
enum  {
  CHANNELID_MEMORY_TOTAL = 0x0 , CHANNELID_MEMORY_USED = 0x1 , CHANNELID_NON_VOLATILE_TOTAL = 0x2 , CHANNELID_NON_VOLATILE_FREE = 0x3 ,
  CHANNELID_CPU = 0x4 , CHANNELID_CPU_00 = 0x5 , CHANNELID_CPU_01 = 0x6 , CHANNELID_CPU_02 = 0x7 ,
  CHANNELID_CPU_03 = 0x8 , CHANNELID_CPU_04 = 0x9 , CHANNELID_CPU_05 = 0xa , CHANNELID_CPU_06 = 0xb ,
  CHANNELID_CPU_07 = 0xc , CHANNELID_CPU_08 = 0xd , CHANNELID_CPU_09 = 0xe , CHANNELID_CPU_10 = 0xf ,
  CHANNELID_CPU_11 = 0x10 , CHANNELID_CPU_12 = 0x11 , CHANNELID_CPU_13 = 0x12 , CHANNELID_CPU_14 = 0x13 ,
  CHANNELID_CPU_15 = 0x14 , CHANNELID_FRAMEWORK_VERSION = 0x15 , CHANNELID_PROJECT_VERSION = 0x16
}
 Channel IDs. More...
 

Protected Member Functions

 SystemResourcesComponentBase (const char *compName="")
 Construct SystemResourcesComponentBase object. More...
 
virtual ~SystemResourcesComponentBase ()
 Destroy SystemResourcesComponentBase object. More...
 
FwIndexType getNum_CmdDisp_InputPorts () const
 
FwIndexType getNum_run_InputPorts () const
 
FwIndexType getNum_CmdReg_OutputPorts () const
 
FwIndexType getNum_CmdStatus_OutputPorts () const
 
FwIndexType getNum_Log_OutputPorts () const
 
FwIndexType getNum_Time_OutputPorts () const
 
FwIndexType getNum_Tlm_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_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
 
virtual void VERSION_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
 
void ENABLE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void VERSION_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void log_ACTIVITY_LO_FRAMEWORK_VERSION (const Fw::StringBase &version)
 
void log_ACTIVITY_LO_PROJECT_VERSION (const Fw::StringBase &version)
 
void tlmWrite_MEMORY_TOTAL (U64 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_MEMORY_USED (U64 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_NON_VOLATILE_TOTAL (U64 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_NON_VOLATILE_FREE (U64 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_00 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_01 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_02 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_03 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_04 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_05 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_06 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_07 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_08 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_09 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_10 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_11 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_12 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_13 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_14 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_CPU_15 (F32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_FRAMEWORK_VERSION (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_PROJECT_VERSION (const Fw::StringBase &arg, Fw::Time _tlmTime=Fw::Time())
 
Fw::Time getTime ()
 
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...
 

Friends

class SystemResourcesComponentBaseFriend
 Friend class for white-box testing. More...
 

Detailed Description

Auto-generated base for SystemResources component.

Definition at line 34 of file SystemResourcesComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDDISP_INPUT_PORTS 

Definition at line 52 of file SystemResourcesComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_RUN_INPUT_PORTS 

Definition at line 57 of file SystemResourcesComponentAc.hpp.

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
protected

Channel IDs.

Enumerator
CHANNELID_MEMORY_TOTAL 

Channel ID for MEMORY_TOTAL.

CHANNELID_MEMORY_USED 

Channel ID for MEMORY_USED.

CHANNELID_NON_VOLATILE_TOTAL 

Channel ID for NON_VOLATILE_TOTAL.

CHANNELID_NON_VOLATILE_FREE 

Channel ID for NON_VOLATILE_FREE.

CHANNELID_CPU 

Channel ID for CPU.

CHANNELID_CPU_00 

Channel ID for CPU_00.

CHANNELID_CPU_01 

Channel ID for CPU_01.

CHANNELID_CPU_02 

Channel ID for CPU_02.

CHANNELID_CPU_03 

Channel ID for CPU_03.

CHANNELID_CPU_04 

Channel ID for CPU_04.

CHANNELID_CPU_05 

Channel ID for CPU_05.

CHANNELID_CPU_06 

Channel ID for CPU_06.

CHANNELID_CPU_07 

Channel ID for CPU_07.

CHANNELID_CPU_08 

Channel ID for CPU_08.

CHANNELID_CPU_09 

Channel ID for CPU_09.

CHANNELID_CPU_10 

Channel ID for CPU_10.

CHANNELID_CPU_11 

Channel ID for CPU_11.

CHANNELID_CPU_12 

Channel ID for CPU_12.

CHANNELID_CPU_13 

Channel ID for CPU_13.

CHANNELID_CPU_14 

Channel ID for CPU_14.

CHANNELID_CPU_15 

Channel ID for CPU_15.

CHANNELID_FRAMEWORK_VERSION 

Channel ID for FRAMEWORK_VERSION.

CHANNELID_PROJECT_VERSION 

Channel ID for PROJECT_VERSION.

Definition at line 84 of file SystemResourcesComponentAc.hpp.

Constructor & Destructor Documentation

◆ SystemResourcesComponentBase()

Svc::SystemResourcesComponentBase::SystemResourcesComponentBase ( const char *  compName = "")
protected

Construct SystemResourcesComponentBase object.

Parameters
compNameThe component name

Definition at line 431 of file SystemResourcesComponentAc.cpp.

◆ ~SystemResourcesComponentBase()

Svc::SystemResourcesComponentBase::~SystemResourcesComponentBase ( )
protectedvirtual

Destroy SystemResourcesComponentBase object.

Definition at line 438 of file SystemResourcesComponentAc.cpp.

Member Function Documentation

◆ cmdResponse_out()

void Svc::SystemResourcesComponentBase::cmdResponse_out ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdResponse  response 
)
protected

Emit command response.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
responseThe command response

Definition at line 617 of file SystemResourcesComponentAc.cpp.

◆ ENABLE_cmdHandler()

virtual void Svc::SystemResourcesComponentBase::ENABLE_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
Svc::SystemResourceEnabled  enable 
)
protectedpure virtual

Handler for command ENABLE

A command to enable or disable system resource telemetry

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
enablewhether or not system resource telemetry is enabled

◆ ENABLE_cmdHandlerBase()

void Svc::SystemResourcesComponentBase::ENABLE_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command ENABLE

A command to enable or disable system resource telemetry

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 634 of file SystemResourcesComponentAc.cpp.

◆ get_CmdDisp_InputPort()

Fw::InputCmdPort * Svc::SystemResourcesComponentBase::get_CmdDisp_InputPort ( FwIndexType  portNum)

Get special input port at index

Returns
CmdDisp[portNum]
Parameters
portNumThe port number

Definition at line 195 of file SystemResourcesComponentAc.cpp.

◆ get_run_InputPort()

Svc::InputSchedPort * Svc::SystemResourcesComponentBase::get_run_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
run[portNum]
Parameters
portNumThe port number

Definition at line 210 of file SystemResourcesComponentAc.cpp.

◆ getNum_CmdDisp_InputPorts()

FwIndexType Svc::SystemResourcesComponentBase::getNum_CmdDisp_InputPorts ( ) const
protected

Get the number of CmdDisp input ports

Returns
The number of CmdDisp input ports

Definition at line 448 of file SystemResourcesComponentAc.cpp.

◆ getNum_CmdReg_OutputPorts()

FwIndexType Svc::SystemResourcesComponentBase::getNum_CmdReg_OutputPorts ( ) const
protected

Get the number of CmdReg output ports

Returns
The number of CmdReg output ports

Definition at line 468 of file SystemResourcesComponentAc.cpp.

◆ getNum_CmdStatus_OutputPorts()

FwIndexType Svc::SystemResourcesComponentBase::getNum_CmdStatus_OutputPorts ( ) const
protected

Get the number of CmdStatus output ports

Returns
The number of CmdStatus output ports

Definition at line 474 of file SystemResourcesComponentAc.cpp.

◆ getNum_Log_OutputPorts()

FwIndexType Svc::SystemResourcesComponentBase::getNum_Log_OutputPorts ( ) const
protected

Get the number of Log output ports

Returns
The number of Log output ports

Definition at line 480 of file SystemResourcesComponentAc.cpp.

◆ getNum_run_InputPorts()

FwIndexType Svc::SystemResourcesComponentBase::getNum_run_InputPorts ( ) const
protected

Get the number of run input ports

Returns
The number of run input ports

Definition at line 458 of file SystemResourcesComponentAc.cpp.

◆ getNum_Time_OutputPorts()

FwIndexType Svc::SystemResourcesComponentBase::getNum_Time_OutputPorts ( ) const
protected

Get the number of Time output ports

Returns
The number of Time output ports

Definition at line 496 of file SystemResourcesComponentAc.cpp.

◆ getNum_Tlm_OutputPorts()

FwIndexType Svc::SystemResourcesComponentBase::getNum_Tlm_OutputPorts ( ) const
protected

Get the number of Tlm output ports

Returns
The number of Tlm output ports

Definition at line 502 of file SystemResourcesComponentAc.cpp.

◆ getTime()

Fw::Time Svc::SystemResourcesComponentBase::getTime ( )
protected

Get the time

\return The current time

Definition at line 1629 of file SystemResourcesComponentAc.cpp.

◆ init()

void Svc::SystemResourcesComponentBase::init ( FwEnumStoreType  instance = 0)

Initialize SystemResourcesComponentBase object.

Parameters
instanceThe instance number

Definition at line 20 of file SystemResourcesComponentAc.cpp.

◆ isConnected_CmdReg_OutputPort()

bool Svc::SystemResourcesComponentBase::isConnected_CmdReg_OutputPort ( FwIndexType  portNum)
protected

Check whether port CmdReg is connected

Returns
Whether port CmdReg is connected
Parameters
portNumThe port number

Definition at line 512 of file SystemResourcesComponentAc.cpp.

◆ isConnected_CmdStatus_OutputPort()

bool Svc::SystemResourcesComponentBase::isConnected_CmdStatus_OutputPort ( FwIndexType  portNum)
protected

Check whether port CmdStatus is connected

Returns
Whether port CmdStatus is connected
Parameters
portNumThe port number

Definition at line 523 of file SystemResourcesComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::SystemResourcesComponentBase::isConnected_Log_OutputPort ( FwIndexType  portNum)
protected

Check whether port Log is connected

Returns
Whether port Log is connected
Parameters
portNumThe port number

Definition at line 534 of file SystemResourcesComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::SystemResourcesComponentBase::isConnected_Time_OutputPort ( FwIndexType  portNum)
protected

Check whether port Time is connected

Returns
Whether port Time is connected
Parameters
portNumThe port number

Definition at line 560 of file SystemResourcesComponentAc.cpp.

◆ isConnected_Tlm_OutputPort()

bool Svc::SystemResourcesComponentBase::isConnected_Tlm_OutputPort ( FwIndexType  portNum)
protected

Check whether port Tlm is connected

Returns
Whether port Tlm is connected
Parameters
portNumThe port number

Definition at line 571 of file SystemResourcesComponentAc.cpp.

◆ lock()

void Svc::SystemResourcesComponentBase::lock ( )
protectedvirtual

Lock the guarded mutex.

Definition at line 1649 of file SystemResourcesComponentAc.cpp.

◆ log_ACTIVITY_LO_FRAMEWORK_VERSION()

void Svc::SystemResourcesComponentBase::log_ACTIVITY_LO_FRAMEWORK_VERSION ( const Fw::StringBase version)
protected

Log event FRAMEWORK_VERSION

Version of the git repository.

Parameters
versionversion string

Definition at line 718 of file SystemResourcesComponentAc.cpp.

◆ log_ACTIVITY_LO_PROJECT_VERSION()

void Svc::SystemResourcesComponentBase::log_ACTIVITY_LO_PROJECT_VERSION ( const Fw::StringBase version)
protected

Log event PROJECT_VERSION

Version of the git repository.

Parameters
versionversion string

Definition at line 790 of file SystemResourcesComponentAc.cpp.

◆ regCommands()

void Svc::SystemResourcesComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 413 of file SystemResourcesComponentAc.cpp.

◆ run_handler()

virtual void Svc::SystemResourcesComponentBase::run_handler ( FwIndexType  portNum,
U32  context 
)
protectedpure virtual

Handler for input port run.

Parameters
portNumThe port number
contextThe call order

◆ run_handlerBase()

void Svc::SystemResourcesComponentBase::run_handlerBase ( FwIndexType  portNum,
U32  context 
)
protected

Handler base-class function for input port run.

Parameters
portNumThe port number
contextThe call order

Definition at line 588 of file SystemResourcesComponentAc.cpp.

◆ set_CmdReg_OutputPort()

void Svc::SystemResourcesComponentBase::set_CmdReg_OutputPort ( FwIndexType  portNum,
Fw::InputCmdRegPort port 
)

Connect port to CmdReg[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 225 of file SystemResourcesComponentAc.cpp.

◆ set_CmdStatus_OutputPort()

void Svc::SystemResourcesComponentBase::set_CmdStatus_OutputPort ( FwIndexType  portNum,
Fw::InputCmdResponsePort port 
)

Connect port to CmdStatus[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 239 of file SystemResourcesComponentAc.cpp.

◆ set_Log_OutputPort()

void Svc::SystemResourcesComponentBase::set_Log_OutputPort ( FwIndexType  portNum,
Fw::InputLogPort port 
)

Connect port to Log[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 253 of file SystemResourcesComponentAc.cpp.

◆ set_Time_OutputPort()

void Svc::SystemResourcesComponentBase::set_Time_OutputPort ( FwIndexType  portNum,
Fw::InputTimePort port 
)

Connect port to Time[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 285 of file SystemResourcesComponentAc.cpp.

◆ set_Tlm_OutputPort()

void Svc::SystemResourcesComponentBase::set_Tlm_OutputPort ( FwIndexType  portNum,
Fw::InputTlmPort port 
)

Connect port to Tlm[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 299 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 998 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_00()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_00 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_00

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1031 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_01()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_01 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_01

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1064 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_02()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_02 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_02

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1097 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_03()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_03 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_03

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1130 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_04()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_04 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_04

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1163 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_05()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_05 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_05

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1196 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_06()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_06 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_06

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1229 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_07()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_07 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_07

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1262 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_08()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_08 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_08

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1295 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_09()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_09 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_09

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1328 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_10()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_10 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_10

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1361 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_11()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_11 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_11

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1394 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_12()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_12 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_12

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1427 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_13()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_13 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_13

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1460 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_14()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_14 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_14

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1493 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_CPU_15()

void Svc::SystemResourcesComponentBase::tlmWrite_CPU_15 ( F32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel CPU_15

System's CPU Percentage

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1526 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_FRAMEWORK_VERSION()

void Svc::SystemResourcesComponentBase::tlmWrite_FRAMEWORK_VERSION ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel FRAMEWORK_VERSION

Software framework version

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1559 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_MEMORY_TOTAL()

void Svc::SystemResourcesComponentBase::tlmWrite_MEMORY_TOTAL ( U64  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel MEMORY_TOTAL

Total system memory in KB

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 866 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_MEMORY_USED()

void Svc::SystemResourcesComponentBase::tlmWrite_MEMORY_USED ( U64  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel MEMORY_USED

System memory used in KB

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 899 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_NON_VOLATILE_FREE()

void Svc::SystemResourcesComponentBase::tlmWrite_NON_VOLATILE_FREE ( U64  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel NON_VOLATILE_FREE

System non-volatile available in KB

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 965 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_NON_VOLATILE_TOTAL()

void Svc::SystemResourcesComponentBase::tlmWrite_NON_VOLATILE_TOTAL ( U64  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel NON_VOLATILE_TOTAL

System non-volatile available in KB

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 932 of file SystemResourcesComponentAc.cpp.

◆ tlmWrite_PROJECT_VERSION()

void Svc::SystemResourcesComponentBase::tlmWrite_PROJECT_VERSION ( const Fw::StringBase arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel PROJECT_VERSION

Software project version

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1592 of file SystemResourcesComponentAc.cpp.

◆ unLock()

void Svc::SystemResourcesComponentBase::unLock ( )
protectedvirtual

Unlock the guarded mutex.

Definition at line 1655 of file SystemResourcesComponentAc.cpp.

◆ VERSION_cmdHandler()

virtual void Svc::SystemResourcesComponentBase::VERSION_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedpure virtual

Handler for command VERSION

Report version as EVR

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

◆ VERSION_cmdHandlerBase()

void Svc::SystemResourcesComponentBase::VERSION_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command VERSION

Report version as EVR

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 685 of file SystemResourcesComponentAc.cpp.

Friends And Related Function Documentation

◆ SystemResourcesComponentBaseFriend

friend class SystemResourcesComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 43 of file SystemResourcesComponentAc.hpp.


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