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

#include <Svc/ActiveLogger/ActiveLoggerComponentAc.hpp>

Inheritance diagram for Svc::ActiveLoggerComponentBase:

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

Fw::InputCmdPort *	get_CmdDisp_InputPort (FwIndexType portNum)

Fw::InputLogPort *	get_LogRecv_InputPort (FwIndexType portNum)

Svc::InputPingPort *	get_pingIn_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_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 (Os::Task::ParamType priority=Os::Task::TASK_DEFAULT, Os::Task::ParamType stackSize=Os::Task::TASK_DEFAULT, Os::Task::ParamType cpuAffinity=Os::Task::TASK_DEFAULT, Os::Task::ParamType identifier=Os::Task::TASK_DEFAULT)
	called by instantiator when task is to be started 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 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_LOGRECV_INPUT_PORTS = 1, NUM_PINGIN_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_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...

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

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

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

FwIndexType	getNum_CmdDisp_InputPorts () const

FwIndexType	getNum_LogRecv_InputPorts () const

FwIndexType	getNum_pingIn_InputPorts () const

FwIndexType	getNum_CmdReg_OutputPorts () const

FwIndexType	getNum_CmdStatus_OutputPorts () const

FwIndexType	getNum_Log_OutputPorts () const

FwIndexType	getNum_Time_OutputPorts () const

FwIndexType	getNum_FatalAnnounce_OutputPorts () const

FwIndexType	getNum_PktSend_OutputPorts () const

FwIndexType	getNum_pingOut_OutputPorts () const

bool	isConnected_CmdReg_OutputPort (FwIndexType portNum)

bool	isConnected_CmdStatus_OutputPort (FwIndexType portNum)

bool	isConnected_Log_OutputPort (FwIndexType portNum)

bool	isConnected_Time_OutputPort (FwIndexType portNum)

bool	isConnected_FatalAnnounce_OutputPort (FwIndexType portNum)

bool	isConnected_PktSend_OutputPort (FwIndexType portNum)

bool	isConnected_pingOut_OutputPort (FwIndexType portNum)

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

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

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

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

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

void	pingOut_out (FwIndexType portNum, U32 key)
	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, Svc::ActiveLogger_FilterSeverity filterLevel, Svc::ActiveLogger_Enabled filterEnabled)=0

virtual void	SET_ID_FILTER_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, U32 ID, Svc::ActiveLogger_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 (Svc::ActiveLogger_FilterSeverity severity, bool enabled) const

void	log_ACTIVITY_HI_ID_FILTER_ENABLED (U32 ID) const

void	log_WARNING_LO_ID_FILTER_LIST_FULL (U32 ID) const

void	log_ACTIVITY_HI_ID_FILTER_REMOVED (U32 ID) const

void	log_WARNING_LO_ID_FILTER_NOT_FOUND (U32 ID) const

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)

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

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

class	ActiveLoggerTesterBase
	Friend class tester to support autocoded test harness. 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 ActiveLogger component.

A component for logging events

Definition at line 43 of file ActiveLoggerComponentAc.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 ActiveLoggerComponentAc.hpp.

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_LOGRECV_INPUT_PORTS
NUM_PINGIN_INPUT_PORTS

Definition at line 68 of file ActiveLoggerComponentAc.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 74 of file ActiveLoggerComponentAc.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 83 of file ActiveLoggerComponentAc.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 90 of file ActiveLoggerComponentAc.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 97 of file ActiveLoggerComponentAc.hpp.

Constructor & Destructor Documentation

◆ ActiveLoggerComponentBase()

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

protected

Construct ActiveLoggerComponentBase object.

Parameters

compName The component name

Definition at line 649 of file ActiveLoggerComponentAc.cpp.

◆ ~ActiveLoggerComponentBase()

Svc::ActiveLoggerComponentBase::~ActiveLoggerComponentBase ( )

protectedvirtual

Destroy ActiveLoggerComponentBase object.

Definition at line 656 of file ActiveLoggerComponentAc.cpp.

Member Function Documentation

◆ cmdResponse_out()

void Svc::ActiveLoggerComponentBase::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 1087 of file ActiveLoggerComponentAc.cpp.

