Fw::ActiveComponentBase Class Reference

#include <Fw/Comp/ActiveComponentBase.hpp>

Inheritance diagram for Fw::ActiveComponentBase:

Public Types
enum	{ ACTIVE_COMPONENT_EXIT }
Public Types inherited from Fw::QueuedComponentBase
enum	MsgDispatchStatus { MSG_DISPATCH_OK , MSG_DISPATCH_EMPTY , MSG_DISPATCH_ERROR , MSG_DISPATCH_EXIT }

Public Member Functions
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
	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
void	exit ()
	exit task in active component
Os::Task::TaskStatus	join (void **value_ptr)
	provide return value of thread if value_ptr is not NULL
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base.
U32	getIdBase () const

Protected Member Functions
	ActiveComponentBase (const char *name)
	Constructor.
virtual	~ActiveComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	initialization code
virtual void	preamble ()
	A function that will be called before the event loop is entered.
virtual void	loop ()
	The function that will loop dispatching messages.
virtual void	finalizer ()
	A function that will be called after exiting the loop.
Protected Member Functions inherited from Fw::QueuedComponentBase
	QueuedComponentBase (const char *name)
	Constructor.
virtual	~QueuedComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	initialization function
Os::Queue::QueueStatus	createQueue (NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)
virtual MsgDispatchStatus	doDispatch ()=0
	method to dispatch a single message in the queue.
NATIVE_INT_TYPE	getNumMsgsDropped ()
	return number of messages dropped
void	incNumMsgDropped ()
	increment the number of messages dropped
Protected Member Functions inherited from Fw::PassiveComponentBase
	PassiveComponentBase (const char *name)
	Named constructor.
virtual	~PassiveComponentBase ()
	Destructor.
void	init (NATIVE_INT_TYPE instance)
	Initialization function.
NATIVE_INT_TYPE	getInstance () const
Protected Member Functions inherited from Fw::ObjBase
	ObjBase (const char *name)
	ObjBase constructor.
virtual	~ObjBase ()
	Destructor.
void	init ()
	Object initializer.

Protected Attributes
Os::Task	m_task
	task object for active component
Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue	m_queue
	queue object for active component

Detailed Description

Definition at line 20 of file ActiveComponentBase.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
ACTIVE_COMPONENT_EXIT	message to exit active component task

Definition at line 29 of file ActiveComponentBase.hpp.

Constructor & Destructor Documentation

ActiveComponentBase()

Fw::ActiveComponentBase::ActiveComponentBase ( const char * name )

protected

Constructor.

Definition at line 33 of file ActiveComponentBase.cpp.

~ActiveComponentBase()

Fw::ActiveComponentBase::~ActiveComponentBase ( )

protectedvirtual

Destructor.

Definition at line 37 of file ActiveComponentBase.cpp.

Member Function Documentation

DEPRECATED()

Fw::ActiveComponentBase::DEPRECATED	(	void	startNATIVE_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

exit()

void Fw::ActiveComponentBase::exit

(

)

exit task in active component

Definition at line 81 of file ActiveComponentBase.cpp.

finalizer()

void Fw::ActiveComponentBase::finalizer ( )

protectedvirtual

A function that will be called after exiting the loop.

Definition at line 154 of file ActiveComponentBase.cpp.

init()

void Fw::ActiveComponentBase::init ( NATIVE_INT_TYPE instance )

protected

initialization code

Definition at line 41 of file ActiveComponentBase.cpp.

join()

Os::Task::TaskStatus Fw::ActiveComponentBase::join

(

void **

value_ptr

)

provide return value of thread if value_ptr is not NULL

Definition at line 89 of file ActiveComponentBase.cpp.

loop()

void Fw::ActiveComponentBase::loop ( )

protectedvirtual

The function that will loop dispatching messages.

Definition at line 133 of file ActiveComponentBase.cpp.

preamble()

void Fw::ActiveComponentBase::preamble ( )

protectedvirtual

A function that will be called before the event loop is entered.

Reimplemented in Svc::FileDownlink.

Definition at line 151 of file ActiveComponentBase.cpp.

start()

void Fw::ActiveComponentBase::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

Definition at line 54 of file ActiveComponentBase.cpp.

Member Data Documentation

m_task

Os::Task Fw::ActiveComponentBase::m_task

protected

task object for active component

Definition at line 40 of file ActiveComponentBase.hpp.

---

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

• Fw/Comp/ActiveComponentBase.hpp
• Fw/Comp/ActiveComponentBase.cpp