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

#include <Svc/PolyDb/PolyDbComponentAc.hpp>

Inheritance diagram for Svc::PolyDbComponentBase:

Public Member Functions
void	init (FwEnumStoreType instance=0)
	Initialize PolyDbComponentBase object. More...

Svc::InputPolyPort *	get_getValue_InputPort (FwIndexType portNum)

Svc::InputPolyPort *	get_setValue_InputPort (FwIndexType portNum)

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

U32	getIdBase () const

Protected Types
enum	{ NUM_GETVALUE_INPUT_PORTS = 1, NUM_SETVALUE_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

Protected Member Functions
	PolyDbComponentBase (const char *compName="")
	Construct PolyDbComponentBase object. More...

virtual	~PolyDbComponentBase ()
	Destroy PolyDbComponentBase object. More...

FwIndexType	getNum_getValue_InputPorts () const

FwIndexType	getNum_setValue_InputPorts () const

virtual void	getValue_handler (FwIndexType portNum, const Svc::PolyDbCfg::PolyDbEntry &entry, Svc::MeasurementStatus &status, Fw::Time &time, Fw::PolyType &val)=0
	Handler for input port getValue. More...

virtual void	setValue_handler (FwIndexType portNum, const Svc::PolyDbCfg::PolyDbEntry &entry, Svc::MeasurementStatus &status, Fw::Time &time, Fw::PolyType &val)=0
	Handler for input port setValue. More...

void	getValue_handlerBase (FwIndexType portNum, const Svc::PolyDbCfg::PolyDbEntry &entry, Svc::MeasurementStatus &status, Fw::Time &time, Fw::PolyType &val)
	Handler base-class function for input port getValue. More...

void	setValue_handlerBase (FwIndexType portNum, const Svc::PolyDbCfg::PolyDbEntry &entry, Svc::MeasurementStatus &status, Fw::Time &time, Fw::PolyType &val)
	Handler base-class function for input port setValue. More...

virtual void	lock ()
	Lock the guarded mutex. More...

virtual void	unLock ()
	Unlock the guarded mutex. More...

Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor. More...

virtual	~PassiveComponentBase ()
	Destructor. More...

void	init (NATIVE_INT_TYPE instance)
	Initialization function. More...

NATIVE_INT_TYPE	getInstance () const

Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor. More...

virtual	~ObjBase ()
	Destructor. More...

void	init ()
	Object initializer. More...

Friends
class	PolyDbComponentBaseFriend
	Friend class for white-box testing. More...

Detailed Description

Auto-generated base for PolyDb component.

A polymorphic database component

Definition at line 23 of file PolyDbComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_GETVALUE_INPUT_PORTS
NUM_SETVALUE_INPUT_PORTS

Definition at line 41 of file PolyDbComponentAc.hpp.

Constructor & Destructor Documentation

◆ PolyDbComponentBase()

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

protected

Construct PolyDbComponentBase object.

Parameters

compName The component name

Definition at line 106 of file PolyDbComponentAc.cpp.

◆ ~PolyDbComponentBase()

Svc::PolyDbComponentBase::~PolyDbComponentBase ( )

protectedvirtual

Destroy PolyDbComponentBase object.

Definition at line 113 of file PolyDbComponentAc.cpp.

Member Function Documentation

◆ get_getValue_InputPort()

Svc::InputPolyPort * Svc::PolyDbComponentBase::get_getValue_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: getValue[portNum]

Parameters

portNum The port number

Definition at line 80 of file PolyDbComponentAc.cpp.

◆ get_setValue_InputPort()

Svc::InputPolyPort * Svc::PolyDbComponentBase::get_setValue_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: setValue[portNum]

Parameters

portNum The port number

Definition at line 91 of file PolyDbComponentAc.cpp.

◆ getNum_getValue_InputPorts()

FwIndexType Svc::PolyDbComponentBase::getNum_getValue_InputPorts ( ) const

protected

Get the number of getValue input ports

Returns: The number of getValue input ports

Definition at line 123 of file PolyDbComponentAc.cpp.

◆ getNum_setValue_InputPorts()

FwIndexType Svc::PolyDbComponentBase::getNum_setValue_InputPorts ( ) const

protected

Get the number of setValue input ports

Returns: The number of setValue input ports

Definition at line 129 of file PolyDbComponentAc.cpp.

◆ getValue_handler()

virtual void Svc::PolyDbComponentBase::getValue_handler	(	FwIndexType	portNum,
		const Svc::PolyDbCfg::PolyDbEntry &	entry,
		Svc::MeasurementStatus &	status,
		Fw::Time &	time,
		Fw::PolyType &	val
	)

protectedpure virtual

Handler for input port getValue.

Parameters

portNum	The port number
entry	The entry to access
status	The command response argument
time	The time of the measurement
val	The value to be passed

◆ getValue_handlerBase()

void Svc::PolyDbComponentBase::getValue_handlerBase	(	FwIndexType	portNum,
		const Svc::PolyDbCfg::PolyDbEntry &	entry,
		Svc::MeasurementStatus &	status,
		Fw::Time &	time,
		Fw::PolyType &	val
	)

protected

Handler base-class function for input port getValue.

Parameters

portNum	The port number
entry	The entry to access
status	The command response argument
time	The time of the measurement
val	The value to be passed

Definition at line 141 of file PolyDbComponentAc.cpp.

◆ init()

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

Initialize PolyDbComponentBase object.

Parameters

instance The instance number

Definition at line 21 of file PolyDbComponentAc.cpp.

◆ lock()

void Svc::PolyDbComponentBase::lock ( )

protectedvirtual

Lock the guarded mutex.

Definition at line 210 of file PolyDbComponentAc.cpp.

◆ setValue_handler()

virtual void Svc::PolyDbComponentBase::setValue_handler	(	FwIndexType	portNum,
		const Svc::PolyDbCfg::PolyDbEntry &	entry,
		Svc::MeasurementStatus &	status,
		Fw::Time &	time,
		Fw::PolyType &	val
	)

protectedpure virtual

Handler for input port setValue.

Parameters

portNum	The port number
entry	The entry to access
status	The command response argument
time	The time of the measurement
val	The value to be passed

◆ setValue_handlerBase()

void Svc::PolyDbComponentBase::setValue_handlerBase	(	FwIndexType	portNum,
		const Svc::PolyDbCfg::PolyDbEntry &	entry,
		Svc::MeasurementStatus &	status,
		Fw::Time &	time,
		Fw::PolyType &	val
	)

protected

Handler base-class function for input port setValue.

Parameters

portNum	The port number
entry	The entry to access
status	The command response argument
time	The time of the measurement
val	The value to be passed

Definition at line 172 of file PolyDbComponentAc.cpp.

◆ unLock()

void Svc::PolyDbComponentBase::unLock ( )

protectedvirtual

Unlock the guarded mutex.

Definition at line 216 of file PolyDbComponentAc.cpp.

Friends And Related Function Documentation

◆ PolyDbComponentBaseFriend

friend class PolyDbComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 32 of file PolyDbComponentAc.hpp.

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

Svc/PolyDb/PolyDbComponentAc.hpp
Svc/PolyDb/PolyDbComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ PolyDbComponentBase()

◆ ~PolyDbComponentBase()

Member Function Documentation

◆ get_getValue_InputPort()

◆ get_setValue_InputPort()

◆ getNum_getValue_InputPorts()

◆ getNum_setValue_InputPorts()

◆ getValue_handler()

◆ getValue_handlerBase()

◆ init()

◆ lock()

◆ setValue_handler()

◆ setValue_handlerBase()

◆ unLock()

Friends And Related Function Documentation

◆ PolyDbComponentBaseFriend