◆ DUMP_FILTER_STATE_cmdHandler()

virtual void Svc::ActiveLoggerComponentBase::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::ActiveLoggerComponentBase::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 1224 of file ActiveLoggerComponentAc.cpp.

◆ DUMP_FILTER_STATE_preMsgHook()

void Svc::ActiveLoggerComponentBase::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 1302 of file ActiveLoggerComponentAc.cpp.

◆ FatalAnnounce_out()

void Svc::ActiveLoggerComponentBase::FatalAnnounce_out	(	FwIndexType	portNum,
		FwEventIdType	Id
	)

protected

Invoke output port FatalAnnounce.

Parameters

portNum	The port number
Id	The ID of the FATAL event

Definition at line 953 of file ActiveLoggerComponentAc.cpp.

◆ get_CmdDisp_InputPort()

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

Get special input port at index

Returns: CmdDisp[portNum]

Parameters

portNum The port number

Definition at line 330 of file ActiveLoggerComponentAc.cpp.

◆ get_LogRecv_InputPort()

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

Get typed input port at index

Returns: LogRecv[portNum]

Parameters

portNum The port number

Definition at line 345 of file ActiveLoggerComponentAc.cpp.

◆ get_pingIn_InputPort()

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

Get typed input port at index

Returns: pingIn[portNum]

Parameters

portNum The port number

Definition at line 356 of file ActiveLoggerComponentAc.cpp.

◆ getNum_CmdDisp_InputPorts()

FwIndexType Svc::ActiveLoggerComponentBase::getNum_CmdDisp_InputPorts ( ) const

protected

Get the number of CmdDisp input ports

Returns: The number of CmdDisp input ports

Definition at line 666 of file ActiveLoggerComponentAc.cpp.

◆ getNum_CmdReg_OutputPorts()

FwIndexType Svc::ActiveLoggerComponentBase::getNum_CmdReg_OutputPorts ( ) const

protected

Get the number of CmdReg output ports

Returns: The number of CmdReg output ports

Definition at line 692 of file ActiveLoggerComponentAc.cpp.

◆ getNum_CmdStatus_OutputPorts()

FwIndexType Svc::ActiveLoggerComponentBase::getNum_CmdStatus_OutputPorts ( ) const

protected

Get the number of CmdStatus output ports

Returns: The number of CmdStatus output ports

Definition at line 698 of file ActiveLoggerComponentAc.cpp.

◆ getNum_FatalAnnounce_OutputPorts()

FwIndexType Svc::ActiveLoggerComponentBase::getNum_FatalAnnounce_OutputPorts ( ) const

protected

Get the number of FatalAnnounce output ports

Returns: The number of FatalAnnounce output ports

Definition at line 730 of file ActiveLoggerComponentAc.cpp.

◆ getNum_Log_OutputPorts()

FwIndexType Svc::ActiveLoggerComponentBase::getNum_Log_OutputPorts ( ) const

protected

Get the number of Log output ports

Returns: The number of Log output ports

Definition at line 704 of file ActiveLoggerComponentAc.cpp.

◆ getNum_LogRecv_InputPorts()

FwIndexType Svc::ActiveLoggerComponentBase::getNum_LogRecv_InputPorts ( ) const

protected

Get the number of LogRecv input ports

Returns: The number of LogRecv input ports

Definition at line 676 of file ActiveLoggerComponentAc.cpp.

◆ getNum_pingIn_InputPorts()

FwIndexType Svc::ActiveLoggerComponentBase::getNum_pingIn_InputPorts ( ) const

protected

Get the number of pingIn input ports

Returns: The number of pingIn input ports

Definition at line 682 of file ActiveLoggerComponentAc.cpp.

◆ getNum_pingOut_OutputPorts()

FwIndexType Svc::ActiveLoggerComponentBase::getNum_pingOut_OutputPorts ( ) const

protected

Get the number of pingOut output ports

Returns: The number of pingOut output ports

Definition at line 742 of file ActiveLoggerComponentAc.cpp.

◆ getNum_PktSend_OutputPorts()

FwIndexType Svc::ActiveLoggerComponentBase::getNum_PktSend_OutputPorts ( ) const

protected

Get the number of PktSend output ports

Returns: The number of PktSend output ports

Definition at line 736 of file ActiveLoggerComponentAc.cpp.

◆ getNum_Time_OutputPorts()

FwIndexType Svc::ActiveLoggerComponentBase::getNum_Time_OutputPorts ( ) const

protected

Get the number of Time output ports

Returns: The number of Time output ports

Definition at line 720 of file ActiveLoggerComponentAc.cpp.

◆ getTime()

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

protected

Get the time

\return The current time

Definition at line 1754 of file ActiveLoggerComponentAc.cpp.

◆ init()

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

Initialize ActiveLoggerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 80 of file ActiveLoggerComponentAc.cpp.

◆ isConnected_CmdReg_OutputPort()

bool Svc::ActiveLoggerComponentBase::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 752 of file ActiveLoggerComponentAc.cpp.

◆ isConnected_CmdStatus_OutputPort()

bool Svc::ActiveLoggerComponentBase::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 763 of file ActiveLoggerComponentAc.cpp.

◆ isConnected_FatalAnnounce_OutputPort()

bool Svc::ActiveLoggerComponentBase::isConnected_FatalAnnounce_OutputPort ( FwIndexType portNum )

protected

Check whether port FatalAnnounce is connected

Returns: Whether port FatalAnnounce is connected

Parameters

portNum The port number

Definition at line 815 of file ActiveLoggerComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::ActiveLoggerComponentBase::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 774 of file ActiveLoggerComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::ActiveLoggerComponentBase::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 837 of file ActiveLoggerComponentAc.cpp.

◆ isConnected_PktSend_OutputPort()

bool Svc::ActiveLoggerComponentBase::isConnected_PktSend_OutputPort ( FwIndexType portNum )

protected

Check whether port PktSend is connected

Returns: Whether port PktSend is connected

Parameters

portNum The port number

Definition at line 826 of file ActiveLoggerComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::ActiveLoggerComponentBase::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 800 of file ActiveLoggerComponentAc.cpp.

◆ log_ACTIVITY_HI_ID_FILTER_ENABLED()

void Svc::ActiveLoggerComponentBase::log_ACTIVITY_HI_ID_FILTER_ENABLED ( U32 ID ) const

protected

Log event ID_FILTER_ENABLED

Indicate ID is filtered

Parameters

ID	The ID filtered

Definition at line 1422 of file ActiveLoggerComponentAc.cpp.

◆ log_ACTIVITY_HI_ID_FILTER_REMOVED()

void Svc::ActiveLoggerComponentBase::log_ACTIVITY_HI_ID_FILTER_REMOVED ( U32 ID ) const

protected

Log event ID_FILTER_REMOVED

Removed an ID from the filter

Parameters

ID	The ID removed

Definition at line 1586 of file ActiveLoggerComponentAc.cpp.

◆ log_ACTIVITY_LO_SEVERITY_FILTER_STATE()

void Svc::ActiveLoggerComponentBase::log_ACTIVITY_LO_SEVERITY_FILTER_STATE	(	Svc::ActiveLogger_FilterSeverity	severity,
		bool	enabled
	)		const

protected

Log event SEVERITY_FILTER_STATE

Dump severity filter state

Parameters

severity The severity level

Definition at line 1317 of file ActiveLoggerComponentAc.cpp.

◆ log_WARNING_LO_ID_FILTER_LIST_FULL()

