#include <yatephone.h>
◆ DataConsumer()
Consumer constructor 
- Parameters
- 
  
    | format | Name of the data format, default "slin" (Signed Linear) |  
 
 
 
◆ Consume()
  
  | 
        
          | virtual unsigned long Consume | ( | const DataBlock & | data, |  
          |  |  | unsigned long | tStamp, |  
          |  |  | unsigned long | flags ) |  | pure virtual | 
 
Consumes the data sent to it from a source 
- Parameters
- 
  
    | data | The raw data block to process |  | tStamp | Timestamp of data - typically samples |  | flags | Indicator flags associated with the data block |  
 
- Returns
- Number of samples actually consumed, use invalidStamp() to indicate that all data was consumed, return zero for consumers that become invalid 
 
 
◆ destroyed()
  
  | 
        
          | virtual void destroyed | ( |  | ) |  |  | virtual | 
 
Destruct notification - complains loudly if still attached to a source 
Reimplemented from RefObject.
 
 
◆ getConnSource()
Get the data source of this object if it's connected 
- Returns
- A pointer to the DataSource object or NULL 
 
 
◆ getObject()
  
  | 
        
          | virtual void * getObject | ( | const String & | name | ) | const |  | virtual | 
 
Get a pointer to a derived class given that class name 
- Parameters
- 
  
    | name | Name of the class we are asking for |  
 
- Returns
- Pointer to the requested class or NULL if this object doesn't implement it 
Reimplemented from RefObject.
Reimplemented in DataTranslator.
 
 
◆ getOverSource()
Get the override data source of this object if it's connected 
- Returns
- A pointer to the DataSource object or NULL 
 
 
◆ getTransSource()
Get the data source of a translator object 
- Returns
- A pointer to the DataSource object or NULL 
Reimplemented in DataTranslator.
 
 
◆ synchronize()
Synchronize the consumer with a source 
- Parameters
- 
  
    | source | Data source to copy the timestamp from |  
 
- Returns
- True if we could synchronize with the source 
Reimplemented in DataTranslator.
 
 
The documentation for this class was generated from the following file: