ADTF
|
Easy data access for input samples of non trivial type @T (see Supported types for adtf_memory<T> for writing and reading Samples). More...
Public Member Functions | |
sample_data () | |
CTOR. | |
sample_data (const sample_data &oSampleData) | |
CTOR. | |
sample_data (sample_data &&oSampleData) | |
move CTOR More... | |
sample_data (const ucom::iobject_ptr< const ant::ISample > &pSample) | |
copy CTOR More... | |
sample_data (const ucom::iobject_ptr< const flash::ISample > &pSample) | |
tTimeStamp | GetTime () const |
retrieves the timestamp of the data. More... | |
adtf::base::flash::tNanoSeconds | GetTimeNs () const |
retrieves the timestamp of the data. More... | |
const T * | GetDataPtr () const |
Retrieves the pointer to the datas memory. More... | |
size_t | GetDataSize () const |
const T * | operator-> () |
Retrieves the pointer to the datas memory. More... | |
const T * | operator-> () const |
Retrieves the pointer to the datas memory. More... | |
const T & | GetData () const |
Retrieves a reference to the data. More... | |
const T & | operator* () const |
Retrieves a reference to the data. More... | |
bool | IsValid () const |
Validate if sample and sample buffer is set. More... | |
operator const T & () const | |
Return the content of sample buffer as a reference to the extracted non trivial value. More... | |
tResult | Reset (const ucom::ant::iobject_ptr< const ant::ISample > &pSample) |
Resets the sample the sample data reference to with a new reference to a sample. More... | |
tResult | Reset () |
Resets the sample the sample data reference to. More... | |
adtf_util::cVariant | GetSampleInfo (const ISampleInfo::tHashKey &oHash, const adtf::util::cVariant oDefault=adtf::util::cVariant()) const |
Retrieves a variant value for the hash key oHash out of the samples sample information . More... | |
Private Attributes | |
ucom::object_ptr< const ant::ISample > | m_pCurrentSample |
ucom::object_ptr_shared_locked< const ISampleBuffer > | m_pBuffer |
T | m_oExtractedValue = {} |
Easy data access for input samples of non trivial type @T (see Supported types for adtf_memory<T> for writing and reading Samples).
This sample_data is for non-trivial types, where a specialization of adtf::base::adtf_memory for type T
exists.
or
T | type of content of the samples sample buffer to get via GetData or sample_data::operator::T |
Definition at line 427 of file sample_data.h.
|
inline |
|
inline |
copy CTOR
pSample | Sample to get the data from |
Definition at line 455 of file sample_data.h.
References sample_data< T, Enable >::Reset().
|
inline |
Retrieves a reference to the data.
Internally it gets the buffer pointer of the sample.
T() | if not valid. |
Definition at line 558 of file sample_data.h.
References sample_data< T, Enable >::IsValid().
Referenced by sample_data< T, Enable >::operator const T &(), and sample_data< T, Enable >::operator*().
|
inline |
Retrieves the pointer to the datas memory.
Internally it gets the buffer pointer of the sample.
nullptr | if no buffer set |
Definition at line 507 of file sample_data.h.
Referenced by sample_data< T, Enable >::operator->().
|
inline |
Definition at line 522 of file sample_data.h.
|
inline |
Retrieves a variant value for the hash key oHash
out of the samples sample information .
If the value does not exists the return value is the given default oDefault
.
[in] | oHash | The hash key of the value. |
[in] | oDefault | default value if value does not exist. |
Definition at line 638 of file sample_data.h.
References adtf::streaming::ant::get_sample_info().
|
inline |
retrieves the timestamp of the data.
Internally it gets the time of the sample.
-1 | if not valid. |
Definition at line 473 of file sample_data.h.
|
inline |
retrieves the timestamp of the data.
Internally it gets the time of the sample.
-1 | if not valid. |
Definition at line 490 of file sample_data.h.
References adtf::streaming::flash::get_sample_time().
|
inline |
Validate if sample and sample buffer is set.
true | is valid |
false | is invalid |
Definition at line 584 of file sample_data.h.
Referenced by sample_data< T, Enable >::GetData().
|
inline |
Return the content of sample buffer as a reference to the extracted non trivial value.
i.e. if using std::string the std::string content was extracted from sample buffer
T() | if no sample buffer set |
Definition at line 596 of file sample_data.h.
References sample_data< T, Enable >::GetData().
|
inline |
Retrieves a reference to the data.
Internally it gets the buffer pointer of the sample.
T() | if not valid. |
Definition at line 574 of file sample_data.h.
References sample_data< T, Enable >::GetData().
|
inline |
Retrieves the pointer to the datas memory.
Internally it gets the buffer pointer of the sample.
nullptr | if no buffer set |
Definition at line 537 of file sample_data.h.
References sample_data< T, Enable >::GetDataPtr().
|
inline |
Retrieves the pointer to the datas memory.
Internally it gets the buffer pointer of the sample.
nullptr | if no buffer set |
Definition at line 545 of file sample_data.h.
References sample_data< T, Enable >::GetDataPtr().
|
inline |
Resets the sample the sample data reference to.
The reference will be empty.
ERR_NOERROR | sample is reset |
Definition at line 623 of file sample_data.h.
References object_ptr< T >::Reset(), and RETURN_NOERROR.
Referenced by sample_data< T, Enable >::sample_data().
|
inline |
Resets the sample the sample data reference to with a new reference to a sample.
pSample | [in] Reference to the sampel the sample data will reference to |
ERR_NOERROR | sample is reset |
Definition at line 608 of file sample_data.h.
References RETURN_IF_FAILED, and RETURN_NOERROR.