void Svc::ActiveLoggerComponentBase::log_WARNING_LO_ID_FILTER_LIST_FULL ( U32 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 1504 of file ActiveLoggerComponentAc.cpp.

◆ log_WARNING_LO_ID_FILTER_NOT_FOUND()

void Svc::ActiveLoggerComponentBase::log_WARNING_LO_ID_FILTER_NOT_FOUND ( U32 ID ) const

protected

Log event ID_FILTER_NOT_FOUND

ID not in filter

Parameters

ID	The ID removed

Definition at line 1668 of file ActiveLoggerComponentAc.cpp.

◆ LogRecv_handler()

virtual void Svc::ActiveLoggerComponentBase::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::ActiveLoggerComponentBase::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 854 of file ActiveLoggerComponentAc.cpp.

◆ loqQueue_internalInterfaceHandler()

virtual void Svc::ActiveLoggerComponentBase::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::ActiveLoggerComponentBase::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 1019 of file ActiveLoggerComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::ActiveLoggerComponentBase::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::ActiveLoggerComponentBase::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 879 of file ActiveLoggerComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::ActiveLoggerComponentBase::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 940 of file ActiveLoggerComponentAc.cpp.

◆ pingOut_out()

void Svc::ActiveLoggerComponentBase::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 995 of file ActiveLoggerComponentAc.cpp.

◆ PktSend_out()

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

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 973 of file ActiveLoggerComponentAc.cpp.

◆ regCommands()

void Svc::ActiveLoggerComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 627 of file ActiveLoggerComponentAc.cpp.

◆ set_CmdReg_OutputPort()

void Svc::ActiveLoggerComponentBase::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 371 of file ActiveLoggerComponentAc.cpp.

◆ set_CmdStatus_OutputPort()

void Svc::ActiveLoggerComponentBase::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 385 of file ActiveLoggerComponentAc.cpp.

◆ SET_EVENT_FILTER_cmdHandler()

virtual void Svc::ActiveLoggerComponentBase::SET_EVENT_FILTER_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		Svc::ActiveLogger_FilterSeverity	filterLevel,
		Svc::ActiveLogger_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::ActiveLoggerComponentBase::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 1104 of file ActiveLoggerComponentAc.cpp.

◆ set_FatalAnnounce_OutputPort()

void Svc::ActiveLoggerComponentBase::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 449 of file ActiveLoggerComponentAc.cpp.

◆ SET_ID_FILTER_cmdHandler()

virtual void Svc::ActiveLoggerComponentBase::SET_ID_FILTER_cmdHandler	(	FwOpcodeType	opCode,
		U32	cmdSeq,
		U32	ID,
		Svc::ActiveLogger_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::ActiveLoggerComponentBase::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 1165 of file ActiveLoggerComponentAc.cpp.

◆ SET_ID_FILTER_preMsgHook()

void Svc::ActiveLoggerComponentBase::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 1291 of file ActiveLoggerComponentAc.cpp.

◆ set_Log_OutputPort()

void Svc::ActiveLoggerComponentBase::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 399 of file ActiveLoggerComponentAc.cpp.

◆ set_pingOut_OutputPort()

void Svc::ActiveLoggerComponentBase::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 477 of file ActiveLoggerComponentAc.cpp.

◆ set_PktSend_OutputPort()

void Svc::ActiveLoggerComponentBase::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 463 of file ActiveLoggerComponentAc.cpp.

◆ set_Time_OutputPort()

void Svc::ActiveLoggerComponentBase::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 431 of file ActiveLoggerComponentAc.cpp.

Friends And Related Function Documentation

◆ ActiveLoggerComponentBaseFriend

friend class ActiveLoggerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 52 of file ActiveLoggerComponentAc.hpp.

◆ ActiveLoggerTesterBase

friend class ActiveLoggerTesterBase

friend

Friend class tester to support autocoded test harness.

Definition at line 54 of file ActiveLoggerComponentAc.hpp.

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

Svc/ActiveLogger/ActiveLoggerComponentAc.hpp
Svc/ActiveLogger/ActiveLoggerComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ ActiveLoggerComponentBase()

◆ ~ActiveLoggerComponentBase()

Member Function Documentation

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

◆ 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_Time_OutputPorts()

◆ getTime()

◆ init()

◆ isConnected_CmdReg_OutputPort()

◆ isConnected_CmdStatus_OutputPort()

◆ isConnected_FatalAnnounce_OutputPort()

◆ isConnected_Log_OutputPort()

◆ isConnected_pingOut_OutputPort()

◆ isConnected_PktSend_OutputPort()

◆ isConnected_Time_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()

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

◆ set_Time_OutputPort()

Friends And Related Function Documentation

◆ ActiveLoggerComponentBaseFriend

◆ ActiveLoggerTesterBase