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

#include <Svc/EventManager/EventManagerComponentAc.hpp>

Inheritance diagram for Svc::EventManagerComponentBase:

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

Fw::InputCmdPort *	get_CmdDisp_InputPort (FwIndexType portNum)

Fw::InputLogPort *	get_LogRecv_InputPort (FwIndexType portNum)

Svc::InputPingPort *	get_pingIn_InputPort (FwIndexType portNum)

Svc::InputSchedPort *	get_run_InputPort (FwIndexType portNum)

void	set_CmdReg_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
	Connect port to CmdReg[portNum]. More...

void	set_CmdStatus_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
	Connect port to CmdStatus[portNum]. More...

void	set_Log_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
	Connect port to Log[portNum]. More...

void	set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
	Connect port to Time[portNum]. More...

void	set_Tlm_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
	Connect port to Tlm[portNum]. More...

void	set_FatalAnnounce_OutputPort (FwIndexType portNum, Svc::InputFatalEventPort *port)
	Connect port to FatalAnnounce[portNum]. More...

void	set_PktSend_OutputPort (FwIndexType portNum, Fw::InputComPort *port)
	Connect port to PktSend[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::QueuedComponentBase
void	deinit () override
	Allows de-initialization on teardown. 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_LOGRECV_INPUT_PORTS = 1, NUM_PINGIN_INPUT_PORTS = 1, NUM_RUN_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

enum	{ NUM_CMDREG_OUTPUT_PORTS = 1, NUM_CMDSTATUS_OUTPUT_PORTS = 1, NUM_LOG_OUTPUT_PORTS = 1, NUM_LOGTEXT_OUTPUT_PORTS = 1, NUM_TIME_OUTPUT_PORTS = 1, NUM_TLM_OUTPUT_PORTS = 1 }
	Enumerations for numbers of special output ports. More...

enum	{ NUM_FATALANNOUNCE_OUTPUT_PORTS = 1, NUM_PKTSEND_OUTPUT_PORTS = 1, NUM_PINGOUT_OUTPUT_PORTS = 1 }
	Enumerations for numbers of typed output ports. More...

enum	{ OPCODE_SET_EVENT_FILTER = 0x0, OPCODE_SET_ID_FILTER = 0x2, OPCODE_DUMP_FILTER_STATE = 0x3 }
	Command opcodes. More...

enum	{ EVENTID_SEVERITY_FILTER_STATE = 0x0, EVENTID_ID_FILTER_ENABLED = 0x1, EVENTID_ID_FILTER_LIST_FULL = 0x2, EVENTID_ID_FILTER_REMOVED = 0x3, EVENTID_ID_FILTER_NOT_FOUND = 0x4 }
	Event IDs. More...

enum	{ CHANNELID_EVENTSDROPPED = 0x0 }
	Channel IDs. More...

Protected Types inherited from Fw::ActiveComponentBase
enum	Lifecycle { CREATED, DISPATCHING, FINALIZING, DONE }
	Tracks the lifecycle of the component. More...

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

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

bool	isConnected_CmdReg_OutputPort (FwIndexType portNum) const

bool	isConnected_CmdStatus_OutputPort (FwIndexType portNum) const

bool	isConnected_Log_OutputPort (FwIndexType portNum) const

bool	isConnected_Time_OutputPort (FwIndexType portNum) const

bool	isConnected_Tlm_OutputPort (FwIndexType portNum) const

bool	isConnected_FatalAnnounce_OutputPort (FwIndexType portNum) const

bool	isConnected_PktSend_OutputPort (FwIndexType portNum) const

bool	isConnected_pingOut_OutputPort (FwIndexType portNum) const

void	CmdDisp_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
	Handler base-class function for input port CmdDisp. More...

virtual void	LogRecv_handler (FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::LogBuffer &args)=0
	Handler for input port LogRecv. More...

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

virtual void	run_handler (FwIndexType portNum, U32 context)=0
	Handler for input port run. More...

void	LogRecv_handlerBase (FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::LogBuffer &args)
	Handler base-class function for input port LogRecv. More...

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

void	run_handlerBase (FwIndexType portNum, U32 context)
	Handler base-class function for input port run. More...

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

virtual void	run_preMsgHook (FwIndexType portNum, U32 context)
	Pre-message hook for async input port run. More...

void	FatalAnnounce_out (FwIndexType portNum, FwEventIdType Id) const
	Invoke output port FatalAnnounce. More...

void	PktSend_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context) const
	Invoke output port PktSend. More...

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

virtual void	loqQueue_internalInterfaceHandler (FwEventIdType id, const Fw::Time &timeTag, const Fw::LogSeverity &severity, const Fw::LogBuffer &args)=0
	Internal interface handler for loqQueue. More...

void	loqQueue_internalInterfaceInvoke (FwEventIdType id, const Fw::Time &timeTag, const Fw::LogSeverity &severity, const Fw::LogBuffer &args)
	Internal interface base-class function for loqQueue. More...

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

virtual void	SET_EVENT_FILTER_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Svc::EventManager_FilterSeverity &filterLevel, const Svc::EventManager_Enabled &filterEnabled)=0

virtual void	SET_ID_FILTER_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, FwEventIdType ID, const Svc::EventManager_Enabled &idFilterEnabled)=0

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

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

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

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

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

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

void	log_ACTIVITY_LO_SEVERITY_FILTER_STATE (const Svc::EventManager_FilterSeverity &severity, bool enabled) const

void	log_ACTIVITY_HI_ID_FILTER_ENABLED (FwEventIdType ID) const

void	log_WARNING_LO_ID_FILTER_LIST_FULL (FwEventIdType ID) const

void	log_ACTIVITY_HI_ID_FILTER_REMOVED (FwEventIdType ID) const

void	log_WARNING_LO_ID_FILTER_NOT_FOUND (FwEventIdType ID) const

void	tlmWrite (FwChanIdType id, Fw::TlmBuffer &_tlmBuff, Fw::Time _tlmTime=Fw::Time()) const

void	tlmWrite_EventsDropped (FwSizeType arg, Fw::Time _tlmTime=Fw::Time())

Fw::Time	getTime () const

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)

MsgDispatchStatus	dispatchAvailableMessages ()
	dispatches all messages currently in the queue, returning status of the dispatch More...

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_LogRecv_InputPorts ()

static constexpr FwIndexType	getNum_pingIn_InputPorts ()

static constexpr FwIndexType	getNum_run_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_Tlm_OutputPorts ()

static constexpr FwIndexType	getNum_FatalAnnounce_OutputPorts ()

static constexpr FwIndexType	getNum_PktSend_OutputPorts ()

static constexpr FwIndexType	getNum_pingOut_OutputPorts ()

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

class	EventManagerTester
	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 EventManager component.

A component for logging events

Definition at line 49 of file EventManagerComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDDISP_INPUT_PORTS

Definition at line 69 of file EventManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_LOGRECV_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS
NUM_RUN_INPUT_PORTS

Definition at line 74 of file EventManagerComponentAc.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
NUM_TLM_OUTPUT_PORTS

Definition at line 81 of file EventManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_FATALANNOUNCE_OUTPUT_PORTS
NUM_PKTSEND_OUTPUT_PORTS
NUM_PINGOUT_OUTPUT_PORTS

Definition at line 91 of file EventManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Command opcodes.

Enumerator
OPCODE_SET_EVENT_FILTER	Set filter for reporting events. Events are not stored in component.
OPCODE_SET_ID_FILTER	Filter a particular ID.
OPCODE_DUMP_FILTER_STATE	Dump the filter states via events.

Definition at line 98 of file EventManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Event IDs.

