Base class for all data streams compatible with the data stream instrument's data class DataStreamInstrumentData
.
More...
|
Override by derived classes.
|
virtual bool | IsBasicSampleConvertible () const noexcept |
| Determines whether the data stream holds samples which are compatible to BasicSample . More...
|
|
virtual bool | IsBasicSampleTimeUsed () const noexcept |
| Determines whether the data stream holds basic samples (IsBasicSampleConvertible() returns true) which contain information in their BasicSample::Time fields. More...
|
|
virtual void | SeekBeg (std::ios_base::openmode Which=std::ios_base::in|std::ios_base::out)=0 |
| Moves the read/write pointer to the first sample in the stream. More...
|
|
virtual void | SeekEnd (std::ios_base::openmode Which=std::ios_base::in|std::ios_base::out)=0 |
| Moves the read pointer to the last sample in the stream and/or moves the write pointer after the last written sample in the stream. More...
|
|
virtual bool | SeekEqual (std::ios_base::openmode Which=std::ios_base::in|std::ios_base::out)=0 |
| Moves the read/write pointer to the respective other one. More...
|
|
virtual size_t | GetStreamSizeRead () const noexcept=0 |
| Determines the stream's read buffer size in samples. More...
|
|
virtual size_t | GetStreamSizeWrite () const noexcept=0 |
| Determines the stream's write buffer size in samples. More...
|
|
virtual size_t | GetNumSamplesWritten () const noexcept=0 |
| Determines the number of samples which have been written to the stream in total. Before overflowing, this function should keep continuing to return the largest possible value. More...
|
|
virtual void | SetStreamSize (size_t BufferSizeInSamples)=0 |
| Sets the stream size in samples. More...
|
|
virtual void | WriteBasicSampleChild (const BasicSample &Sample) |
| Writes a single basic sample to the stream. More...
|
|
virtual BasicSample | ReadBasicSampleChild () |
| Reads a single basic sample from the stream. More...
|
|
virtual void | ClearChild ()=0 |
| Removes all samples from the stream's buffer. More...
|
|
Base class for all data streams compatible with the data stream instrument's data class DataStreamInstrumentData
.
Definition at line 115 of file DataStreamInstrument.h.
◆ BasicSampleListType
◆ ~DataStreamBase()
virtual DynExpInstr::DataStreamBase::~DataStreamBase |
( |
| ) |
|
|
virtualdefault |
◆ CanRead()
bool DynExpInstr::DataStreamBase::CanRead |
( |
| ) |
const |
|
inline |
Determines whether the stream contains at least one sample which can be read (i.e. GetStreamSizeRead()
returns a value greater than 0).
- Returns
- Returns true if there is a sample to read, false otherwise.
Definition at line 201 of file DataStreamInstrument.h.
◆ Clear()
void DynExpInstr::DataStreamBase::Clear |
( |
| ) |
|
|
inline |
◆ ClearChild()
virtual void DynExpInstr::DataStreamBase::ClearChild |
( |
| ) |
|
|
privatepure virtual |
◆ GetNumSamplesWritten()
virtual size_t DynExpInstr::DataStreamBase::GetNumSamplesWritten |
( |
| ) |
const |
|
pure virtualnoexcept |
◆ GetStreamSizeRead()
virtual size_t DynExpInstr::DataStreamBase::GetStreamSizeRead |
( |
| ) |
const |
|
pure virtualnoexcept |
◆ GetStreamSizeWrite()
virtual size_t DynExpInstr::DataStreamBase::GetStreamSizeWrite |
( |
| ) |
const |
|
pure virtualnoexcept |
◆ IsBasicSampleConvertible()
virtual bool DynExpInstr::DataStreamBase::IsBasicSampleConvertible |
( |
| ) |
const |
|
inlinevirtualnoexcept |
◆ IsBasicSampleTimeUsed()
virtual bool DynExpInstr::DataStreamBase::IsBasicSampleTimeUsed |
( |
| ) |
const |
|
inlinevirtualnoexcept |
◆ ReadBasicSample()
BasicSample DynExpInstr::DataStreamBase::ReadBasicSample |
( |
| ) |
|
|
inline |
◆ ReadBasicSampleChild()
BasicSample DynExpInstr::DataStreamBase::ReadBasicSampleChild |
( |
| ) |
|
|
privatevirtual |
◆ ReadBasicSamples()
◆ SeekBeg()
virtual void DynExpInstr::DataStreamBase::SeekBeg |
( |
std::ios_base::openmode |
Which = std::ios_base::in|std::ios_base::out | ) |
|
|
pure virtual |
◆ SeekEnd()
virtual void DynExpInstr::DataStreamBase::SeekEnd |
( |
std::ios_base::openmode |
Which = std::ios_base::in|std::ios_base::out | ) |
|
|
pure virtual |
◆ SeekEqual()
virtual bool DynExpInstr::DataStreamBase::SeekEqual |
( |
std::ios_base::openmode |
Which = std::ios_base::in|std::ios_base::out | ) |
|
|
pure virtual |
◆ SetStreamSize()
virtual void DynExpInstr::DataStreamBase::SetStreamSize |
( |
size_t |
BufferSizeInSamples | ) |
|
|
pure virtual |
◆ WriteBasicSample()
void DynExpInstr::DataStreamBase::WriteBasicSample |
( |
const BasicSample & |
Sample | ) |
|
|
inline |
◆ WriteBasicSampleChild()
void DynExpInstr::DataStreamBase::WriteBasicSampleChild |
( |
const BasicSample & |
Sample | ) |
|
|
privatevirtual |
◆ WriteBasicSamples()
Writes a list of basic sample to the stream.
- Parameters
-
Samples | List of samples to write |
Definition at line 17 of file DataStreamInstrument.cpp.
The documentation for this class was generated from the following files: