Sample Data getter for an easy use of samples with samplebuffer set to the type T.
More...
template<typename T>
class adtf::streaming::ant::sample_data< T >
Sample Data getter for an easy use of samples with samplebuffer set to the type T.
- Template Parameters
-
T | type of content of the samples sample buffer to get via GetData or sample_data::operator::T |
Please use the newer versions (adtf::streaming::flash::sample_data) from the flash namespace.
- See also
- adtf::streaming::flash::sample_data
-
adtf::streaming::flash::output_sample_data
Definition at line 166 of file sample.h.
◆ sample_data() [1/2]
◆ sample_data() [2/2]
copy CTOR
- Parameters
-
pSample | Sample to get the data from |
Definition at line 190 of file sample.h.
◆ GetData()
const T GetData |
( |
| ) |
const |
|
inline |
Retrieves the pointer to the datas memory as type T*.
Internally it gets the buffer pointer of the sample.
- Returns
- returns the pointer to the sample data.
- Return values
-
Definition at line 234 of file sample.h.
◆ GetDataPtr()
const T* GetDataPtr |
( |
| ) |
const |
|
inline |
Retrieves the pointer to the datas memory.
Internally it gets the buffer pointer of the sample.
- Returns
- returns the pointer to the sample data.
- Return values
-
Definition at line 218 of file sample.h.
◆ GetTime()
tTimeStamp GetTime |
( |
| ) |
const |
|
inline |
retrieves the time of the data.
Internally it gets the time of the sample.
- Returns
- returns the sample data time
- Return values
-
Definition at line 202 of file sample.h.
◆ IsValid()
Validate if sample and sample buffer is set.
- Return values
-
true | is valid |
false | is invalid |
Definition at line 250 of file sample.h.
◆ operator bool()
Validate if sample and sample buffer is set.
- Return values
-
true | is valid |
false | is invalid |
Definition at line 259 of file sample.h.
◆ operator T()
Convert the content of sample buffer as.
- Returns
- the value of the sample buffer as T
- Return values
-
T() | if no sample buffer set |
- See also
- IsValid
Definition at line 269 of file sample.h.
◆ Reset() [1/2]
Resets the sample the sample data reference to.
The reference will be empty.
- Returns
- standard result
- Return values
-
ERR_NOERROR | sample is reset |
- See also
- IsValid
Definition at line 298 of file sample.h.
References object_ptr< T >::Reset().
◆ Reset() [2/2]
Resets the sample the sample data reference to with a new reference to a sample.
- Parameters
-
pSample | [in] Reference to the sampel the sample data will reference to |
- Returns
- standard result
- Return values
-
ERR_NOERROR | sample is reset |
- See also
- IsValid
Definition at line 285 of file sample.h.
References RETURN_IF_FAILED.
Referenced by adtf::streaming::ant::operator>>().