Enumerator
EVENTID_SEVERITY_FILTER_STATE	Dump severity filter state.
EVENTID_ID_FILTER_ENABLED	Indicate ID is filtered.
EVENTID_ID_FILTER_LIST_FULL	Attempted to add ID to full ID filter ID.
EVENTID_ID_FILTER_REMOVED	Removed an ID from the filter.
EVENTID_ID_FILTER_NOT_FOUND	ID not in filter.

Definition at line 105 of file EventManagerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Channel IDs.

Enumerator
CHANNELID_EVENTSDROPPED	Channel ID for EventsDropped.

Definition at line 114 of file EventManagerComponentAc.hpp.

Constructor & Destructor Documentation

◆ EventManagerComponentBase()

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

protected

Construct EventManagerComponentBase object.

Parameters

compName The component name

Definition at line 776 of file EventManagerComponentAc.cpp.

◆ ~EventManagerComponentBase()

Svc::EventManagerComponentBase::~EventManagerComponentBase ( )

protectedvirtual

Destroy EventManagerComponentBase object.

Definition at line 783 of file EventManagerComponentAc.cpp.

Member Function Documentation

◆ CmdDisp_handlerBase()

void Svc::EventManagerComponentBase::CmdDisp_handlerBase	(	FwIndexType	portNum,
		FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Handler base-class function for input port CmdDisp.

Parameters

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

Definition at line 914 of file EventManagerComponentAc.cpp.

◆ cmdResponse_out()

void Svc::EventManagerComponentBase::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 1270 of file EventManagerComponentAc.cpp.

◆ DUMP_FILTER_STATE_cmdHandler()

virtual void Svc::EventManagerComponentBase::DUMP_FILTER_STATE_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedpure virtual

Handler for command DUMP_FILTER_STATE

Dump the filter states via events

Parameters

opCode	The opcode
cmdSeq	The command sequence number

◆ DUMP_FILTER_STATE_cmdHandlerBase()

void Svc::EventManagerComponentBase::DUMP_FILTER_STATE_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command DUMP_FILTER_STATE

Dump the filter states via events

Parameters

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

Definition at line 1410 of file EventManagerComponentAc.cpp.

◆ DUMP_FILTER_STATE_preMsgHook()

void Svc::EventManagerComponentBase::DUMP_FILTER_STATE_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command DUMP_FILTER_STATE.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1488 of file EventManagerComponentAc.cpp.

◆ FatalAnnounce_out()

void Svc::EventManagerComponentBase::FatalAnnounce_out	(	FwIndexType	portNum,
		FwEventIdType	Id
	)		const

protected

Invoke output port FatalAnnounce.

Parameters

portNum	The port number
Id	The ID of the FATAL event

Definition at line 1134 of file EventManagerComponentAc.cpp.

◆ get_CmdDisp_InputPort()

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

Get special input port at index

Returns: CmdDisp[portNum]

Parameters

portNum The port number

Definition at line 401 of file EventManagerComponentAc.cpp.

◆ get_LogRecv_InputPort()

Fw::InputLogPort * Svc::EventManagerComponentBase::get_LogRecv_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: LogRecv[portNum]

Parameters

portNum The port number

Definition at line 420 of file EventManagerComponentAc.cpp.

◆ get_pingIn_InputPort()

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

Get typed input port at index

Returns: pingIn[portNum]

Parameters

portNum The port number

Definition at line 431 of file EventManagerComponentAc.cpp.

◆ get_run_InputPort()

Svc::InputSchedPort * Svc::EventManagerComponentBase::get_run_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: run[portNum]

Parameters

portNum The port number

Definition at line 442 of file EventManagerComponentAc.cpp.

◆ getNum_CmdDisp_InputPorts()

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

inlinestaticprotected

Get the number of CmdDisp input ports

Returns: The number of CmdDisp input ports

Definition at line 368 of file EventManagerComponentAc.hpp.

◆ getNum_CmdReg_OutputPorts()

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

inlinestaticprotected

Get the number of CmdReg output ports

Returns: The number of CmdReg output ports

Definition at line 408 of file EventManagerComponentAc.hpp.

◆ getNum_CmdStatus_OutputPorts()

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

inlinestaticprotected

Get the number of CmdStatus output ports

Returns: The number of CmdStatus output ports

Definition at line 415 of file EventManagerComponentAc.hpp.

◆ getNum_FatalAnnounce_OutputPorts()

static constexpr FwIndexType Svc::EventManagerComponentBase::getNum_FatalAnnounce_OutputPorts ( )

inlinestaticprotected

Get the number of FatalAnnounce output ports

Returns: The number of FatalAnnounce output ports

Definition at line 460 of file EventManagerComponentAc.hpp.

◆ getNum_Log_OutputPorts()

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

inlinestaticprotected

Get the number of Log output ports

Returns: The number of Log output ports

Definition at line 422 of file EventManagerComponentAc.hpp.

◆ getNum_LogRecv_InputPorts()

static constexpr FwIndexType Svc::EventManagerComponentBase::getNum_LogRecv_InputPorts ( )

inlinestaticprotected

Get the number of LogRecv input ports

Returns: The number of LogRecv input ports

Definition at line 381 of file EventManagerComponentAc.hpp.

◆ getNum_pingIn_InputPorts()

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

inlinestaticprotected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 388 of file EventManagerComponentAc.hpp.

◆ getNum_pingOut_OutputPorts()

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

inlinestaticprotected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 474 of file EventManagerComponentAc.hpp.

◆ getNum_PktSend_OutputPorts()

static constexpr FwIndexType Svc::EventManagerComponentBase::getNum_PktSend_OutputPorts ( )

inlinestaticprotected

Get the number of PktSend output ports

Returns: The number of PktSend output ports

Definition at line 467 of file EventManagerComponentAc.hpp.

◆ getNum_run_InputPorts()

static constexpr FwIndexType Svc::EventManagerComponentBase::getNum_run_InputPorts ( )

inlinestaticprotected

Get the number of run input ports

Returns: The number of run input ports

Definition at line 395 of file EventManagerComponentAc.hpp.

◆ getNum_Time_OutputPorts()

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

inlinestaticprotected

Get the number of Time output ports

Returns: The number of Time output ports

Definition at line 440 of file EventManagerComponentAc.hpp.

◆ getNum_Tlm_OutputPorts()

static constexpr FwIndexType Svc::EventManagerComponentBase::getNum_Tlm_OutputPorts ( )

inlinestaticprotected

Get the number of Tlm output ports

Returns: The number of Tlm output ports

Definition at line 447 of file EventManagerComponentAc.hpp.

◆ getTime()

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

protected

Get the time

\return The current time

Definition at line 2012 of file EventManagerComponentAc.cpp.

◆ init()

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

Initialize EventManagerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 82 of file EventManagerComponentAc.cpp.

◆ isConnected_CmdReg_OutputPort()

bool Svc::EventManagerComponentBase::isConnected_CmdReg_OutputPort ( FwIndexType portNum ) const

protected

Check whether port CmdReg is connected

Returns: Whether port CmdReg is connected

Parameters

portNum The port number

Definition at line 795 of file EventManagerComponentAc.cpp.

◆ isConnected_CmdStatus_OutputPort()

bool Svc::EventManagerComponentBase::isConnected_CmdStatus_OutputPort ( FwIndexType portNum ) const

protected

Check whether port CmdStatus is connected

Returns: Whether port CmdStatus is connected

Parameters

portNum The port number

Definition at line 806 of file EventManagerComponentAc.cpp.

◆ isConnected_FatalAnnounce_OutputPort()

bool Svc::EventManagerComponentBase::isConnected_FatalAnnounce_OutputPort ( FwIndexType portNum ) const

protected

Check whether port FatalAnnounce is connected

Returns: Whether port FatalAnnounce is connected

Parameters

portNum The port number

Definition at line 873 of file EventManagerComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::EventManagerComponentBase::isConnected_Log_OutputPort ( FwIndexType portNum ) const

protected

Check whether port Log is connected

Returns: Whether port Log is connected

Parameters

portNum The port number

Definition at line 817 of file EventManagerComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::EventManagerComponentBase::isConnected_pingOut_OutputPort ( FwIndexType portNum ) const

protected

Check whether port pingOut is connected

Returns: Whether port pingOut is connected

Parameters

portNum The port number

Definition at line 895 of file EventManagerComponentAc.cpp.

◆ isConnected_PktSend_OutputPort()

bool Svc::EventManagerComponentBase::isConnected_PktSend_OutputPort ( FwIndexType portNum ) const

protected

Check whether port PktSend is connected

Returns: Whether port PktSend is connected

Parameters

portNum The port number

Definition at line 884 of file EventManagerComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::EventManagerComponentBase::isConnected_Time_OutputPort ( FwIndexType portNum ) const

protected

Check whether port Time is connected

Returns: Whether port Time is connected

Parameters

portNum The port number

Definition at line 843 of file EventManagerComponentAc.cpp.

◆ isConnected_Tlm_OutputPort()

bool Svc::EventManagerComponentBase::isConnected_Tlm_OutputPort ( FwIndexType portNum ) const

protected

Check whether port Tlm is connected

Returns: Whether port Tlm is connected

Parameters

portNum The port number

Definition at line 854 of file EventManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_ID_FILTER_ENABLED()

void Svc::EventManagerComponentBase::log_ACTIVITY_HI_ID_FILTER_ENABLED ( FwEventIdType ID ) const

protected

Log event ID_FILTER_ENABLED

Indicate ID is filtered

Parameters

ID	The ID filtered

Definition at line 1608 of file EventManagerComponentAc.cpp.

◆ log_ACTIVITY_HI_ID_FILTER_REMOVED()

void Svc::EventManagerComponentBase::log_ACTIVITY_HI_ID_FILTER_REMOVED ( FwEventIdType ID ) const

protected

Log event ID_FILTER_REMOVED

Removed an ID from the filter

Parameters

ID	The ID removed

Definition at line 1772 of file EventManagerComponentAc.cpp.

◆ log_ACTIVITY_LO_SEVERITY_FILTER_STATE()

void Svc::EventManagerComponentBase::log_ACTIVITY_LO_SEVERITY_FILTER_STATE	(	const Svc::EventManager_FilterSeverity &	severity,
		bool	enabled
	)		const

protected

Log event SEVERITY_FILTER_STATE

Dump severity filter state

Parameters

severity The severity level

Definition at line 1503 of file EventManagerComponentAc.cpp.

◆ log_WARNING_LO_ID_FILTER_LIST_FULL()

void Svc::EventManagerComponentBase::log_WARNING_LO_ID_FILTER_LIST_FULL ( FwEventIdType ID ) const

protected

Log event ID_FILTER_LIST_FULL

Attempted to add ID to full ID filter ID

Parameters

ID	The ID filtered

Definition at line 1690 of file EventManagerComponentAc.cpp.

◆ log_WARNING_LO_ID_FILTER_NOT_FOUND()

void Svc::EventManagerComponentBase::log_WARNING_LO_ID_FILTER_NOT_FOUND ( FwEventIdType ID ) const

protected

Log event ID_FILTER_NOT_FOUND

ID not in filter

Parameters

ID	The ID removed

Definition at line 1854 of file EventManagerComponentAc.cpp.

◆ LogRecv_handler()

virtual void Svc::EventManagerComponentBase::LogRecv_handler	(	FwIndexType	portNum,
		FwEventIdType	id,
		Fw::Time &	timeTag,
		const Fw::LogSeverity &	severity,
		Fw::LogBuffer &	args
	)

protectedpure virtual

Handler for input port LogRecv.

Parameters

portNum	The port number
id	Log ID
timeTag	Time Tag
severity	The severity argument
args	Buffer containing serialized log entry

◆ LogRecv_handlerBase()

void Svc::EventManagerComponentBase::LogRecv_handlerBase	(	FwIndexType	portNum,
		FwEventIdType	id,
		Fw::Time &	timeTag,
		const Fw::LogSeverity &	severity,
		Fw::LogBuffer &	args
	)

protected

Handler base-class function for input port LogRecv.

Parameters

portNum	The port number
id	Log ID
timeTag	Time Tag
severity	The severity argument
args	Buffer containing serialized log entry

Definition at line 966 of file EventManagerComponentAc.cpp.

◆ loqQueue_internalInterfaceHandler()

virtual void Svc::EventManagerComponentBase::loqQueue_internalInterfaceHandler	(	FwEventIdType	id,
		const Fw::Time &	timeTag,
		const Fw::LogSeverity &	severity,
		const Fw::LogBuffer &	args
	)

protectedpure virtual

Internal interface handler for loqQueue.

Parameters

id	Log ID
timeTag	Time Tag
severity	The severity argument
args	Buffer containing serialized log entry

◆ loqQueue_internalInterfaceInvoke()

void Svc::EventManagerComponentBase::loqQueue_internalInterfaceInvoke	(	FwEventIdType	id,
		const Fw::Time &	timeTag,
		const Fw::LogSeverity &	severity,
		const Fw::LogBuffer &	args
	)

protected

Internal interface base-class function for loqQueue.

Parameters

id	Log ID
timeTag	Time Tag
severity	The severity argument
args	Buffer containing serialized log entry

Definition at line 1202 of file EventManagerComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::EventManagerComponentBase::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::EventManagerComponentBase::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 991 of file EventManagerComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::EventManagerComponentBase::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 1110 of file EventManagerComponentAc.cpp.

◆ pingOut_out()

void Svc::EventManagerComponentBase::pingOut_out	(	FwIndexType	portNum,
		U32	key
	)		const

protected

Invoke output port pingOut.

Parameters

portNum	The port number
key	Value to return to pinger

Definition at line 1176 of file EventManagerComponentAc.cpp.

◆ PktSend_out()

void Svc::EventManagerComponentBase::PktSend_out	(	FwIndexType	portNum,
		Fw::ComBuffer &	data,
		U32	context
	)		const

protected

Invoke output port PktSend.

Parameters

portNum	The port number
data	Buffer containing packet data
context	Call context value; meaning chosen by user

Definition at line 1154 of file EventManagerComponentAc.cpp.

◆ regCommands()

void Svc::EventManagerComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 751 of file EventManagerComponentAc.cpp.

◆ run_handler()

virtual void Svc::EventManagerComponentBase::run_handler	(	FwIndexType	portNum,
		U32	context
	)

protectedpure virtual

Handler for input port run.

Parameters

portNum	The port number
context	The call order

◆ run_handlerBase()

void Svc::EventManagerComponentBase::run_handlerBase	(	FwIndexType	portNum,
		U32	context
	)

protected

Handler base-class function for input port run.

Parameters

portNum	The port number
context	The call order

Definition at line 1044 of file EventManagerComponentAc.cpp.

◆ run_preMsgHook()

void Svc::EventManagerComponentBase::run_preMsgHook	(	FwIndexType	portNum,
		U32	context
	)

protectedvirtual

Pre-message hook for async input port run.

Parameters

portNum	The port number
context	The call order

Definition at line 1119 of file EventManagerComponentAc.cpp.

◆ set_CmdReg_OutputPort()

void Svc::EventManagerComponentBase::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 461 of file EventManagerComponentAc.cpp.

◆ set_CmdStatus_OutputPort()

void Svc::EventManagerComponentBase::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 475 of file EventManagerComponentAc.cpp.

◆ SET_EVENT_FILTER_cmdHandler()

virtual void Svc::EventManagerComponentBase::SET_EVENT_FILTER_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		const Svc::EventManager_FilterSeverity &	filterLevel,
		const Svc::EventManager_Enabled &	filterEnabled
	)

