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

#include <Svc/SystemResources/SystemResources.hpp>

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

Public Types

typedef void(SystemResourcesComponentBase::* cpuTlmFunc) (F32, Fw::Time)
 

Public Member Functions

 SystemResources (const char *const compName)
 
void init (const NATIVE_INT_TYPE instance=0)
 
 ~SystemResources (void)
 
- Public Member Functions inherited from Svc::SystemResourcesComponentBase
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
 

Additional Inherited Members

- Protected Types inherited from Svc::SystemResourcesComponentBase
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 inherited from Svc::SystemResourcesComponentBase
 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)
 
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...
 
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...
 

Detailed Description

Definition at line 22 of file SystemResources.hpp.

Member Typedef Documentation

◆ cpuTlmFunc

typedef void(SystemResourcesComponentBase::* Svc::SystemResources::cpuTlmFunc) (F32, Fw::Time)

Definition at line 42 of file SystemResources.hpp.

Constructor & Destructor Documentation

◆ SystemResources()

Svc::SystemResources::SystemResources ( const char *const  compName)

Construct object SystemResources

Parameters
compNameThe component name

Definition at line 24 of file SystemResources.cpp.

◆ ~SystemResources()

Svc::SystemResources::~SystemResources ( void  )

Destroy object SystemResources

Definition at line 65 of file SystemResources.cpp.

Member Function Documentation

◆ init()

void Svc::SystemResources::init ( const NATIVE_INT_TYPE  instance = 0)

Initialize object SystemResources

Parameters
instanceThe instance number

Definition at line 61 of file SystemResources.cpp.


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