F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Loading...
Searching...
No Matches
Svc::PrmDbComponentBase Class Referenceabstract

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

#include <Svc/PrmDb/PrmDbComponentAc.hpp>

Inheritance diagram for Svc::PrmDbComponentBase:
Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase Svc::PrmDbImpl

Public Member Functions

void init (FwSizeType queueDepth, FwEnumStoreType instance=0)
 Initialize PrmDbComponentBase object.
 
Fw::InputCmdPortget_CmdDisp_InputPort (FwIndexType portNum)
 
Fw::InputPrmGetPortget_getPrm_InputPort (FwIndexType portNum)
 
Svc::InputPingPortget_pingIn_InputPort (FwIndexType portNum)
 
Fw::InputPrmSetPortget_setPrm_InputPort (FwIndexType portNum)
 
void set_CmdReg_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
 Connect port to CmdReg[portNum].
 
void set_CmdStatus_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
 Connect port to CmdStatus[portNum].
 
void set_Log_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
 Connect port to Log[portNum].
 
void set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
 Connect port to Time[portNum].
 
void set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port)
 Connect port to pingOut[portNum].
 
void regCommands ()
 Register commands with the Command Dispatcher.
 
- Public Member Functions inherited from Fw::ActiveComponentBase
void start (Os::Task::ParamType priority=Os::Task::TASK_DEFAULT, Os::Task::ParamType stackSize=Os::Task::TASK_DEFAULT, Os::Task::ParamType cpuAffinity=Os::Task::TASK_DEFAULT, Os::Task::ParamType identifier=Os::Task::TASK_DEFAULT)
 called by instantiator when task is to be started
 
void exit ()
 exit task in active component
 
Os::Task::Status join ()
 Join the thread.
 
 DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()")
 Join to thread with discarded value_ptr.
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base.
 
U32 getIdBase () const
 

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...
 
- Protected Types inherited from Fw::ActiveComponentBase
enum  Lifecycle { CREATED , DISPATCHING , FINALIZING , DONE }
 Tracks the lifecycle of the component. More...
 

Protected Member Functions

 PrmDbComponentBase (const char *compName="")
 Construct PrmDbComponentBase object.
 
virtual ~PrmDbComponentBase ()
 Destroy PrmDbComponentBase object.
 
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.
 
virtual void pingIn_handler (FwIndexType portNum, U32 key)=0
 Handler for input port pingIn.
 
virtual void setPrm_handler (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)=0
 Handler for input port setPrm.
 
Fw::ParamValid getPrm_handlerBase (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)
 Handler base-class function for input port getPrm.
 
void pingIn_handlerBase (FwIndexType portNum, U32 key)
 Handler base-class function for input port pingIn.
 
void setPrm_handlerBase (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)
 Handler base-class function for input port setPrm.
 
virtual void pingIn_preMsgHook (FwIndexType portNum, U32 key)
 Pre-message hook for async input port pingIn.
 
virtual void setPrm_preMsgHook (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)
 Pre-message hook for async input port setPrm.
 
void pingOut_out (FwIndexType portNum, U32 key)
 Invoke output port pingOut.
 
void cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
 Emit command response.
 
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.
 
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.
 
Fw::Time getTime ()
 
virtual void lock ()
 Lock the guarded mutex.
 
virtual void unLock ()
 Unlock the guarded mutex.
 
- Protected Member Functions inherited from Fw::ActiveComponentBase
 ActiveComponentBase (const char *name)
 Constructor.
 
virtual ~ActiveComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 initialization code
 
virtual void preamble ()
 A function that will be called before the event loop is entered.
 
MsgDispatchStatus dispatch ()
 The function that will dispatching messages.
 
virtual void finalizer ()
 A function that will be called after exiting the loop.
 
- Protected Member Functions inherited from Fw::QueuedComponentBase
 QueuedComponentBase (const char *name)
 Constructor.
 
virtual ~QueuedComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 initialization function
 
Os::Queue::Status createQueue (FwSizeType depth, FwSizeType msgSize)
 
NATIVE_INT_TYPE getNumMsgsDropped ()
 return number of messages dropped
 
void incNumMsgDropped ()
 increment the number of messages dropped
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor.
 
virtual ~PassiveComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 Initialization function.
 
NATIVE_INT_TYPE getInstance () const
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor.
 
virtual ~ObjBase ()
 Destructor.
 
void init ()
 Object initializer.
 

Friends

class PrmDbComponentBaseFriend
 Friend class for white-box testing.
 

Additional Inherited Members

- Public Types inherited from Fw::ActiveComponentBase
enum  { ACTIVE_COMPONENT_EXIT }
 
- Public Types inherited from Fw::QueuedComponentBase
enum  MsgDispatchStatus { MSG_DISPATCH_OK , MSG_DISPATCH_EMPTY , MSG_DISPATCH_ERROR , MSG_DISPATCH_EXIT }
 
- Protected Attributes inherited from Fw::ActiveComponentBase
Os::Task m_task
 task object for active component
 
- Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue m_queue
 queue object for active component
 

Detailed Description

Auto-generated base for PrmDb component.

A component for storing parameters

Definition at line 37 of file PrmDbComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDDISP_INPUT_PORTS 

Definition at line 55 of file PrmDbComponentAc.hpp.

◆ anonymous enum

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

◆ 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 

Definition at line 67 of file PrmDbComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_PINGOUT_OUTPUT_PORTS 

Definition at line 76 of file PrmDbComponentAc.hpp.

◆ anonymous enum

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

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_PRMIDNOTFOUND 

Parameter ID not found in database.

EVENTID_PRMIDUPDATED 

Parameter ID updated in database.

EVENTID_PRMDBFULL 

Parameter database is full.

EVENTID_PRMIDADDED 

Parameter ID added to database.

EVENTID_PRMFILEWRITEERROR 

Failed to write parameter file.

EVENTID_PRMFILESAVECOMPLETE 

Save of parameter file completed.

EVENTID_PRMFILEREADERROR 

Failed to read parameter file.

EVENTID_PRMFILELOADCOMPLETE 

Load of parameter file completed.

Definition at line 86 of file PrmDbComponentAc.hpp.

◆ anonymous enum

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

Constructor & Destructor Documentation

◆ PrmDbComponentBase()

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

Construct PrmDbComponentBase object.

Parameters
compNameThe component name

Definition at line 574 of file PrmDbComponentAc.cpp.

◆ ~PrmDbComponentBase()

Svc::PrmDbComponentBase::~PrmDbComponentBase ( )
protectedvirtual

Destroy PrmDbComponentBase object.

Definition at line 581 of file PrmDbComponentAc.cpp.

Member Function Documentation

◆ cmdResponse_out()

void Svc::PrmDbComponentBase::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 947 of file PrmDbComponentAc.cpp.

◆ get_CmdDisp_InputPort()

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

Get special input port at index

Returns
CmdDisp[portNum]
Parameters
portNumThe port number

Definition at line 308 of file PrmDbComponentAc.cpp.

◆ get_getPrm_InputPort()

Fw::InputPrmGetPort * Svc::PrmDbComponentBase::get_getPrm_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
getPrm[portNum]
Parameters
portNumThe port number

Definition at line 323 of file PrmDbComponentAc.cpp.

◆ get_pingIn_InputPort()

Svc::InputPingPort * Svc::PrmDbComponentBase::get_pingIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
pingIn[portNum]
Parameters
portNumThe port number

Definition at line 334 of file PrmDbComponentAc.cpp.

◆ get_setPrm_InputPort()

Fw::InputPrmSetPort * Svc::PrmDbComponentBase::get_setPrm_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
setPrm[portNum]
Parameters
portNumThe port number