protectedpure virtual

Handler for command SET_EVENT_FILTER

Set filter for reporting events. Events are not stored in component.

Parameters

opCode	The opcode
cmdSeq	The command sequence number
filterLevel	Filter level
filterEnabled	Filter state

◆ SET_EVENT_FILTER_cmdHandlerBase()

void Svc::EventManagerComponentBase::SET_EVENT_FILTER_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command SET_EVENT_FILTER

Set filter for reporting events. Events are not stored in component.

Parameters

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

Definition at line 1287 of file EventManagerComponentAc.cpp.

◆ set_FatalAnnounce_OutputPort()

void Svc::EventManagerComponentBase::set_FatalAnnounce_OutputPort	(	FwIndexType	portNum,
		Svc::InputFatalEventPort *	port
	)

Connect port to FatalAnnounce[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 557 of file EventManagerComponentAc.cpp.

◆ SET_ID_FILTER_cmdHandler()

virtual void Svc::EventManagerComponentBase::SET_ID_FILTER_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		FwEventIdType	ID,
		const Svc::EventManager_Enabled &	idFilterEnabled
	)

protectedpure virtual

Handler for command SET_ID_FILTER

Filter a particular ID

Parameters

opCode	The opcode
cmdSeq	The command sequence number
idFilterEnabled	ID filter state

◆ SET_ID_FILTER_cmdHandlerBase()

void Svc::EventManagerComponentBase::SET_ID_FILTER_cmdHandlerBase	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Fw::CmdArgBuffer &	args
	)

protected

Base-class handler function for command SET_ID_FILTER

Filter a particular ID

Parameters

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

Definition at line 1351 of file EventManagerComponentAc.cpp.

◆ SET_ID_FILTER_preMsgHook()

void Svc::EventManagerComponentBase::SET_ID_FILTER_preMsgHook	(	FwOpcodeType	opCode,
		U32	cmdSeq
	)

protectedvirtual

Pre-message hook for command SET_ID_FILTER.

Parameters

opCode	The opcode
cmdSeq	The command sequence number

Definition at line 1477 of file EventManagerComponentAc.cpp.

◆ set_Log_OutputPort()

void Svc::EventManagerComponentBase::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 489 of file EventManagerComponentAc.cpp.

◆ set_pingOut_OutputPort()

void Svc::EventManagerComponentBase::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 585 of file EventManagerComponentAc.cpp.

◆ set_PktSend_OutputPort()

void Svc::EventManagerComponentBase::set_PktSend_OutputPort	(	FwIndexType	portNum,
		Fw::InputComPort *	port
	)

Connect port to PktSend[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 571 of file EventManagerComponentAc.cpp.

◆ set_Time_OutputPort()

void Svc::EventManagerComponentBase::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 521 of file EventManagerComponentAc.cpp.

◆ set_Tlm_OutputPort()

void Svc::EventManagerComponentBase::set_Tlm_OutputPort	(	FwIndexType	portNum,
		Fw::InputTlmPort *	port
	)

Connect port to Tlm[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 535 of file EventManagerComponentAc.cpp.

◆ tlmWrite()

void Svc::EventManagerComponentBase::tlmWrite	(	FwChanIdType	id,
		Fw::TlmBuffer &	_tlmBuff,
		Fw::Time	_tlmTime = `Fw::Time()`
	)		const

protected

Write telemetry channel given its local id and serialized value. Warning: This is a low level telemetry interface that does not guarentee channel type safety. It is up to the caller to make sure the serialized data matches the definition in the model. Update on change semantics are ignored, this telemetry is always written

Parameters

id	The channel id
_tlmBuff	The serialized telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1940 of file EventManagerComponentAc.cpp.

◆ tlmWrite_EventsDropped()

void Svc::EventManagerComponentBase::tlmWrite_EventsDropped	(	FwSizeType	arg,
		Fw::Time	_tlmTime = `Fw::Time()`
	)

protected

Write telemetry channel EventsDropped

Number of events dropped due to queue full

Parameters

arg	The telemetry value
_tlmTime	Timestamp. Default: unspecified, request from getTime port

Definition at line 1971 of file EventManagerComponentAc.cpp.

Friends And Related Function Documentation

◆ EventManagerTester

friend class EventManagerTester

friend

Friend class tester implementation to support white-box testing.

Definition at line 60 of file EventManagerComponentAc.hpp.

◆ EventManagerTesterBase

friend class EventManagerTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 58 of file EventManagerComponentAc.hpp.

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

Svc/EventManager/EventManagerComponentAc.hpp
Svc/EventManager/EventManagerComponentAc.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

◆ EventManagerComponentBase()

◆ ~EventManagerComponentBase()

Member Function Documentation

◆ CmdDisp_handlerBase()

◆ cmdResponse_out()

◆ DUMP_FILTER_STATE_cmdHandler()

◆ DUMP_FILTER_STATE_cmdHandlerBase()

◆ DUMP_FILTER_STATE_preMsgHook()

◆ FatalAnnounce_out()

◆ get_CmdDisp_InputPort()

◆ get_LogRecv_InputPort()

◆ get_pingIn_InputPort()

◆ get_run_InputPort()

◆ getNum_CmdDisp_InputPorts()

◆ getNum_CmdReg_OutputPorts()

◆ getNum_CmdStatus_OutputPorts()

◆ getNum_FatalAnnounce_OutputPorts()

◆ getNum_Log_OutputPorts()

◆ getNum_LogRecv_InputPorts()

◆ getNum_pingIn_InputPorts()

◆ getNum_pingOut_OutputPorts()

◆ getNum_PktSend_OutputPorts()

◆ getNum_run_InputPorts()

◆ getNum_Time_OutputPorts()

◆ getNum_Tlm_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_CmdReg_OutputPort()

◆ isConnected_CmdStatus_OutputPort()

◆ isConnected_FatalAnnounce_OutputPort()

◆ isConnected_Log_OutputPort()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_PktSend_OutputPort()

◆ isConnected_Time_OutputPort()

◆ isConnected_Tlm_OutputPort()

◆ log_ACTIVITY_HI_ID_FILTER_ENABLED()

◆ log_ACTIVITY_HI_ID_FILTER_REMOVED()

◆ log_ACTIVITY_LO_SEVERITY_FILTER_STATE()

◆ log_WARNING_LO_ID_FILTER_LIST_FULL()

◆ log_WARNING_LO_ID_FILTER_NOT_FOUND()

◆ LogRecv_handler()

◆ LogRecv_handlerBase()

◆ loqQueue_internalInterfaceHandler()

◆ loqQueue_internalInterfaceInvoke()

◆ pingIn_handler()

◆ pingIn_handlerBase()

◆ pingIn_preMsgHook()

◆ pingOut_out()

◆ PktSend_out()

◆ regCommands()

◆ run_handler()

◆ run_handlerBase()

◆ run_preMsgHook()

◆ set_CmdReg_OutputPort()

◆ set_CmdStatus_OutputPort()

◆ SET_EVENT_FILTER_cmdHandler()

◆ SET_EVENT_FILTER_cmdHandlerBase()

◆ set_FatalAnnounce_OutputPort()

◆ SET_ID_FILTER_cmdHandler()

◆ SET_ID_FILTER_cmdHandlerBase()

◆ SET_ID_FILTER_preMsgHook()

◆ set_Log_OutputPort()

◆ set_pingOut_OutputPort()

◆ set_PktSend_OutputPort()