Svc::PrmDbComponentBase Class Reference

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

#include <Svc/PrmDb/PrmDbComponentAc.hpp>

Inheritance diagram for Svc::PrmDbComponentBase:

Public Member Functions
void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)
	Initialize PrmDbComponentBase object. More...
Fw::InputCmdPort *	get_CmdDisp_InputPort (NATIVE_INT_TYPE portNum)
Fw::InputPrmGetPort *	get_getPrm_InputPort (NATIVE_INT_TYPE portNum)
Svc::InputPingPort *	get_pingIn_InputPort (NATIVE_INT_TYPE portNum)
Fw::InputPrmSetPort *	get_setPrm_InputPort (NATIVE_INT_TYPE portNum)
void	set_CmdReg_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdRegPort *port)
	Connect port to CmdReg[portNum]. More...
void	set_CmdStatus_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputCmdResponsePort *port)
	Connect port to CmdStatus[portNum]. More...
void	set_Log_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
	Connect port to Log[portNum]. More...
void	set_Time_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
	Connect port to Time[portNum]. More...
void	set_pingOut_OutputPort (NATIVE_INT_TYPE 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 (NATIVE_UINT_TYPE priority=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE stackSize=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE cpuAffinity=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE identifier=Os::Task::TASK_DEFAULT)
	called by instantiator when task is to be started More...
	DEPRECATED (void start(NATIVE_INT_TYPE identifier, NATIVE_INT_TYPE priority, NATIVE_INT_TYPE stackSize, NATIVE_INT_TYPE cpuAffinity=-1), "Please switch to start(NATIVE_UINT_TYPE priority, NATIVE_UINT_TYPE stackSize, NATIVE_UINT_TYPE cpuAffinity, NATIVE_UINT_TYPE identifier)")
	called by instantiator when task is to be started More...
void	exit ()
	exit task in active component More...
Os::Task::TaskStatus	join (void **value_ptr)
	provide return value of thread if value_ptr is not NULL 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_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 Member Functions
	PrmDbComponentBase (const char *compName="")
	Construct PrmDbComponentBase object. More...
virtual	~PrmDbComponentBase ()
	Destroy PrmDbComponentBase object. More...
NATIVE_INT_TYPE	getNum_CmdDisp_InputPorts () const
NATIVE_INT_TYPE	getNum_getPrm_InputPorts () const
NATIVE_INT_TYPE	getNum_pingIn_InputPorts () const
NATIVE_INT_TYPE	getNum_setPrm_InputPorts () const
NATIVE_INT_TYPE	getNum_CmdReg_OutputPorts () const
NATIVE_INT_TYPE	getNum_CmdStatus_OutputPorts () const
NATIVE_INT_TYPE	getNum_Log_OutputPorts () const
NATIVE_INT_TYPE	getNum_Time_OutputPorts () const
NATIVE_INT_TYPE	getNum_pingOut_OutputPorts () const
bool	isConnected_CmdReg_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_CmdStatus_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_Log_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_Time_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)
virtual Fw::ParamValid	getPrm_handler (NATIVE_INT_TYPE portNum, FwPrmIdType id, Fw::ParamBuffer &val)=0
	Handler for input port getPrm. More...
virtual void	pingIn_handler (NATIVE_INT_TYPE portNum, U32 key)=0
	Handler for input port pingIn. More...
virtual void	setPrm_handler (NATIVE_INT_TYPE portNum, FwPrmIdType id, Fw::ParamBuffer &val)=0
	Handler for input port setPrm. More...
Fw::ParamValid	getPrm_handlerBase (NATIVE_INT_TYPE portNum, FwPrmIdType id, Fw::ParamBuffer &val)
	Handler base-class function for input port getPrm. More...
void	pingIn_handlerBase (NATIVE_INT_TYPE portNum, U32 key)
	Handler base-class function for input port pingIn. More...
void	setPrm_handlerBase (NATIVE_INT_TYPE portNum, FwPrmIdType id, Fw::ParamBuffer &val)
	Handler base-class function for input port setPrm. More...
virtual void	pingIn_preMsgHook (NATIVE_INT_TYPE portNum, U32 key)
	Pre-message hook for async input port pingIn. More...
virtual void	setPrm_preMsgHook (NATIVE_INT_TYPE portNum, FwPrmIdType id, Fw::ParamBuffer &val)
	Pre-message hook for async input port setPrm. More...
void	pingOut_out (NATIVE_INT_TYPE 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
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. More...
void	log_WARNING_LO_PrmIdNotFound (U32 Id)
void	log_ACTIVITY_HI_PrmIdUpdated (U32 Id)
void	log_FATAL_PrmDbFull (U32 Id)
void	log_ACTIVITY_HI_PrmIdAdded (U32 Id)
void	log_WARNING_HI_PrmFileWriteError (Svc::PrmDb_PrmWriteError stage, I32 record, I32 error)
void	log_ACTIVITY_HI_PrmFileSaveComplete (U32 records)
void	log_WARNING_HI_PrmFileReadError (Svc::PrmDb_PrmReadError stage, I32 record, I32 error)
void	log_ACTIVITY_HI_PrmFileLoadComplete (U32 records)
void	log_WARNING_LO_PrmIdNotFound_ThrottleClear ()
	Reset throttle value for PrmIdNotFound. More...
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::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor. More...
virtual	~ActiveComponentBase ()
	Destructor. More...
void	init (NATIVE_INT_TYPE instance)
	initialization code More...
virtual void	preamble ()
	A function that will be called before the event loop is entered. More...
virtual void	loop ()
	The function that will loop 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 (NATIVE_INT_TYPE instance)
	initialization function More...
Os::Queue::QueueStatus	createQueue (NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)
NATIVE_INT_TYPE	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 (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	PrmDbComponentBaseFriend
	Friend class for 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 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

compName

The component name

Definition at line 653 of file PrmDbComponentAc.cpp.

~PrmDbComponentBase()

Svc::PrmDbComponentBase::~PrmDbComponentBase ( )

protectedvirtual

Destroy PrmDbComponentBase object.

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

get_CmdDisp_InputPort()

Fw::InputCmdPort * Svc::PrmDbComponentBase::get_CmdDisp_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get special input port at index

Returns

CmdDisp[portNum]

Parameters

portNum

The port number

Definition at line 387 of file PrmDbComponentAc.cpp.

get_getPrm_InputPort()

Fw::InputPrmGetPort * Svc::PrmDbComponentBase::get_getPrm_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

getPrm[portNum]

Parameters

portNum

The port number

Definition at line 402 of file PrmDbComponentAc.cpp.

get_pingIn_InputPort()

Svc::InputPingPort * Svc::PrmDbComponentBase::get_pingIn_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

pingIn[portNum]

Parameters

portNum

The port number

Definition at line 413 of file PrmDbComponentAc.cpp.

get_setPrm_InputPort()

Fw::InputPrmSetPort * Svc::PrmDbComponentBase::get_setPrm_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

setPrm[portNum]

Parameters

portNum

The port number

Definition at line 424 of file PrmDbComponentAc.cpp.

getNum_CmdDisp_InputPorts()

NATIVE_INT_TYPE Svc::PrmDbComponentBase::getNum_CmdDisp_InputPorts ( ) const

protected

Get the number of CmdDisp input ports

Returns

The number of CmdDisp input ports

Definition at line 670 of file PrmDbComponentAc.cpp.

getNum_CmdReg_OutputPorts()

NATIVE_INT_TYPE Svc::PrmDbComponentBase::getNum_CmdReg_OutputPorts ( ) const

protected

Get the number of CmdReg output ports

Returns

The number of CmdReg output ports

Definition at line 702 of file PrmDbComponentAc.cpp.

getNum_CmdStatus_OutputPorts()

NATIVE_INT_TYPE Svc::PrmDbComponentBase::getNum_CmdStatus_OutputPorts ( ) const

protected

Get the number of CmdStatus output ports

Returns

The number of CmdStatus output ports

Definition at line 708 of file PrmDbComponentAc.cpp.

getNum_getPrm_InputPorts()

NATIVE_INT_TYPE Svc::PrmDbComponentBase::getNum_getPrm_InputPorts ( ) const

protected

Get the number of getPrm input ports

Returns

The number of getPrm input ports

Definition at line 680 of file PrmDbComponentAc.cpp.

getNum_Log_OutputPorts()

NATIVE_INT_TYPE Svc::PrmDbComponentBase::getNum_Log_OutputPorts ( ) const

protected

Get the number of Log output ports

Returns

The number of Log output ports

Definition at line 714 of file PrmDbComponentAc.cpp.

getNum_pingIn_InputPorts()

NATIVE_INT_TYPE Svc::PrmDbComponentBase::getNum_pingIn_InputPorts ( ) const

protected

Get the number of pingIn input ports

Returns

The number of pingIn input ports

Definition at line 686 of file PrmDbComponentAc.cpp.

getNum_pingOut_OutputPorts()

NATIVE_INT_TYPE Svc::PrmDbComponentBase::getNum_pingOut_OutputPorts ( ) const

protected

Get the number of pingOut output ports

Returns

The number of pingOut output ports

Definition at line 740 of file PrmDbComponentAc.cpp.

getNum_setPrm_InputPorts()

NATIVE_INT_TYPE Svc::PrmDbComponentBase::getNum_setPrm_InputPorts ( ) const

protected

Get the number of setPrm input ports

Returns

The number of setPrm input ports

Definition at line 692 of file PrmDbComponentAc.cpp.

getNum_Time_OutputPorts()

NATIVE_INT_TYPE Svc::PrmDbComponentBase::getNum_Time_OutputPorts ( ) const

protected

Get the number of Time output ports

Returns

The number of Time output ports

Definition at line 730 of file PrmDbComponentAc.cpp.

getPrm_handler()

virtual Fw::ParamValid Svc::PrmDbComponentBase::getPrm_handler ( NATIVE_INT_TYPE  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

getPrm_handlerBase()

Fw::ParamValid Svc::PrmDbComponentBase::getPrm_handlerBase ( NATIVE_INT_TYPE  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

Definition at line 830 of file PrmDbComponentAc.cpp.

getTime()

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

protected

Get the time

\return The current time

Definition at line 1947 of file PrmDbComponentAc.cpp.

init()

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

Initialize PrmDbComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 72 of file PrmDbComponentAc.cpp.

isConnected_CmdReg_OutputPort()

bool Svc::PrmDbComponentBase::isConnected_CmdReg_OutputPort ( NATIVE_INT_TYPE  portNum )

protected

Check whether port CmdReg is connected

Returns

Whether port CmdReg is connected

Parameters

portNum

The port number

Definition at line 750 of file PrmDbComponentAc.cpp.

isConnected_CmdStatus_OutputPort()

bool Svc::PrmDbComponentBase::isConnected_CmdStatus_OutputPort ( NATIVE_INT_TYPE  portNum )

protected

Check whether port CmdStatus is connected

Returns

Whether port CmdStatus is connected

Parameters

portNum

The port number

Definition at line 761 of file PrmDbComponentAc.cpp.

isConnected_Log_OutputPort()

bool Svc::PrmDbComponentBase::isConnected_Log_OutputPort ( NATIVE_INT_TYPE  portNum )

protected

Check whether port Log is connected

Returns

Whether port Log is connected

Parameters

portNum

The port number

Definition at line 772 of file PrmDbComponentAc.cpp.

isConnected_pingOut_OutputPort()

bool Svc::PrmDbComponentBase::isConnected_pingOut_OutputPort ( NATIVE_INT_TYPE  portNum )

protected

Check whether port pingOut is connected

Returns

Whether port pingOut is connected

Parameters

portNum

The port number

Definition at line 813 of file PrmDbComponentAc.cpp.

isConnected_Time_OutputPort()

bool Svc::PrmDbComponentBase::isConnected_Time_OutputPort ( NATIVE_INT_TYPE  portNum )

protected

Check whether port Time is connected

Returns

Whether port Time is connected

Parameters

portNum

The port number

Definition at line 798 of file PrmDbComponentAc.cpp.

lock()

void Svc::PrmDbComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 1967 of file PrmDbComponentAc.cpp.

log_ACTIVITY_HI_PrmFileLoadComplete()

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

protected

Log event PrmFileLoadComplete

Load of parameter file completed

Parameters

records

The number of records loaded

Definition at line 1844 of file PrmDbComponentAc.cpp.

log_ACTIVITY_HI_PrmFileSaveComplete()

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

protected

Log event PrmFileSaveComplete

Save of parameter file completed

Parameters

records

The number of records saved

Definition at line 1627 of file PrmDbComponentAc.cpp.

log_ACTIVITY_HI_PrmIdAdded()

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

protected

Log event PrmIdAdded

Parameter ID added to database

Parameters

Id	The parameter ID

Definition at line 1410 of file PrmDbComponentAc.cpp.

log_ACTIVITY_HI_PrmIdUpdated()

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

protected

Log event PrmIdUpdated

Parameter ID updated in database

Parameters

Id	The parameter ID

Definition at line 1221 of file PrmDbComponentAc.cpp.

log_FATAL_PrmDbFull()

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

protected

Log event PrmDbFull

Parameter database is full

Parameters

Id	The parameter ID

Definition at line 1309 of file PrmDbComponentAc.cpp.

log_WARNING_HI_PrmFileReadError()

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

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 1715 of file PrmDbComponentAc.cpp.

log_WARNING_HI_PrmFileWriteError()

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

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 1498 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

Id	The parameter ID

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

pingIn_handler()

virtual void Svc::PrmDbComponentBase::pingIn_handler ( NATIVE_INT_TYPE  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 ( NATIVE_INT_TYPE  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 861 of file PrmDbComponentAc.cpp.

pingIn_preMsgHook()

void Svc::PrmDbComponentBase::pingIn_preMsgHook ( NATIVE_INT_TYPE  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 984 of file PrmDbComponentAc.cpp.

pingOut_out()

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

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 1007 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 1043 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 1110 of file PrmDbComponentAc.cpp.

regCommands()

void Svc::PrmDbComponentBase::regCommands

(

)

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 639 of file PrmDbComponentAc.cpp.

set_CmdReg_OutputPort()

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

Connect port to CmdReg[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 439 of file PrmDbComponentAc.cpp.

set_CmdStatus_OutputPort()

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

Connect port to CmdStatus[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 453 of file PrmDbComponentAc.cpp.

set_Log_OutputPort()

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

Connect port to Log[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 467 of file PrmDbComponentAc.cpp.

set_pingOut_OutputPort()

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

Connect port to pingOut[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 517 of file PrmDbComponentAc.cpp.

set_Time_OutputPort()

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

Connect port to Time[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 499 of file PrmDbComponentAc.cpp.

setPrm_handler()

virtual void Svc::PrmDbComponentBase::setPrm_handler ( NATIVE_INT_TYPE  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 ( NATIVE_INT_TYPE  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 914 of file PrmDbComponentAc.cpp.

setPrm_preMsgHook()

void Svc::PrmDbComponentBase::setPrm_preMsgHook ( NATIVE_INT_TYPE  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 993 of file PrmDbComponentAc.cpp.

unLock()

void Svc::PrmDbComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 1973 of file PrmDbComponentAc.cpp.

Friends And Related Function 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:

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