Svc::PassiveTextLoggerComponentBase Class Reference

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

#include <Svc/PassiveConsoleTextLogger/PassiveTextLoggerComponentAc.hpp>

Inheritance diagram for Svc::PassiveTextLoggerComponentBase:

Public Member Functions
void	init (NATIVE_INT_TYPE instance=0)
	Initialize PassiveTextLoggerComponentBase object. More...
Fw::InputLogTextPort *	get_TextLogger_InputPort (NATIVE_INT_TYPE portNum)
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 Member Functions
	PassiveTextLoggerComponentBase (const char *compName="")
	Construct PassiveTextLoggerComponentBase object. More...
virtual	~PassiveTextLoggerComponentBase ()
	Destroy PassiveTextLoggerComponentBase object. More...
NATIVE_INT_TYPE	getNum_TextLogger_InputPorts () const
virtual void	TextLogger_handler (NATIVE_INT_TYPE portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::TextLogString &text)=0
	Handler for input port TextLogger. More...
void	TextLogger_handlerBase (NATIVE_INT_TYPE portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::TextLogString &text)
	Handler base-class function for input port TextLogger. 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	PassiveTextLoggerComponentBaseFriend
	Friend class for white-box testing. More...

Detailed Description

Auto-generated base for PassiveTextLogger component.

A component to implement log messages with a print to the console

Definition at line 24 of file PassiveTextLoggerComponentAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_TEXTLOGGER_INPUT_PORTS

Definition at line 42 of file PassiveTextLoggerComponentAc.hpp.

Constructor & Destructor Documentation

PassiveTextLoggerComponentBase()

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

protected

Construct PassiveTextLoggerComponentBase object.

Parameters

compName

The component name

Definition at line 79 of file PassiveTextLoggerComponentAc.cpp.

~PassiveTextLoggerComponentBase()

Svc::PassiveTextLoggerComponentBase::~PassiveTextLoggerComponentBase ( )

protectedvirtual

Destroy PassiveTextLoggerComponentBase object.

Definition at line 86 of file PassiveTextLoggerComponentAc.cpp.

Member Function Documentation

get_TextLogger_InputPort()

Fw::InputLogTextPort * Svc::PassiveTextLoggerComponentBase::get_TextLogger_InputPort

(

NATIVE_INT_TYPE

portNum

)

Get typed input port at index

Returns

TextLogger[portNum]

Parameters

portNum

The port number

Definition at line 64 of file PassiveTextLoggerComponentAc.cpp.

getNum_TextLogger_InputPorts()

NATIVE_INT_TYPE Svc::PassiveTextLoggerComponentBase::getNum_TextLogger_InputPorts ( ) const

protected

Get the number of TextLogger input ports

Returns

The number of TextLogger input ports

Definition at line 96 of file PassiveTextLoggerComponentAc.cpp.

init()

void Svc::PassiveTextLoggerComponentBase::init

(

NATIVE_INT_TYPE

instance = 0

)

Initialize PassiveTextLoggerComponentBase object.

Parameters

instance

The instance number

Definition at line 21 of file PassiveTextLoggerComponentAc.cpp.

TextLogger_handler()

virtual void Svc::PassiveTextLoggerComponentBase::TextLogger_handler ( NATIVE_INT_TYPE  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::PassiveTextLoggerComponentBase::TextLogger_handlerBase ( NATIVE_INT_TYPE  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 108 of file PassiveTextLoggerComponentAc.cpp.

Friends And Related Function Documentation

PassiveTextLoggerComponentBaseFriend

friend class PassiveTextLoggerComponentBaseFriend

friend

Friend class for white-box testing.

Definition at line 33 of file PassiveTextLoggerComponentAc.hpp.

---

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

• Svc/PassiveConsoleTextLogger/PassiveTextLoggerComponentAc.hpp
• Svc/PassiveConsoleTextLogger/PassiveTextLoggerComponentAc.cpp