class DataConsumer

A data consumer More...

Contains pure virtuals
Full nameTelEngine::DataConsumer
Definition#include <yatephone.h>
InheritsTelEngine::DataNode [public ]
Inherited byDataTranslator
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

A data consumer

inline  DataConsumer (const char* format = "slin")

DataConsumer

Consumer constructor

Parameters:
formatName of the data format, default "slin" (Signed Linear)

 ~DataConsumer ()

~DataConsumer

[virtual]

Consumer's destructor - complains loudly if still attached to a source

void*  getObject (const String& name)

getObject

[const virtual]

Get a pointer to a derived class given that class name

Parameters:
nameName of the class we are asking for

Returns: Pointer to the requested class or NULL if this object doesn't implement it

Reimplemented from GenObject.

void  Consume (const DataBlock& data, unsigned long tStamp)

Consume

[pure virtual]

Consumes the data sent to it from a source

Parameters:
dataThe raw data block to process; an empty block ends data
tStampTimestamp of data - typically samples

inline DataSource*  getConnSource ()

getConnSource

[const]

Get the data source of this object if it's connected

Returns: A pointer to the DataSource object or NULL

inline DataSource*  getOverSource ()

getOverSource

[const]

Get the override data source of this object if it's connected

Returns: A pointer to the DataSource object or NULL

DataSource*  getTransSource ()

getTransSource

[const virtual]

Get the data source of a translator object

Returns: A pointer to the DataSource object or NULL

bool  synchronize (DataSource* source)

synchronize

[protected virtual]

Synchronize the consumer with a source

Parameters:
sourceData source to copy the timestamp from

Returns: True if we could synchronize with the source


Generated by: root on dragoshel on Sat Apr 14 01:50:50 2007, using kdoc 2.0a54.