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

#include <Svc/ActiveTextLogger/ActiveTextLoggerComponentAc.hpp>

Inheritance diagram for Svc::ActiveTextLoggerComponentBase:

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

Fw::InputLogTextPort *	get_TextLogger_InputPort (FwIndexType portNum)

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_TEXTLOGGER_INPUT_PORTS = 1 }
	Enumerations for numbers of typed input ports. More...

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

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

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

FwIndexType	getNum_TextLogger_InputPorts () const

virtual void	TextLogger_handler (FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::TextLogString &text)=0
	Handler for input port TextLogger. More...

void	TextLogger_handlerBase (FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::TextLogString &text)
	Handler base-class function for input port TextLogger. More...

virtual void	TextQueue_internalInterfaceHandler (const Fw::InternalInterfaceString &text)=0
	Internal interface handler for TextQueue. More...

void	TextQueue_internalInterfaceInvoke (const Fw::InternalInterfaceString &text)
	Internal interface base-class function for TextQueue. More...

Protected Member Functions inherited from Fw::ActiveComponentBase
	ActiveComponentBase (const char *name)
	Constructor. More...

virtual	~ActiveComponentBase ()
	Destructor. More...

void	init (NATIVE_INT_TYPE instance)
	initialization code More...

virtual void	preamble ()
	A function that will be called before the event loop is entered. More...

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 (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	ActiveTextLoggerComponentBaseFriend
	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 ActiveTextLogger component.

A component for printing text logs to the console and optionally a file

Definition at line 25 of file ActiveTextLoggerComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_TEXTLOGGER_INPUT_PORTS

Definition at line 43 of file ActiveTextLoggerComponentAc.hpp.

Constructor & Destructor Documentation

◆ ActiveTextLoggerComponentBase()

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

protected

Construct ActiveTextLoggerComponentBase object.

Parameters

compName The component name

Definition at line 132 of file ActiveTextLoggerComponentAc.cpp.

◆ ~ActiveTextLoggerComponentBase()

Svc::ActiveTextLoggerComponentBase::~ActiveTextLoggerComponentBase ( )

protectedvirtual

Destroy ActiveTextLoggerComponentBase object.

Definition at line 139 of file ActiveTextLoggerComponentAc.cpp.

Member Function Documentation

◆ get_TextLogger_InputPort()

Fw::InputLogTextPort * Svc::ActiveTextLoggerComponentBase::get_TextLogger_InputPort ( FwIndexType portNum )

Get typed input port at index

Returns: TextLogger[portNum]

Parameters

portNum The port number

Definition at line 117 of file ActiveTextLoggerComponentAc.cpp.

◆ getNum_TextLogger_InputPorts()

FwIndexType Svc::ActiveTextLoggerComponentBase::getNum_TextLogger_InputPorts ( ) const

protected

Get the number of TextLogger input ports

Returns: The number of TextLogger input ports

Definition at line 149 of file ActiveTextLoggerComponentAc.cpp.

◆ init()

void Svc::ActiveTextLoggerComponentBase::init	(	FwQueueSizeType	queueDepth,
		FwEnumStoreType	instance = `0`
	)

Initialize ActiveTextLoggerComponentBase object.

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 70 of file ActiveTextLoggerComponentAc.cpp.

◆ TextLogger_handler()

virtual void Svc::ActiveTextLoggerComponentBase::TextLogger_handler	(	FwIndexType	portNum,
		FwEventIdType	id,
		Fw::Time &	timeTag,
		const Fw::LogSeverity &	severity,
		Fw::TextLogString &	text
	)

protectedpure virtual

Handler for input port TextLogger.

Parameters

portNum	The port number
id	Log ID
timeTag	Time Tag
severity	The severity argument
text	Text of log message

◆ TextLogger_handlerBase()

void Svc::ActiveTextLoggerComponentBase::TextLogger_handlerBase	(	FwIndexType	portNum,
		FwEventIdType	id,
		Fw::Time &	timeTag,
		const Fw::LogSeverity &	severity,
		Fw::TextLogString &	text
	)

protected

Handler base-class function for input port TextLogger.

Parameters

portNum	The port number
id	Log ID
timeTag	Time Tag
severity	The severity argument
text	Text of log message

Definition at line 161 of file ActiveTextLoggerComponentAc.cpp.

◆ TextQueue_internalInterfaceHandler()

virtual void Svc::ActiveTextLoggerComponentBase::TextQueue_internalInterfaceHandler ( const Fw::InternalInterfaceString & text )

protectedpure virtual

Internal interface handler for TextQueue.

Parameters

text	The text string

◆ TextQueue_internalInterfaceInvoke()

void Svc::ActiveTextLoggerComponentBase::TextQueue_internalInterfaceInvoke ( const Fw::InternalInterfaceString & text )

protected

Internal interface base-class function for TextQueue.

Parameters

text	The text string

Definition at line 190 of file ActiveTextLoggerComponentAc.cpp.

Friends And Related Function Documentation

◆ ActiveTextLoggerComponentBaseFriend

friend class ActiveTextLoggerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 34 of file ActiveTextLoggerComponentAc.hpp.

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

Svc/ActiveTextLogger/ActiveTextLoggerComponentAc.hpp
Svc/ActiveTextLogger/ActiveTextLoggerComponentAc.cpp

Public Member Functions

Protected Types

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ActiveTextLoggerComponentBase()

◆ ~ActiveTextLoggerComponentBase()

Member Function Documentation

◆ get_TextLogger_InputPort()

◆ getNum_TextLogger_InputPorts()

◆ init()

◆ TextLogger_handler()

◆ TextLogger_handlerBase()

◆ TextQueue_internalInterfaceHandler()

◆ TextQueue_internalInterfaceInvoke()

Friends And Related Function Documentation

◆ ActiveTextLoggerComponentBaseFriend