Fw::QueuedComponentBase Class Reference

#include <Fw/Comp/QueuedComponentBase.hpp>

Inheritance diagram for Fw::QueuedComponentBase:

Public Types
enum	MsgDispatchStatus { MSG_DISPATCH_OK , MSG_DISPATCH_EMPTY , MSG_DISPATCH_ERROR , MSG_DISPATCH_EXIT }

Protected Member Functions
	QueuedComponentBase (const char *name)
	Constructor. More...
virtual	~QueuedComponentBase ()
	Destructor. More...
void	init (NATIVE_INT_TYPE instance)
	initialization function More...
Os::Queue::Status	createQueue (FwSizeType depth, FwSizeType msgSize)
virtual MsgDispatchStatus	doDispatch ()=0
	method to dispatch a single message in the queue. More...
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
Os::Queue	m_queue
	queue object for active component More...

Additional Inherited Members
Public Member Functions inherited from Fw::PassiveComponentBase
void	setIdBase (const U32)
	Set the ID base. More...
U32	getIdBase () const

Detailed Description

Definition at line 21 of file QueuedComponentBase.hpp.

Member Enumeration Documentation

MsgDispatchStatus

enum Fw::QueuedComponentBase::MsgDispatchStatus

Enumerator
MSG_DISPATCH_OK	Dispatch was normal.
MSG_DISPATCH_EMPTY	No more messages in the queue.
MSG_DISPATCH_ERROR	Errors dispatching messages.
MSG_DISPATCH_EXIT	A message was sent requesting an exit of the loop.

Definition at line 25 of file QueuedComponentBase.hpp.

Constructor & Destructor Documentation

QueuedComponentBase()

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

protected

Constructor.

Definition at line 10 of file QueuedComponentBase.cpp.

~QueuedComponentBase()

Fw::QueuedComponentBase::~QueuedComponentBase ( )

protectedvirtual

Destructor.

Definition at line 14 of file QueuedComponentBase.cpp.

Member Function Documentation

createQueue()

Os::Queue::Queue::Status Fw::QueuedComponentBase::createQueue ( FwSizeType  depth, FwSizeType  msgSize  )

protected

Definition at line 33 of file QueuedComponentBase.cpp.

doDispatch()

virtual MsgDispatchStatus Fw::QueuedComponentBase::doDispatch ( )

protectedpure virtual

method to dispatch a single message in the queue.

Implemented in Svc::HealthComponentBase.

getNumMsgsDropped()

NATIVE_INT_TYPE Fw::QueuedComponentBase::getNumMsgsDropped ( )

protected

return number of messages dropped

Definition at line 46 of file QueuedComponentBase.cpp.

incNumMsgDropped()

void Fw::QueuedComponentBase::incNumMsgDropped ( )

protected

increment the number of messages dropped

Definition at line 50 of file QueuedComponentBase.cpp.

init()

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

protected

initialization function

Definition at line 18 of file QueuedComponentBase.cpp.

Member Data Documentation

m_queue

Os::Queue Fw::QueuedComponentBase::m_queue

protected

queue object for active component

Definition at line 36 of file QueuedComponentBase.hpp.

---

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

• Fw/Comp/QueuedComponentBase.hpp
• Fw/Comp/QueuedComponentBase.cpp