#include <yatephone.h>
|
unsigned long | m_nextStamp |
|
ObjList | m_consumers |
|
DataFormat | m_format |
|
unsigned long | m_timestamp |
|
◆ DataSource()
Source constructor
- Parameters
-
format | Name of the data format, default "slin" (Signed Linear) |
◆ attach()
bool attach |
( |
DataConsumer * | consumer, |
|
|
bool | override = false ) |
Attach a data consumer
- Parameters
-
consumer | Data consumer to attach |
override | Attach as temporary source override |
- Returns
- True on success, false on failure
◆ clear()
Detach all data consumers
◆ control()
Modify source parameters, calls translator if one is set
- Parameters
-
params | The list of parameters to change |
- Returns
- True if processed
Reimplemented from DataNode.
◆ destroyed()
virtual void destroyed |
( |
| ) |
|
|
virtual |
Source's destruct notification - detaches all consumers
Reimplemented from RefObject.
Reimplemented in ThreadedSource.
◆ detach()
Detach a data consumer
- Parameters
-
consumer | Data consumer to detach |
- Returns
- True on success, false on failure
◆ Forward()
unsigned long Forward |
( |
const DataBlock & | data, |
|
|
unsigned long | tStamp = invalidStamp(), |
|
|
unsigned long | flags = 0 ) |
Forwards the data to its consumers
- Parameters
-
data | The raw data block to forward |
tStamp | Timestamp of data - typically samples |
flags | Indicator flags associated with the data block |
- Returns
- Number of samples actually forwarded to all consumers
◆ 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.
◆ getTranslator()
Get the master translator object if this source is part of a translator
- Returns
- A pointer to the DataTranslator object or NULL
◆ nextStamp()
unsigned long nextStamp |
( |
| ) |
const |
|
inline |
Get the next expected position in the data stream
- Returns
- Timestamp of next expected data position, may be invalid/unknown
◆ synchronize()
void synchronize |
( |
unsigned long | tStamp | ) |
|
Synchronize the source and attached consumers with another timestamp
- Parameters
-
tStamp | New timestamp of data - typically samples |
◆ valid()
virtual bool valid |
( |
| ) |
const |
|
virtual |
Check if this data source is still valid
- Returns
- True if still valid, false if node should be removed
Reimplemented from DataNode.
Referenced by DataTranslator::valid().
The documentation for this class was generated from the following file: