Yate
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
DataNode Class Reference

#include <yatephone.h>

Inheritance diagram for DataNode:
RefObject GenObject DataConsumer DataSource DataTranslator ThreadedSource

List of all members.

Public Types

enum  DataFlags {
  DataStart = 0x0001, DataEnd = 0x0002, DataMark = 0x0004, DataSilent = 0x0008,
  DataMissed = 0x0010, DataError = 0x0020, DataPrivate = 0x0100
}

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 valid () const
virtual bool control (NamedList &params)

Static Public Member Functions

static unsigned long invalidStamp ()

Protected Member Functions

virtual void attached (bool added)

Protected Attributes

DataFormat m_format
unsigned long m_timestamp

Friends

class DataEndpoint

Detailed Description

A generic data handling object


Member Enumeration Documentation

enum DataFlags

Flags associated with the DataBlocks forwarded between nodes


Constructor & Destructor Documentation

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

Construct a DataNode

Parameters:
formatDescription of the data format, default none

Member Function Documentation

virtual void attached ( bool  added) [inline, protected, virtual]

Owner attach and detach notification. This method is called with DataEndpoint::commonMutex() held

Parameters:
addedTrue if a new owner was added, false if it was removed
virtual bool control ( NamedList params) [inline, virtual]

Modify node parameters

Parameters:
paramsThe 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:
formatName 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:
formatName 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
virtual bool valid ( ) const [inline, virtual]

Check if this data node is still valid

Returns:
True if still valid, false if node should be removed

Reimplemented in DataTranslator, and DataSource.


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