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

#include <Svc/PrmDb/PrmDbComponentAc.hpp>

Inheritance diagram for Svc::PrmDbComponentBase:

Public Member Functions
void	init (FwSizeType queueDepth, FwEnumStoreType instance=0)
	Initialize PrmDbComponentBase object. More...

Fw::InputCmdPort *	get_CmdDisp_InputPort (FwIndexType portNum)

Fw::InputPrmGetPort *	get_getPrm_InputPort (FwIndexType portNum)

Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType portNum)

Fw::InputPrmSetPort *	get_setPrm_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_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port)
	Connect port to pingOut[portNum]. More...

void	regCommands ()
	Register commands with the Command Dispatcher. More...

Public Member Functions inherited from Fw::ActiveComponentBase
void	start (FwTaskPriorityType priority=Os::Task::TASK_PRIORITY_DEFAULT, FwSizeType stackSize=Os::Task::TASK_DEFAULT, FwSizeType cpuAffinity=Os::Task::TASK_DEFAULT, FwTaskIdType identifier=static_cast< FwTaskIdType >(Os::Task::TASK_DEFAULT))
	called by instantiator when task is to be started More...

void	exit ()
	exit task in active component More...

Os::Task::Status	join ()
	Join the thread. More...

	DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()")
	Join to thread with discarded value_ptr. More...

Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const FwIdType)
	Set the ID base. More...

FwIdType	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, OPCODE_PRM_LOAD_FILE = 0x1, OPCODE_PRM_COMMIT_STAGED = 0x2 }
	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, EVENTID_PRMDBCOMMITCOMPLETE = 0x8, EVENTID_PRMDBCOPYALLCOMPLETE = 0x9, EVENTID_PRMDBFILELOADFAILED = 0xa, EVENTID_PRMDBFILELOADINVALIDACTION = 0xb }
	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. More...

virtual	~PrmDbComponentBase ()
	Destroy PrmDbComponentBase 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_pingOut_OutputPort (FwIndexType portNum)

virtual Fw::ParamValid	getPrm_handler (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)=0
	Handler for input port getPrm. More...

virtual void	pingIn_handler (FwIndexType portNum, U32 key)=0
	Handler for input port pingIn. More...

virtual void	setPrm_handler (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)=0
	Handler for input port setPrm. More...

Fw::ParamValid	getPrm_handlerBase (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)
	Handler base-class function for input port getPrm. More...

void	pingIn_handlerBase (FwIndexType portNum, U32 key)
	Handler base-class function for input port pingIn. More...

void	setPrm_handlerBase (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)
	Handler base-class function for input port setPrm. More...

virtual void	pingIn_preMsgHook (FwIndexType portNum, U32 key)
	Pre-message hook for async input port pingIn. More...

virtual void	setPrm_preMsgHook (FwIndexType portNum, FwPrmIdType id, Fw::ParamBuffer &val)
	Pre-message hook for async input port setPrm. More...

void	pingOut_out (FwIndexType portNum, U32 key)
	Invoke output port pingOut. More...

void	cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
	Emit command response. More...

virtual void	PRM_SAVE_FILE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0

virtual void	PRM_LOAD_FILE_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &fileName, Svc::PrmDb_Merge merge)=0

virtual void	PRM_COMMIT_STAGED_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0

void	PRM_SAVE_FILE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

void	PRM_LOAD_FILE_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

void	PRM_COMMIT_STAGED_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. More...

virtual void	PRM_LOAD_FILE_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command PRM_LOAD_FILE. More...

virtual void	PRM_COMMIT_STAGED_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
	Pre-message hook for command PRM_COMMIT_STAGED. More...

void	log_WARNING_LO_PrmIdNotFound (FwPrmIdType Id)

void	log_ACTIVITY_HI_PrmIdUpdated (FwPrmIdType Id) const

void	log_WARNING_HI_PrmDbFull (FwPrmIdType Id) const

void	log_ACTIVITY_HI_PrmIdAdded (FwPrmIdType 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 (const Fw::StringBase &databaseString, U32 recordsTotal, U32 recordsAdded, U32 recordsUpdated) const

void	log_ACTIVITY_HI_PrmDbCommitComplete () const

void	log_ACTIVITY_HI_PrmDbCopyAllComplete (const Fw::StringBase &databaseStringSrc, const Fw::StringBase &databaseStringDest) const

void	log_WARNING_HI_PrmDbFileLoadFailed () const

void	log_WARNING_LO_PrmDbFileLoadInvalidAction (Svc::PrmDb_PrmDbFileLoadState currentState, Svc::PrmDb_PrmLoadAction attemptedAction) const

void	log_WARNING_LO_PrmIdNotFound_ThrottleClear ()
	Reset throttle value for PrmIdNotFound. More...

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::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor. More...

virtual	~ActiveComponentBase ()
	Destructor. More...

void	init (FwEnumStoreType instance)
	initialization code More...

virtual void	preamble ()
	A function that will be called before the event loop is entered. More...

MsgDispatchStatus	dispatch ()
	The function that will dispatching messages. More...

virtual void	finalizer ()
	A function that will be called after exiting the loop. More...

Protected Member Functions inherited from Fw::QueuedComponentBase
	QueuedComponentBase (const char *name)
	Constructor. More...

virtual	~QueuedComponentBase ()
	Destructor. More...

void	init (FwEnumStoreType instance)
	initialization function More...

Os::Queue::Status	createQueue (FwSizeType depth, FwSizeType msgSize)

FwSizeType	getNumMsgsDropped ()
	return number of messages dropped More...

void	incNumMsgDropped ()
	increment the number of messages dropped 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_getPrm_InputPorts ()

static constexpr FwIndexType	getNum_pingIn_InputPorts ()

static constexpr FwIndexType	getNum_setPrm_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_pingOut_OutputPorts ()

Friends
class	PrmDbTesterBase
	Friend class tester to support autocoded test harness. More...

class	PrmDbTester
	Friend class tester implementation to support white-box testing. More...

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 More...

Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component More...

Detailed Description

Auto-generated base for PrmDb component.

A component for storing parameters

Definition at line 43 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 63 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 68 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 75 of file PrmDbComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 84 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.
OPCODE_PRM_LOAD_FILE	Loads a file from storage into the staging database. The file could have selective IDs and not the whole set.
OPCODE_PRM_COMMIT_STAGED	Commits the backup database to become the prime (active) database.

Definition at line 89 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.
EVENTID_PRMDBCOMMITCOMPLETE	Committed staged parameter updates.
EVENTID_PRMDBCOPYALLCOMPLETE	All parameters Copied from one DB to another.
EVENTID_PRMDBFILELOADFAILED	Parameter file load failed, not staging any update.
EVENTID_PRMDBFILELOADINVALIDACTION	Invalid Action during parameter file load.

Definition at line 96 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 112 of file PrmDbComponentAc.hpp.

Constructor & Destructor Documentation

◆ PrmDbComponentBase()

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

protected

Construct PrmDbComponentBase object.

Parameters

compName The component name

Definition at line 585 of file PrmDbComponentAc.cpp.

◆ ~PrmDbComponentBase()

Svc::PrmDbComponentBase::~PrmDbComponentBase ( )

protectedvirtual

Destroy PrmDbComponentBase object.

Definition at line 592 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

opCode	The opcode
cmdSeq	The command sequence number
response	The command response

Definition at line 883 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

portNum The port number

Definition at line 311 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

portNum The port number

Definition at line 326 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

portNum The port number

Definition at line 337 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

portNum The port number

Definition at line 348 of file PrmDbComponentAc.cpp.

◆ getNum_CmdDisp_InputPorts()

static constexpr FwIndexType Svc::PrmDbComponentBase::getNum_CmdDisp_InputPorts ( )

inlinestaticprotected

Get the number of CmdDisp input ports

Returns: The number of CmdDisp input ports

Definition at line 314 of file PrmDbComponentAc.hpp.

◆ getNum_CmdReg_OutputPorts()

static constexpr FwIndexType Svc::PrmDbComponentBase::getNum_CmdReg_OutputPorts ( )

inlinestaticprotected

Get the number of CmdReg output ports

Returns: The number of CmdReg output ports

Definition at line 354 of file PrmDbComponentAc.hpp.

◆ getNum_CmdStatus_OutputPorts()

static constexpr FwIndexType Svc::PrmDbComponentBase::getNum_CmdStatus_OutputPorts ( )

inlinestaticprotected

Get the number of CmdStatus output ports

Returns: The number of CmdStatus output ports

Definition at line 361 of file PrmDbComponentAc.hpp.

◆ getNum_getPrm_InputPorts()

static constexpr FwIndexType Svc::PrmDbComponentBase::getNum_getPrm_InputPorts ( )

inlinestaticprotected

Get the number of getPrm input ports

Returns: The number of getPrm input ports

Definition at line 327 of file PrmDbComponentAc.hpp.

◆ getNum_Log_OutputPorts()

static constexpr FwIndexType Svc::PrmDbComponentBase::getNum_Log_OutputPorts ( )

inlinestaticprotected

Get the number of Log output ports

Returns: The number of Log output ports

Definition at line 368 of file PrmDbComponentAc.hpp.

◆ getNum_pingIn_InputPorts()

static constexpr FwIndexType Svc::PrmDbComponentBase::getNum_pingIn_InputPorts ( )

inlinestaticprotected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 334 of file PrmDbComponentAc.hpp.

◆ getNum_pingOut_OutputPorts()

static constexpr FwIndexType Svc::PrmDbComponentBase::getNum_pingOut_OutputPorts ( )

inlinestaticprotected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 399 of file PrmDbComponentAc.hpp.

◆ getNum_setPrm_InputPorts()

static constexpr FwIndexType Svc::PrmDbComponentBase::getNum_setPrm_InputPorts ( )

inlinestaticprotected

Get the number of setPrm input ports

Returns: The number of setPrm input ports

Definition at line 341 of file PrmDbComponentAc.hpp.

◆ getNum_Time_OutputPorts()

static constexpr FwIndexType Svc::PrmDbComponentBase::getNum_Time_OutputPorts ( )

inlinestaticprotected

Get the number of Time output ports

Returns: The number of Time output ports

Definition at line 386 of file PrmDbComponentAc.hpp.

◆ getPrm_handler()

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

protectedpure virtual

Handler for input port getPrm.

Parameters

portNum	The port number
id	Parameter ID
val	Buffer containing serialized parameter value. Unmodified if param not found.

◆ 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

portNum	The port number
id	Parameter ID
val	Buffer containing serialized parameter value. Unmodified if param not found.

Definition at line 682 of file PrmDbComponentAc.cpp.

◆ getTime()

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

protected

Get the time

\return The current time

Definition at line 2248 of file PrmDbComponentAc.cpp.

◆ init()

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

Initialize PrmDbComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 75 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

portNum The port number

Definition at line 602 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

portNum The port number

Definition at line 613 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

portNum The port number

Definition at line 624 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

portNum The port number

Definition at line 665 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

portNum The port number

Definition at line 650 of file PrmDbComponentAc.cpp.

◆ lock()

void Svc::PrmDbComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 2268 of file PrmDbComponentAc.cpp.

◆ log_ACTIVITY_HI_PrmDbCommitComplete()

void Svc::PrmDbComponentBase::log_ACTIVITY_HI_PrmDbCommitComplete ( ) const

protected

Log event PrmDbCommitComplete

Committed staged parameter updates

Definition at line 1914 of file PrmDbComponentAc.cpp.

◆ log_ACTIVITY_HI_PrmDbCopyAllComplete()

void Svc::PrmDbComponentBase::log_ACTIVITY_HI_PrmDbCopyAllComplete	(	const Fw::StringBase &	databaseStringSrc,
		const Fw::StringBase &	databaseStringDest
	)		const

protected

Log event PrmDbCopyAllComplete

All parameters Copied from one DB to another

Parameters

databaseStringSrc	The src database string
databaseStringDest	The dest database string

Definition at line 1979 of file PrmDbComponentAc.cpp.

◆ log_ACTIVITY_HI_PrmFileLoadComplete()

void Svc::PrmDbComponentBase::log_ACTIVITY_HI_PrmFileLoadComplete	(	const Fw::StringBase &	databaseString,
		U32	recordsTotal,
		U32	recordsAdded,
		U32	recordsUpdated
	)		const

protected

Log event PrmFileLoadComplete

Load of parameter file completed

Parameters

databaseString	The database string
recordsTotal	The number of records total
recordsAdded	The number of new records added
recordsUpdated	The number of records updated

Definition at line 1786 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

records The number of records saved

Definition at line 1581 of file PrmDbComponentAc.cpp.

◆ log_ACTIVITY_HI_PrmIdAdded()

void Svc::PrmDbComponentBase::log_ACTIVITY_HI_PrmIdAdded ( FwPrmIdType Id ) const

protected

Log event PrmIdAdded

Parameter ID added to database

Parameters

Id	The parameter ID

Definition at line 1376 of file PrmDbComponentAc.cpp.

◆ log_ACTIVITY_HI_PrmIdUpdated()

void Svc::PrmDbComponentBase::log_ACTIVITY_HI_PrmIdUpdated ( FwPrmIdType Id ) const

protected

Log event PrmIdUpdated

Parameter ID updated in database

Parameters

Id	The parameter ID

Definition at line 1212 of file PrmDbComponentAc.cpp.

◆ log_WARNING_HI_PrmDbFileLoadFailed()

void Svc::PrmDbComponentBase::log_WARNING_HI_PrmDbFileLoadFailed ( ) const

protected

Log event PrmDbFileLoadFailed

Parameter file load failed, not staging any update

Definition at line 2061 of file PrmDbComponentAc.cpp.

◆ log_WARNING_HI_PrmDbFull()

void Svc::PrmDbComponentBase::log_WARNING_HI_PrmDbFull ( FwPrmIdType Id ) const

protected

Log event PrmDbFull

Parameter database is full

Parameters

Id	The parameter ID

Definition at line 1294 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

stage	The read stage
record	The record that had the failure
error	The error code

Definition at line 1663 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

stage	The write stage
record	The record that had the failure
error	The error code

Definition at line 1458 of file PrmDbComponentAc.cpp.

◆ log_WARNING_LO_PrmDbFileLoadInvalidAction()

void Svc::PrmDbComponentBase::log_WARNING_LO_PrmDbFileLoadInvalidAction	(	Svc::PrmDb_PrmDbFileLoadState	currentState,
		Svc::PrmDb_PrmLoadAction	attemptedAction
	)		const

protected

Log event PrmDbFileLoadInvalidAction

Invalid Action during parameter file load

Parameters

currentState	The current state
attemptedAction	The invalid action attempted

Definition at line 2126 of file PrmDbComponentAc.cpp.

◆ log_WARNING_LO_PrmIdNotFound()

void Svc::PrmDbComponentBase::log_WARNING_LO_PrmIdNotFound ( FwPrmIdType Id )

protected

Log event PrmIdNotFound

Parameter ID not found in database.

Parameters

Id	The parameter ID

Definition at line 1122 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 2237 of file PrmDbComponentAc.cpp.

◆ pingIn_handler()

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

protectedpure virtual

Handler for input port pingIn.

Parameters

portNum	The port number
key	Value 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

portNum	The port number
key	Value to return to pinger

Definition at line 713 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

portNum	The port number
key	Value to return to pinger

Definition at line 836 of file PrmDbComponentAc.cpp.

◆ pingOut_out()

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

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 859 of file PrmDbComponentAc.cpp.

◆ PRM_COMMIT_STAGED_cmdHandler()

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

protectedpure virtual

Handler for command PRM_COMMIT_STAGED

Commits the backup database to become the prime (active) database

Parameters

opCode	The opcode
cmdSeq	The command sequence number

◆ PRM_COMMIT_STAGED_cmdHandlerBase()

void Svc::PrmDbComponentBase::PRM_COMMIT_STAGED_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command PRM_COMMIT_STAGED

Commits the backup database to become the prime (active) database

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 1018 of file PrmDbComponentAc.cpp.

◆ PRM_COMMIT_STAGED_preMsgHook()

void Svc::PrmDbComponentBase::PRM_COMMIT_STAGED_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command PRM_COMMIT_STAGED.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1107 of file PrmDbComponentAc.cpp.

◆ PRM_LOAD_FILE_cmdHandler()

virtual void Svc::PrmDbComponentBase::PRM_LOAD_FILE_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		const Fw::CmdStringArg &	fileName,
		Svc::PrmDb_Merge	merge
	)