Definition at line 345 of file PrmDbComponentAc.cpp.

◆ getNum_CmdDisp_InputPorts()

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

Get the number of CmdDisp input ports

Returns
The number of CmdDisp input ports

Definition at line 591 of file PrmDbComponentAc.cpp.

◆ getNum_CmdReg_OutputPorts()

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

Get the number of CmdReg output ports

Returns
The number of CmdReg output ports

Definition at line 623 of file PrmDbComponentAc.cpp.

◆ getNum_CmdStatus_OutputPorts()

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

Get the number of CmdStatus output ports

Returns
The number of CmdStatus output ports

Definition at line 629 of file PrmDbComponentAc.cpp.

◆ getNum_getPrm_InputPorts()

FwIndexType Svc::PrmDbComponentBase::getNum_getPrm_InputPorts ( ) const
protected

Get the number of getPrm input ports

Returns
The number of getPrm input ports

Definition at line 601 of file PrmDbComponentAc.cpp.

◆ getNum_Log_OutputPorts()

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

Get the number of Log output ports

Returns
The number of Log output ports

Definition at line 635 of file PrmDbComponentAc.cpp.

◆ getNum_pingIn_InputPorts()

FwIndexType Svc::PrmDbComponentBase::getNum_pingIn_InputPorts ( ) const
protected

Get the number of pingIn input ports

Returns
The number of pingIn input ports

Definition at line 607 of file PrmDbComponentAc.cpp.

◆ getNum_pingOut_OutputPorts()

FwIndexType Svc::PrmDbComponentBase::getNum_pingOut_OutputPorts ( ) const
protected

Get the number of pingOut output ports

Returns
The number of pingOut output ports

Definition at line 661 of file PrmDbComponentAc.cpp.

◆ getNum_setPrm_InputPorts()

FwIndexType Svc::PrmDbComponentBase::getNum_setPrm_InputPorts ( ) const
protected

Get the number of setPrm input ports

Returns
The number of setPrm input ports

Definition at line 613 of file PrmDbComponentAc.cpp.

◆ getNum_Time_OutputPorts()

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

Get the number of Time output ports

Returns
The number of Time output ports

Definition at line 651 of file PrmDbComponentAc.cpp.

◆ getPrm_handler()

virtual Fw::ParamValid Svc::PrmDbComponentBase::getPrm_handler ( FwIndexType  portNum,
FwPrmIdType  id,
Fw::ParamBuffer val 
)
protectedpure virtual

Handler for input port getPrm.

Parameters
portNumThe port number
idParameter ID
valBuffer containing serialized parameter value

◆ getPrm_handlerBase()

Fw::ParamValid Svc::PrmDbComponentBase::getPrm_handlerBase ( FwIndexType  portNum,
FwPrmIdType  id,
Fw::ParamBuffer val 
)
protected

Handler base-class function for input port getPrm.

Parameters
portNumThe port number
idParameter ID
valBuffer containing serialized parameter value

Definition at line 751 of file PrmDbComponentAc.cpp.

◆ getTime()

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

Get the time

\return The current time

Definition at line 1820 of file PrmDbComponentAc.cpp.

◆ init()

void Svc::PrmDbComponentBase::init ( FwSizeType  queueDepth,
FwEnumStoreType  instance = 0 
)

Initialize PrmDbComponentBase object.

Parameters
queueDepthThe queue depth
instanceThe instance number

Definition at line 72 of file PrmDbComponentAc.cpp.

◆ isConnected_CmdReg_OutputPort()

bool Svc::PrmDbComponentBase::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 671 of file PrmDbComponentAc.cpp.

◆ isConnected_CmdStatus_OutputPort()

bool Svc::PrmDbComponentBase::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 682 of file PrmDbComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::PrmDbComponentBase::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 693 of file PrmDbComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::PrmDbComponentBase::isConnected_pingOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port pingOut is connected

Returns
Whether port pingOut is connected
Parameters
portNumThe port number

Definition at line 734 of file PrmDbComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::PrmDbComponentBase::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 719 of file PrmDbComponentAc.cpp.

◆ lock()

void Svc::PrmDbComponentBase::lock ( )
protectedvirtual

Lock the guarded mutex.

Definition at line 1840 of file PrmDbComponentAc.cpp.

◆ log_ACTIVITY_HI_PrmFileLoadComplete()

void Svc::PrmDbComponentBase::log_ACTIVITY_HI_PrmFileLoadComplete ( U32  records) const
protected

Log event PrmFileLoadComplete

Load of parameter file completed

Parameters
recordsThe number of records loaded

Definition at line 1723 of file PrmDbComponentAc.cpp.

◆ log_ACTIVITY_HI_PrmFileSaveComplete()

void Svc::PrmDbComponentBase::log_ACTIVITY_HI_PrmFileSaveComplete ( U32  records) const
protected

Log event PrmFileSaveComplete

Save of parameter file completed

Parameters
recordsThe number of records saved

Definition at line 1518 of file PrmDbComponentAc.cpp.

◆ log_ACTIVITY_HI_PrmIdAdded()

void Svc::PrmDbComponentBase::log_ACTIVITY_HI_PrmIdAdded ( U32  Id) const
protected

Log event PrmIdAdded

Parameter ID added to database

Parameters
IdThe parameter ID

Definition at line 1313 of file PrmDbComponentAc.cpp.

◆ log_ACTIVITY_HI_PrmIdUpdated()

void Svc::PrmDbComponentBase::log_ACTIVITY_HI_PrmIdUpdated ( U32  Id) const
protected

Log event PrmIdUpdated

Parameter ID updated in database

Parameters
IdThe parameter ID

Definition at line 1136 of file PrmDbComponentAc.cpp.

◆ log_FATAL_PrmDbFull()

void Svc::PrmDbComponentBase::log_FATAL_PrmDbFull ( U32  Id) const
protected

Log event PrmDbFull

Parameter database is full

Parameters
IdThe parameter ID

Definition at line 1218 of file PrmDbComponentAc.cpp.

◆ log_WARNING_HI_PrmFileReadError()

void Svc::PrmDbComponentBase::log_WARNING_HI_PrmFileReadError ( Svc::PrmDb_PrmReadError  stage,
I32  record,
I32  error 
) const
protected

Log event PrmFileReadError

Failed to read parameter file

Parameters
stageThe read stage
recordThe record that had the failure
errorThe error code

Definition at line 1600 of file PrmDbComponentAc.cpp.

◆ log_WARNING_HI_PrmFileWriteError()

void Svc::PrmDbComponentBase::log_WARNING_HI_PrmFileWriteError ( Svc::PrmDb_PrmWriteError  stage,
I32  record,
I32  error 
) const
protected

Log event PrmFileWriteError

Failed to write parameter file

Parameters
stageThe write stage
recordThe record that had the failure
errorThe error code

Definition at line 1395 of file PrmDbComponentAc.cpp.

◆ log_WARNING_LO_PrmIdNotFound()

void Svc::PrmDbComponentBase::log_WARNING_LO_PrmIdNotFound ( U32  Id)
protected

Log event PrmIdNotFound

Parameter ID not found in database.

Parameters
IdThe parameter ID

Definition at line 1046 of file PrmDbComponentAc.cpp.

◆ log_WARNING_LO_PrmIdNotFound_ThrottleClear()

void Svc::PrmDbComponentBase::log_WARNING_LO_PrmIdNotFound_ThrottleClear ( )
protected

Reset throttle value for PrmIdNotFound.

Definition at line 1809 of file PrmDbComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::PrmDbComponentBase::pingIn_handler ( FwIndexType  portNum,
U32  key 
)
protectedpure virtual

Handler for input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

