Svc::ActiveLoggerComponentBase Class Reference

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

#include <Svc/ActiveLogger/ActiveLoggerComponentAc.hpp>

Inheritance diagram for Svc::ActiveLoggerComponentBase:

Public Member Functions
void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)
	Initialize ActiveLoggerComponentBase object. More...
Fw::InputCmdPort *	get_CmdDisp_InputPort (NATIVE_INT_TYPE portNum)
Fw::InputLogPort *	get_LogRecv_InputPort (NATIVE_INT_TYPE portNum)
Svc::InputPingPort *	get_pingIn_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_FatalAnnounce_OutputPort (NATIVE_INT_TYPE portNum, Svc::InputFatalEventPort *port)
	Connect port to FatalAnnounce[portNum]. More...
void	set_PktSend_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputComPort *port)
	Connect port to PktSend[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_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 Member Functions
	ActiveLoggerComponentBase (const char *compName="")
	Construct ActiveLoggerComponentBase object. More...
virtual	~ActiveLoggerComponentBase ()
	Destroy ActiveLoggerComponentBase object. More...
NATIVE_INT_TYPE	getNum_CmdDisp_InputPorts () const
NATIVE_INT_TYPE	getNum_LogRecv_InputPorts () const
NATIVE_INT_TYPE	getNum_pingIn_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_FatalAnnounce_OutputPorts () const
NATIVE_INT_TYPE	getNum_PktSend_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_FatalAnnounce_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_PktSend_OutputPort (NATIVE_INT_TYPE portNum)
bool	isConnected_pingOut_OutputPort (NATIVE_INT_TYPE portNum)
virtual void	LogRecv_handler (NATIVE_INT_TYPE portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::LogBuffer &args)=0
	Handler for input port LogRecv. More...
virtual void	pingIn_handler (NATIVE_INT_TYPE portNum, U32 key)=0
	Handler for input port pingIn. More...
void	LogRecv_handlerBase (NATIVE_INT_TYPE 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 (NATIVE_INT_TYPE portNum, U32 key)
	Handler base-class function for input port pingIn. More...
virtual void	pingIn_preMsgHook (NATIVE_INT_TYPE portNum, U32 key)
	Pre-message hook for async input port pingIn. More...
void	FatalAnnounce_out (NATIVE_INT_TYPE portNum, FwEventIdType Id)
	Invoke output port FatalAnnounce. More...
void	PktSend_out (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)
	Invoke output port PktSend. More...
void	pingOut_out (NATIVE_INT_TYPE 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)
void	log_ACTIVITY_HI_ID_FILTER_ENABLED (U32 ID)
void	log_WARNING_LO_ID_FILTER_LIST_FULL (U32 ID)
void	log_ACTIVITY_HI_ID_FILTER_REMOVED (U32 ID)
void	log_WARNING_LO_ID_FILTER_NOT_FOUND (U32 ID)
Fw::Time	getTime ()
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	ActiveLoggerComponentBaseFriend
	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 ActiveLogger component.

A component for logging events

Definition at line 40 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 58 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 63 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 69 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 78 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 85 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 92 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 735 of file ActiveLoggerComponentAc.cpp.

~ActiveLoggerComponentBase()

Svc::ActiveLoggerComponentBase::~ActiveLoggerComponentBase ( )

protectedvirtual

Destroy ActiveLoggerComponentBase object.

Definition at line 742 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 1158 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 1295 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 1373 of file ActiveLoggerComponentAc.cpp.

FatalAnnounce_out()

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

protected

Invoke output port FatalAnnounce.

Parameters

portNum	The port number
Id	The ID of the FATAL event

Definition at line 1039 of file ActiveLoggerComponentAc.cpp.

get_CmdDisp_InputPort()

Fw::InputCmdPort * Svc::ActiveLoggerComponentBase::get_CmdDisp_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get special input port at index

Returns

CmdDisp[portNum]

Parameters

portNum

The port number

Definition at line 416 of file ActiveLoggerComponentAc.cpp.

get_LogRecv_InputPort()

Fw::InputLogPort * Svc::ActiveLoggerComponentBase::get_LogRecv_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

LogRecv[portNum]

Parameters

portNum

The port number

Definition at line 431 of file ActiveLoggerComponentAc.cpp.

get_pingIn_InputPort()

Svc::InputPingPort * Svc::ActiveLoggerComponentBase::get_pingIn_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

pingIn[portNum]

Parameters

portNum

The port number

Definition at line 442 of file ActiveLoggerComponentAc.cpp.

getNum_CmdDisp_InputPorts()

NATIVE_INT_TYPE Svc::ActiveLoggerComponentBase::getNum_CmdDisp_InputPorts ( ) const

protected

Get the number of CmdDisp input ports

Returns

The number of CmdDisp input ports

Definition at line 752 of file ActiveLoggerComponentAc.cpp.

getNum_CmdReg_OutputPorts()

NATIVE_INT_TYPE Svc::ActiveLoggerComponentBase::getNum_CmdReg_OutputPorts ( ) const

protected

Get the number of CmdReg output ports

Returns

The number of CmdReg output ports

Definition at line 778 of file ActiveLoggerComponentAc.cpp.

getNum_CmdStatus_OutputPorts()

NATIVE_INT_TYPE Svc::ActiveLoggerComponentBase::getNum_CmdStatus_OutputPorts ( ) const

protected

Get the number of CmdStatus output ports

Returns

The number of CmdStatus output ports

Definition at line 784 of file ActiveLoggerComponentAc.cpp.

getNum_FatalAnnounce_OutputPorts()

NATIVE_INT_TYPE Svc::ActiveLoggerComponentBase::getNum_FatalAnnounce_OutputPorts ( ) const

protected

Get the number of FatalAnnounce output ports

Returns

The number of FatalAnnounce output ports

Definition at line 816 of file ActiveLoggerComponentAc.cpp.

getNum_Log_OutputPorts()

NATIVE_INT_TYPE Svc::ActiveLoggerComponentBase::getNum_Log_OutputPorts ( ) const

protected

Get the number of Log output ports

Returns

The number of Log output ports

Definition at line 790 of file ActiveLoggerComponentAc.cpp.

getNum_LogRecv_InputPorts()

NATIVE_INT_TYPE Svc::ActiveLoggerComponentBase::getNum_LogRecv_InputPorts ( ) const

protected

Get the number of LogRecv input ports

Returns

The number of LogRecv input ports

Definition at line 762 of file ActiveLoggerComponentAc.cpp.

getNum_pingIn_InputPorts()

NATIVE_INT_TYPE Svc::ActiveLoggerComponentBase::getNum_pingIn_InputPorts ( ) const

protected

Get the number of pingIn input ports

Returns

The number of pingIn input ports

Definition at line 768 of file ActiveLoggerComponentAc.cpp.

getNum_pingOut_OutputPorts()

NATIVE_INT_TYPE Svc::ActiveLoggerComponentBase::getNum_pingOut_OutputPorts ( ) const

protected

Get the number of pingOut output ports

Returns

The number of pingOut output ports

Definition at line 828 of file ActiveLoggerComponentAc.cpp.

getNum_PktSend_OutputPorts()

NATIVE_INT_TYPE Svc::ActiveLoggerComponentBase::getNum_PktSend_OutputPorts ( ) const

protected

Get the number of PktSend output ports

Returns

The number of PktSend output ports

Definition at line 822 of file ActiveLoggerComponentAc.cpp.

getNum_Time_OutputPorts()

NATIVE_INT_TYPE Svc::ActiveLoggerComponentBase::getNum_Time_OutputPorts ( ) const

protected

Get the number of Time output ports

Returns

The number of Time output ports

Definition at line 806 of file ActiveLoggerComponentAc.cpp.

getTime()

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

protected

Get the time

\return The current time

Definition at line 1855 of file ActiveLoggerComponentAc.cpp.

init()

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

Initialize ActiveLoggerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 79 of file ActiveLoggerComponentAc.cpp.

isConnected_CmdReg_OutputPort()

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

isConnected_CmdStatus_OutputPort()

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

isConnected_FatalAnnounce_OutputPort()

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

protected

Check whether port FatalAnnounce is connected

Returns

Whether port FatalAnnounce is connected

Parameters

portNum

The port number

Definition at line 901 of file ActiveLoggerComponentAc.cpp.

isConnected_Log_OutputPort()

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

isConnected_pingOut_OutputPort()

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

isConnected_PktSend_OutputPort()

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

protected

Check whether port PktSend is connected

Returns

Whether port PktSend is connected

Parameters

portNum

The port number

Definition at line 912 of file ActiveLoggerComponentAc.cpp.

isConnected_Time_OutputPort()

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

log_ACTIVITY_HI_ID_FILTER_ENABLED()

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

protected

Log event ID_FILTER_ENABLED

Indicate ID is filtered

Parameters

ID	The ID filtered

Definition at line 1499 of file ActiveLoggerComponentAc.cpp.

log_ACTIVITY_HI_ID_FILTER_REMOVED()

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

protected

Log event ID_FILTER_REMOVED

Removed an ID from the filter

Parameters

ID	The ID removed

Definition at line 1675 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  )

protected

Log event SEVERITY_FILTER_STATE

Dump severity filter state

Parameters

severity

The severity level

Definition at line 1388 of file ActiveLoggerComponentAc.cpp.

log_WARNING_LO_ID_FILTER_LIST_FULL()

void Svc::ActiveLoggerComponentBase::log_WARNING_LO_ID_FILTER_LIST_FULL ( U32  ID )

protected

Log event ID_FILTER_LIST_FULL

Attempted to add ID to full ID filter ID

Parameters

ID	The ID filtered

Definition at line 1587 of file ActiveLoggerComponentAc.cpp.

log_WARNING_LO_ID_FILTER_NOT_FOUND()

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

protected

Log event ID_FILTER_NOT_FOUND

ID not in filter

Parameters

ID	The ID removed

Definition at line 1763 of file ActiveLoggerComponentAc.cpp.

LogRecv_handler()

virtual void Svc::ActiveLoggerComponentBase::LogRecv_handler ( NATIVE_INT_TYPE  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 ( NATIVE_INT_TYPE  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 940 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 1090 of file ActiveLoggerComponentAc.cpp.

pingIn_handler()

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

pingIn_preMsgHook()

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

pingOut_out()

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

PktSend_out()

void Svc::ActiveLoggerComponentBase::PktSend_out ( NATIVE_INT_TYPE  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 1054 of file ActiveLoggerComponentAc.cpp.

regCommands()

void Svc::ActiveLoggerComponentBase::regCommands

(

)

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 713 of file ActiveLoggerComponentAc.cpp.

set_CmdReg_OutputPort()

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

set_CmdStatus_OutputPort()

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

set_FatalAnnounce_OutputPort()

void Svc::ActiveLoggerComponentBase::set_FatalAnnounce_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Svc::InputFatalEventPort *	port
	)

Connect port to FatalAnnounce[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 535 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 1236 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 1362 of file ActiveLoggerComponentAc.cpp.

set_Log_OutputPort()

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

set_pingOut_OutputPort()

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

set_PktSend_OutputPort()

void Svc::ActiveLoggerComponentBase::set_PktSend_OutputPort	(	NATIVE_INT_TYPE	portNum,
		Fw::InputComPort *	port
	)

Connect port to PktSend[portNum].

Parameters

portNum	The port number
port	The input port

Definition at line 549 of file ActiveLoggerComponentAc.cpp.

set_Time_OutputPort()

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

Friends And Related Function Documentation

ActiveLoggerComponentBaseFriend

friend class ActiveLoggerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 49 of file ActiveLoggerComponentAc.hpp.

---

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

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