Svc::ActiveTextLogger Class Reference

#include <Svc/ActiveTextLogger/ActiveTextLogger.hpp>

Inheritance diagram for Svc::ActiveTextLogger:

Public Member Functions
	ActiveTextLogger (const char *compName)
	Component constructor. More...
virtual	~ActiveTextLogger ()
	Component destructor. More...
void	init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance=0)
	Component initialization routine. More...
bool	set_log_file (const char *fileName, const U32 maxSize, const U32 maxBackups=10)
	Set log file and max size. More...
Public Member Functions inherited from Svc::ActiveTextLoggerComponentBase
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

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 Types inherited from Svc::ActiveTextLoggerComponentBase
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 inherited from Svc::ActiveTextLoggerComponentBase
	ActiveTextLoggerComponentBase (const char *compName="")
	Construct ActiveTextLoggerComponentBase object. More...
virtual	~ActiveTextLoggerComponentBase ()
	Destroy ActiveTextLoggerComponentBase object. More...
FwIndexType	getNum_TextLogger_InputPorts () const
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...
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...
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

Definition at line 24 of file ActiveTextLogger.hpp.

Constructor & Destructor Documentation

ActiveTextLogger()

Svc::ActiveTextLogger::ActiveTextLogger ( const char *  compName )

explicit

Component constructor.

The constructor initializes the state of the component.

Note: Making constructor explicit to prevent implicit type conversion.

Parameters

compName

the component instance name

Definition at line 17 of file ActiveTextLogger.cpp.

~ActiveTextLogger()

Svc::ActiveTextLogger::~ActiveTextLogger ( )

virtual

Component destructor.

destructor

Definition at line 24 of file ActiveTextLogger.cpp.

Member Function Documentation

init()

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

Component initialization routine.

The initialization function calls the initialization routine for the base class.

Parameters

queueDepth	the depth of the message queue for the component
instance	instance identifier. Default: 0.

Definition at line 29 of file ActiveTextLogger.cpp.

set_log_file()

bool Svc::ActiveTextLogger::set_log_file	(	const char *	fileName,
		const U32	maxSize,
		const U32	maxBackups = 10
	)

Set log file and max size.

This is to create an optional log file to write all the messages to. The file will not be written to once the max size is hit.

Parameters

fileName	The name of the file to create. Must be less than 80 characters.
maxSize	The max size of the file
maxBackups	The maximum backups of the log file. Default: 10

Returns

true if creating the file was successful, false otherwise

Definition at line 135 of file ActiveTextLogger.cpp.

---

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

• Svc/ActiveTextLogger/ActiveTextLogger.hpp
• Svc/ActiveTextLogger/ActiveTextLogger.cpp