protectedpure virtual

Handler for command PRM_LOAD_FILE

Loads a file from storage into the staging database. The file could have selective IDs and not the whole set.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
fileName	The name of the on-board file to set parameters from
merge	Whether to merge or fully reset the parameter database from the file contents

◆ PRM_LOAD_FILE_cmdHandlerBase()

void Svc::PrmDbComponentBase::PRM_LOAD_FILE_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command PRM_LOAD_FILE

Loads a file from storage into the staging database. The file could have selective IDs and not the whole set.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 959 of file PrmDbComponentAc.cpp.

◆ PRM_LOAD_FILE_preMsgHook()

void Svc::PrmDbComponentBase::PRM_LOAD_FILE_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command PRM_LOAD_FILE.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1096 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

opCode	The opcode
cmdSeq	The 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

opCode	The opcode
cmdSeq	The command sequence number
args	The command argument buffer

Definition at line 900 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

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1085 of file PrmDbComponentAc.cpp.

◆ regCommands()

void Svc::PrmDbComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 563 of file PrmDbComponentAc.cpp.

◆ set_CmdReg_OutputPort()

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

Connect port to CmdReg[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 363 of file PrmDbComponentAc.cpp.

◆ set_CmdStatus_OutputPort()

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

Connect port to CmdStatus[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 377 of file PrmDbComponentAc.cpp.

◆ set_Log_OutputPort()

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

Connect port to Log[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 391 of file PrmDbComponentAc.cpp.

◆ set_pingOut_OutputPort()

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

Connect port to pingOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 441 of file PrmDbComponentAc.cpp.

◆ set_Time_OutputPort()

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

Connect port to Time[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 423 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

portNum	The port number
id	Parameter ID
val	Buffer 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

portNum	The port number
id	Parameter ID
val	Buffer containing serialized parameter value

Definition at line 766 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

portNum	The port number
id	Parameter ID
val	Buffer containing serialized parameter value

Definition at line 845 of file PrmDbComponentAc.cpp.

◆ unLock()

void Svc::PrmDbComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 2274 of file PrmDbComponentAc.cpp.

Friends And Related Function Documentation

◆ PrmDbTester

friend class PrmDbTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 54 of file PrmDbComponentAc.hpp.

◆ PrmDbTesterBase

friend class PrmDbTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 52 of file PrmDbComponentAc.hpp.

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

Svc/PrmDb/PrmDbComponentAc.hpp
Svc/PrmDb/PrmDbComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ PrmDbComponentBase()

◆ ~PrmDbComponentBase()

Member Function Documentation

◆ cmdResponse_out()

◆ get_CmdDisp_InputPort()

◆ get_getPrm_InputPort()

◆ get_pingIn_InputPort()

◆ get_setPrm_InputPort()

◆ getNum_CmdDisp_InputPorts()

◆ getNum_CmdReg_OutputPorts()

◆ getNum_CmdStatus_OutputPorts()

◆ getNum_getPrm_InputPorts()

◆ getNum_Log_OutputPorts()

◆ getNum_pingIn_InputPorts()

◆ getNum_pingOut_OutputPorts()

◆ getNum_setPrm_InputPorts()

◆ getNum_Time_OutputPorts()

◆ getPrm_handler()

◆ getPrm_handlerBase()

◆ getTime()

◆ init()

◆ isConnected_CmdReg_OutputPort()

◆ isConnected_CmdStatus_OutputPort()

◆ isConnected_Log_OutputPort()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_Time_OutputPort()

◆ lock()

◆ log_ACTIVITY_HI_PrmDbCommitComplete()

◆ log_ACTIVITY_HI_PrmDbCopyAllComplete()

◆ log_ACTIVITY_HI_PrmFileLoadComplete()

◆ log_ACTIVITY_HI_PrmFileSaveComplete()

◆ log_ACTIVITY_HI_PrmIdAdded()

◆ log_ACTIVITY_HI_PrmIdUpdated()

◆ log_WARNING_HI_PrmDbFileLoadFailed()

◆ log_WARNING_HI_PrmDbFull()

◆ log_WARNING_HI_PrmFileReadError()

◆ log_WARNING_HI_PrmFileWriteError()

◆ log_WARNING_LO_PrmDbFileLoadInvalidAction()

◆ log_WARNING_LO_PrmIdNotFound()

◆ log_WARNING_LO_PrmIdNotFound_ThrottleClear()

◆ pingIn_handler()

◆ pingIn_handlerBase()

◆ pingIn_preMsgHook()

◆ pingOut_out()

◆ PRM_COMMIT_STAGED_cmdHandler()

◆ PRM_COMMIT_STAGED_cmdHandlerBase()

◆ PRM_COMMIT_STAGED_preMsgHook()

◆ PRM_LOAD_FILE_cmdHandler()

◆ PRM_LOAD_FILE_cmdHandlerBase()

◆ PRM_LOAD_FILE_preMsgHook()

◆ PRM_SAVE_FILE_cmdHandler()

◆ PRM_SAVE_FILE_cmdHandlerBase()

◆ PRM_SAVE_FILE_preMsgHook()

◆ regCommands()

◆ set_CmdReg_OutputPort()

◆ set_CmdStatus_OutputPort()

◆ set_Log_OutputPort()

◆ set_pingOut_OutputPort()

◆ set_Time_OutputPort()

◆ setPrm_handler()

◆ setPrm_handlerBase()

◆ setPrm_preMsgHook()

◆ unLock()

Friends And Related Function Documentation