Interface for additional sample information on a Additional Sample Information. More...
Public Member Functions | |
| ADTF_IID (ISampleInfo, "sampleinfo.ant.streaming.adtf.iid") | |
| definiton of interface id | |
 Public Member Functions inherited from IHashValueMap | |
| virtual bool | Exists (const tHashKey &oKey) const =0 |
Tests is a value for the oKey exists. More... | |
| virtual tResult | Get (IHashValueMap &oHashMap) const =0 |
Copy operation to the oHashMap. More... | |
| virtual tResult | GetValue (const tHashKey &oHashKey, IHashValueMapValue &oValue) const =0 |
Retrieves the value for the hash key oHashKey to oValue if exists. More... | |
| virtual tResult | SetValue (const tHashKey &oHashKey, const IHashValueMapValue &oValue)=0 |
Sets or resets the value for the hash key oHashKey as copy of oValue. More... | |
| virtual bool | IsEmpty () const =0 |
| Tests if value map is empty. More... | |
| virtual void | Reset ()=0 |
| Clears the value map. | |
| virtual uint8_t | GetRawMemoryLayoutVersion () const =0 |
| Return the Version of the memory layout used to store the values. More... | |
| Public Member Functions inherited from IRawValue | |
| virtual tResult | FromRaw (const IRawMemory &oRawValue)=0 |
| Implement to create a fast value copy in memory. More... | |
| virtual tResult | ToRaw (IRawMemory &&oRawValue) const =0 |
| Implement to create a fast value copy in memory. More... | |
| Public Member Functions inherited from IObject | |
| ADTF_IID (IObject, "object.ant.ucom.adtf.iid") | |
Marks the IObject to be castable with the ucom_cast() More... | |
Static Public Attributes | |
| static constexpr tHashKey | SAI_DeviceOriginalTime = 1851393682 |
| The hardware time or device time hash key as additional sample information hash key. More... | |
| static constexpr const char *const | SAI_DeviceOriginalTime_String = "DeviceOriginalTime" |
| String value to generate ISampleInfo::SAI_DeviceOriginalTime by ant::create_sample_info_hash_key. | |
| static constexpr tHashKey | SAI_Counter = 1660111993 |
| A Counter Hash Key to set as additional sample information. More... | |
| static constexpr const char *const | SAI_Counter_String = "Counter" |
| String value to generate ISampleInfo::SAI_Counter by ant::create_sample_info_hash_key. | |
Protected Member Functions | |
| ~ISampleInfo ()=default | |
| not destructable | |
| Protected Member Functions inherited from IHashValueMap | |
| virtual | ~IHashValueMap ()=default |
| protected DTOR | |
| Protected Member Functions inherited from IRawValue | |
| virtual | ~IRawValue ()=default |
| protected DTOR | |
| Protected Member Functions inherited from IObject | |
| ~IObject ()=default | |
| Protected destructor --> Use implemented Destroy() instead of delete! | |
Additional Inherited Members | |
| Public Types inherited from IHashValueMap | |
| using | tHashKey = adtf::util::cStringUtil::tHashKey32 |
| Type for the HashKey of the Value. | |
Detailed Description
Interface for additional sample information on a Additional Sample Information.
This interface can be retrieved via ISample::GetSampleInfo.
The sample information used a hashed value store to set and retrieve values on samples via a hash key. The hash can be generated by ant::create_sample_info_hash_key.
See enumeration base::ant::IHashValueMapValue::tType for possible types.
- Remarks
- The value store is only able to manage non-literal types which memory representation is not greater than 8 bytes!
This interface should only be used to add additional information within the Sample.
- See also
- base::ant::IHashValueMap, base::ant::IHashValueMapValue, ISample, set_sample_info, get_sample_info
Definition at line 33 of file sampleinfo_intf.h.
Member Data Documentation
◆ SAI_Counter
|
staticconstexpr |
A Counter Hash Key to set as additional sample information.
generated value for ISampleInfo::SAI_Counter_String
Definition at line 53 of file sampleinfo_intf.h.
◆ SAI_DeviceOriginalTime
|
staticconstexpr |
The hardware time or device time hash key as additional sample information hash key.
While using this a microseconds-value-resolution should be used Generated value for ISampleInfo::SAI_DeviceOriginalTime_String by ant::create_sample_info_hash_key
Definition at line 47 of file sampleinfo_intf.h.