AcsBulkdata::BulkDataNTReceiverFlow Class Reference

#include <bulkDataNTReceiverFlow.h>

Inheritance diagram for AcsBulkdata::BulkDataNTReceiverFlow:

Collaboration diagram for AcsBulkdata::BulkDataNTReceiverFlow:

List of all members.

Public Member Functions
	BulkDataNTReceiverFlow (BulkDataNTReceiverStreamBase *receiverStream, const char *flowName, const ReceiverFlowConfiguration &rcvCfg, BulkDataNTCallback *cb, bool releaseCB)
virtual	~BulkDataNTReceiverFlow ()
void	setReceiverName (char *recvName)
BulkDataNTCallback *	getCallbackObject ()
template<class T >
T *	getCallback ()
void	enableCallingCB ()
	Enables calling user's CB (cbStart, cbReceiver, cbStop).
void	disableCallingCB ()
	Disables calling user's CB (cbStart, cbReceiver, cbStop).
void	dumpStatistics ()
Protected Member Functions
	BulkDataNTReceiverFlow ()
	local copy of rcv configuration
void	operator= (const BulkDataNTReceiverFlow &)
	ALMA C++ coding standards state assignment operators should be disabled.
	BulkDataNTReceiverFlow (const BulkDataNTReceiverFlow &)
	ALMA C++ coding standards state copy constructors should be disabled.
Protected Attributes
AcsBulkdata::BulkDataNTReceiverStreamBase *	receiverStream_m
AcsBulkdata::BulkDataNTDDSSubscriber *	ddsSubscriber_m
ACSBulkData::BulkDataNTFrameDataReader *	ddsDataReader_m
DDS::Topic *	ddsTopic_m
BulkDataNTReaderListener *	dataReaderListener_m
	DDS topic.
BulkDataNTCallback *	callback_m
	DDS reader.
bool	releaseCB_m
	callback
ReceiverFlowConfiguration	rcvCfg_m
	should the CB be destroyed when the flow is destroyed

---

Constructor & Destructor Documentation

AcsBulkdata::BulkDataNTReceiverFlow::BulkDataNTReceiverFlow	(	BulkDataNTReceiverStreamBase *	receiverStream,
		const char *	flowName,
		const ReceiverFlowConfiguration &	rcvCfg,
		BulkDataNTCallback *	cb,
		bool	releaseCB
	)

Receiver flow constructor. It is used by REceiverStream class.

Parameters:

	receiverStream	pointer to the stream where the flow should be created
	flowName	the name of the flow that we want to create
	rcvCfg	receiver flow configuration
	cb	pointer to the receiver flow callback
	releaseCB	should the callback be relased when the flow is destroyed

virtual AcsBulkdata::BulkDataNTReceiverFlow::~BulkDataNTReceiverFlow

(

)

[virtual]

Receiver flow destructor

AcsBulkdata::BulkDataNTReceiverFlow::BulkDataNTReceiverFlow

(

)

[protected]

local copy of rcv configuration

disable default - empty constructor

AcsBulkdata::BulkDataNTReceiverFlow::BulkDataNTReceiverFlow

(

const BulkDataNTReceiverFlow &

)

[protected]

ALMA C++ coding standards state copy constructors should be disabled.

---

Member Function Documentation

void AcsBulkdata::BulkDataNTReceiverFlow::disableCallingCB

(

)

Disables calling user's CB (cbStart, cbReceiver, cbStop).

void AcsBulkdata::BulkDataNTReceiverFlow::dumpStatistics

(

)

void AcsBulkdata::BulkDataNTReceiverFlow::enableCallingCB

(

)

Enables calling user's CB (cbStart, cbReceiver, cbStop).

template<class T >

T* AcsBulkdata::BulkDataNTReceiverFlow::getCallback

(

)

[inline]

template/casted version of getCallbackObject

Returns:

pointer to casted callback object

References callback_m.

BulkDataNTCallback* AcsBulkdata::BulkDataNTReceiverFlow::getCallbackObject

(

)

[inline]

If we need to get callback object, for example if CB is created using template parameter.

Returns:

pointer to callback object.

References callback_m.

void AcsBulkdata::BulkDataNTReceiverFlow::operator=

(

const BulkDataNTReceiverFlow &

)

[protected]

ALMA C++ coding standards state assignment operators should be disabled.

void AcsBulkdata::BulkDataNTReceiverFlow::setReceiverName

(

char *

recvName

)

Sets the name of receiver, so that we can distinguish between different receivers in the system.

Parameters:

recvName

name of receiver.

---

Member Data Documentation

BulkDataNTCallback* AcsBulkdata::BulkDataNTReceiverFlow::callback_m [protected]

DDS reader.

Referenced by getCallback(), and getCallbackObject().

BulkDataNTReaderListener* AcsBulkdata::BulkDataNTReceiverFlow::dataReaderListener_m [protected]

DDS topic.

ACSBulkData::BulkDataNTFrameDataReader* AcsBulkdata::BulkDataNTReceiverFlow::ddsDataReader_m [protected]

AcsBulkdata::BulkDataNTDDSSubscriber* AcsBulkdata::BulkDataNTReceiverFlow::ddsSubscriber_m [protected]

DDS::Topic* AcsBulkdata::BulkDataNTReceiverFlow::ddsTopic_m [protected]

ReceiverFlowConfiguration AcsBulkdata::BulkDataNTReceiverFlow::rcvCfg_m [protected]

should the CB be destroyed when the flow is destroyed

AcsBulkdata::BulkDataNTReceiverStreamBase* AcsBulkdata::BulkDataNTReceiverFlow::receiverStream_m [protected]

bool AcsBulkdata::BulkDataNTReceiverFlow::releaseCB_m [protected]

callback

---

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

• bulkDataNTReceiverFlow.h