◆ pingIn_handlerBase()

void Svc::PrmDbComponentBase::pingIn_handlerBase ( FwIndexType  portNum,
U32  key 
)
protected

Handler base-class function for input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 782 of file PrmDbComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::PrmDbComponentBase::pingIn_preMsgHook ( FwIndexType  portNum,
U32  key 
)
protectedvirtual

Pre-message hook for async input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 905 of file PrmDbComponentAc.cpp.

◆ pingOut_out()

void Svc::PrmDbComponentBase::pingOut_out ( FwIndexType  portNum,
U32  key 
)
protected

Invoke output port pingOut.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 928 of file PrmDbComponentAc.cpp.

◆ PRM_SAVE_FILE_cmdHandler()

virtual void Svc::PrmDbComponentBase::PRM_SAVE_FILE_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedpure virtual

Handler for command PRM_SAVE_FILE

Command to save parameter image to file. Uses file name passed to constructor

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

◆ PRM_SAVE_FILE_cmdHandlerBase()

void Svc::PrmDbComponentBase::PRM_SAVE_FILE_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command PRM_SAVE_FILE

Command to save parameter image to file. Uses file name passed to constructor

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 964 of file PrmDbComponentAc.cpp.

◆ PRM_SAVE_FILE_preMsgHook()

void Svc::PrmDbComponentBase::PRM_SAVE_FILE_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command PRM_SAVE_FILE.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1031 of file PrmDbComponentAc.cpp.

◆ regCommands()

void Svc::PrmDbComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 560 of file PrmDbComponentAc.cpp.

◆ set_CmdReg_OutputPort()

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

Connect port to CmdReg[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 360 of file PrmDbComponentAc.cpp.

◆ set_CmdStatus_OutputPort()

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

Connect port to CmdStatus[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 374 of file PrmDbComponentAc.cpp.

◆ set_Log_OutputPort()

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

Connect port to Log[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 388 of file PrmDbComponentAc.cpp.

◆ set_pingOut_OutputPort()

void Svc::PrmDbComponentBase::set_pingOut_OutputPort ( FwIndexType  portNum,
Svc::InputPingPort port 
)

Connect port to pingOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 438 of file PrmDbComponentAc.cpp.

◆ set_Time_OutputPort()

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

Connect port to Time[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 420 of file PrmDbComponentAc.cpp.

◆ setPrm_handler()

virtual void Svc::PrmDbComponentBase::setPrm_handler ( FwIndexType  portNum,
FwPrmIdType  id,
Fw::ParamBuffer val 
)
protectedpure virtual

Handler for input port setPrm.

Parameters
portNumThe port number
idParameter ID
valBuffer containing serialized parameter value

◆ setPrm_handlerBase()

void Svc::PrmDbComponentBase::setPrm_handlerBase ( FwIndexType  portNum,
FwPrmIdType  id,
Fw::ParamBuffer val 
)
protected

Handler base-class function for input port setPrm.

Parameters
portNumThe port number
idParameter ID
valBuffer containing serialized parameter value

Definition at line 835 of file PrmDbComponentAc.cpp.

◆ setPrm_preMsgHook()

void Svc::PrmDbComponentBase::setPrm_preMsgHook ( FwIndexType  portNum,
FwPrmIdType  id,
Fw::ParamBuffer val 
)
protectedvirtual

Pre-message hook for async input port setPrm.

Parameters
portNumThe port number
idParameter ID
valBuffer containing serialized parameter value

Definition at line 914 of file PrmDbComponentAc.cpp.

◆ unLock()

void Svc::PrmDbComponentBase::unLock ( )
protectedvirtual

Unlock the guarded mutex.

Definition at line 1846 of file PrmDbComponentAc.cpp.

Friends And Related Symbol Documentation

◆ PrmDbComponentBaseFriend

friend class PrmDbComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 46 of file PrmDbComponentAc.hpp.


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