DataNode Class Reference

#include <yatephone.h>

Inheritance diagram for DataNode:

RefObject GenObject DataConsumer DataSource DataTranslator ThreadedSource

List of all members.

Public Member Functions

 DataNode (const char *format=0)
virtual int costFormat (const DataFormat &format)
virtual bool setFormat (const DataFormat &format)
const DataFormatgetFormat () const
unsigned long timeStamp () const
virtual bool control (NamedList &params)

Static Public Member Functions

static unsigned long invalidStamp ()

Protected Attributes

DataFormat m_format
unsigned long m_timestamp


Detailed Description

A generic data handling object

Constructor & Destructor Documentation

DataNode ( const char *  format = 0  )  [inline]

Construct a DataNode

Parameters:
format Description of the data format, default none


Member Function Documentation

virtual bool control ( NamedList params  )  [inline, virtual]

Modify node parameters

Parameters:
params The list of parameters to change
Returns:
True if processed

virtual int costFormat ( const DataFormat format  )  [inline, virtual]

Get the computing cost of converting the data to the format asked

Parameters:
format Name of the format to check for
Returns:
-1 if unsupported, 0 for native format else cost in KIPS

const DataFormat& getFormat (  )  const [inline]

Get the description of the format currently in use

Returns:
Pointer to the data format

static unsigned long invalidStamp (  )  [inline, static]

Get the internal representation of an invalid or unknown timestamp

Returns:
Invalid timestamp - unsigned long conversion of -1

virtual bool setFormat ( const DataFormat format  )  [inline, virtual]

Change the format used to transfer data

Parameters:
format Name of the format to set for data
Returns:
True if the format changed successfully, false if not changed

unsigned long timeStamp (  )  const [inline]

Get the current position in the data stream

Returns:
Timestamp of current data position


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

Generated on Sun Dec 7 21:45:26 2008 for Yate by  doxygen 1.5.7.1