Public Member Functions
	ADTF_IID (ISampleInfo, "sampleinfo.ant.streaming.adtf.iid")
	definiton of interface id

Public Member Functions inherited from adtf::base::ant::IHashValueMap
virtual bool	Exists (const tHashKey &oKey) const =0

virtual tResult	Get (IHashValueMap &oHashMap) const =0

virtual tResult	GetValue (const tHashKey &oHashKey, IHashValueMapValue &oValue) const =0

virtual tResult	SetValue (const tHashKey &oHashKey, const IHashValueMapValue &oValue)=0

virtual bool	IsEmpty () const =0

virtual void	Reset ()=0

virtual uint8_t	GetRawMemoryLayoutVersion () const =0

Public Member Functions inherited from adtf::base::ant::IRawValue
virtual tResult	FromRaw (const IRawMemory &oRawValue)=0

virtual tResult	ToRaw (IRawMemory &&oRawValue) const =0

Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Static Public Attributes
static constexpr tHashKey	SAI_DeviceOriginalTime = 1851393682

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

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 adtf::base::ant::IHashValueMap
virtual	~IHashValueMap ()=default
	protected DTOR

Protected Member Functions inherited from adtf::base::ant::IRawValue
virtual	~IRawValue ()=default
	protected DTOR

Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Additional Inherited Members
Public Types inherited from adtf::base::ant::IHashValueMap
using	tHashKey = adtf::util::cStringUtil::tHashKey32
	Type for the HashKey of the Value.

Detailed Description

Interface for additional sample information on a sample sinfo. 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

Member Data Documentation

tHashKey adtf::streaming::ant::ISampleInfo::SAI_Counter = 1660111993

staticconstexpr

A Counter Hash Key to set as additional sample information. generated value for ISampleInfo::SAI_Counter_String

tHashKey adtf::streaming::ant::ISampleInfo::SAI_DeviceOriginalTime = 1851393682

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

The documentation for this class was generated from the following file: