cSampleWithCodec

Helper class that combines a Sample Codec with a Sample instance. More...

Inheritance diagram for cSampleWithCodec:

Public Member Functions
	cSampleWithCodec ()=default
	Default Constructor -> invalid object.
	cSampleWithCodec (cSampleCodec &&oCodec, const ucom::ant::iobject_ptr< const streaming::ant::ISample > &pSample)
	Constructor that initializes a valid object. More...
	cSampleWithCodec (cSampleWithCodec &&)=default
cSampleWithCodec &	operator= (cSampleWithCodec &&)=default
ucom::ant::object_ptr< const streaming::ant::ISample >	Release ()
	Retrieve the sample instance. More...
Public Member Functions inherited from cSampleCodec
	cSampleCodec ()
	Default constructor.
	cSampleCodec (cSampleCodec &&)
	Move constructor.
cSampleCodec &	operator= (cSampleCodec &&)
	Move assignment operator.
template<typename T >
void	SetElementValue (const tCodecIndex &oCodecIndex, const T &oValue)
	Sets the elements value from the given oValue. More...
template<typename T >
void	SetElementValue (const tLeafCodecIndex &oLeafCodecIndex, const T &oValue)
	Sets the elements value from the given oValue. More...
void	SetElementVariantValue (const tCodecIndex &oCodecIndex, const a_util::variant::Variant &oValue)
	Sets the current value of the given element from the given variant. More...
void	SetElementStringValue (const tCodecIndex &oCodecIndex, const std::string &strValue)
	Sets the current value of the given element from the given string. More...
void	SetElementRawValue (const tCodecIndex &oCodecIndex, const void *pValue, size_t szValueSize)
	Sets the elements value by copy the memory from pValue. More...
void *	GetElementAddress (const tCodecIndex &oCodecIndex)
	Gets the elements value memory pointer into the given data for writig access. More...
tElement	GetElement (const tCodecIndex &oCodecIndex)
	Retrieves an element for the codec index. More...
tElement	GetElement (const std::string &strElementFullName)
	Retrieves an element for the given name. More...
tElements &	GetElements ()
	Retrieves the elements of the codec to get element information, to get and set the values. More...
void *	GetElementAddress (const std::string &strElementFullName)
	Gets the elements value memory pointer into the given data for writing access. More...
size_t	GetBufferSize () const
	Gets the buffer size in bytes for the main structure. More...
size_t	GetBufferSize (ddl::tDataRepresentation eRep) const
	Gets the buffer size in bytes for the main structure. More...
const void *	GetData () const
	Get the current data pointer. More...
void *	GetData ()
	Get the current data pointer for writing access. More...
size_t	GetDataSize () const
	Get the current data size. More...
tElement	GetElement (const tCodecIndex &oCodecIndex) const
	Retrieves an element for the codec index. More...
tElement	GetElement (const std::string &strElementFullName) const
	Retrieves an element for the given name. More...
const tElements &	GetElements () const
	Retrieves the elements of the decoder to get element information and the values. More...
const void *	GetElementAddress (const tCodecIndex &oCodecIndex) const
	Gets the elements value memory pointer into the given data. More...
Public Member Functions inherited from cSampleDecoderBase
	cSampleDecoderBase (cSampleDecoderBase &&)
cSampleDecoderBase &	operator= (cSampleDecoderBase &&)
tResult	IsValid () const
	Returns the validation state of the coder. More...
tElement	GetElement (const tCodecIndex &oCodecIndex) const
	Retrieves an element for the codec index. More...
tElement	GetElement (const std::string &strElementFullName) const
	Retrieves an element for the given name. More...
const tElements &	GetElements () const
	Retrieves the elements of the decoder to get element information and the values. More...
size_t	GetElementChildCount (const tCodecIndex &oCodecIndex) const
	Retrieves the amount of child elements for the given codec index. More...
std::string	GetElementFullName (const tCodecIndex &oCodecIndex) const
	Retrieves the full name of the element within its main structure. More...
std::string	GetElementName (const tCodecIndex &oCodecIndex) const
	Retrieves the name of the element within its structured element. More...
const std::string &	GetElementBaseName (const tCodecIndex &oCodecIndex) const
	Retrieves the base name of the element within its structured element. More...
size_t	GetStaticBufferSize () const
	Gets the static buffer size in bytes for the main structure. More...
size_t	GetStaticBufferSize (ddl::tDataRepresentation oRep) const
	Gets the static buffer size in bytes for the main structure. More...
ddl::tDataRepresentation	GetRepresentation () const
	Returns the current data representation the decoder decodes from. More...
template<typename T >
T	GetElementValue (const tCodecIndex &oCodecIndex) const
	Gets the elements value as value of type T. More...
template<typename T >
T	GetElementValue (const penguin::tLeafCodecIndex &oLeafCodecIndex) const
	Gets the elements value as value of type T. More...
a_util::variant::Variant	GetElementVariantValue (const tCodecIndex &oCodecIndex) const
	Returns the current value of the given element as a variant. More...
void	GetElementVariantValue (const tCodecIndex &oCodecIndex, a_util::variant::Variant &oValue) const
	Returns the current value of the given element as a variant. More...
std::string	GetElementStringValue (const tCodecIndex &oCodecIndex) const
	Returns the current value of the given element as a string. More...
void	GetElementRawValue (const tCodecIndex &oCodecIndex, void *pValue, size_t szValueSize) const
	Copies the elements value to the given memory pointer in @pValue. More...
const void *	GetElementAddress (const tCodecIndex &oCodecIndex) const
	Gets the elements value memory pointer into the given data. More...
void	Resolve (tCodecIndex &oCodecIndex) const
	retrieves the lyoutinformation for the given codec index. More...
Public Member Functions inherited from cDecoderLegacy
tCodecIndex	Resolve (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Retrieves a codec index with element information for the given leaf index. More...
adtf_util::cVariant	GetElementValue (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element Value. More...
tResult	GetElementValue (tCodecLeafIndex nElementLeafIndex, adtf_util::cVariant &oValue) const
	Legacy: Get the Element Value. More...
tResult	GetElementValue (const char *strElementName, adtf_util::cVariant &oValue) const
	Legacy: Get the Element Value. More...
tResult	GetElementValue (tCodecLeafIndex nElementLeafIndex, void *pValue) const
	Legacy: Copies the Element Value memory into the memory pointer. More...
tResult	GetElementValue (const char *strElementName, void *pValue) const
	Legacy: Get the Element Value pointer. More...
adtf_util::cString	GetElementValueString (tCodecLeafIndex nElementLeafIndex) const
	Legacy: Get the Element Value as string (resolved to the enum element name if is enum type) More...
tResult	GetElement (tCodecLeafIndex nElementLeafIndex, const ddl::StructElement *&pElement) const
	Get the Element StructElement information. More...
const void *	GetElementAddress (tCodecLeafIndex nElementIndex) const
	Legacy: Get the Element StructElement information. More...
size_t	GetElementCount () const
	Legacy: Get the Element Leaf count. More...
Public Member Functions inherited from cCodecLegacy< ddl::codec::Codec >
tResult	SetElementValue (tCodecLeafIndex nElementLeafIndex, const adtf_util::cVariant &oValue)
	Legacy: Set the Element Value. More...
tResult	SetElementValue (const char *strElementName, const adtf_util::cVariant &oValue)
	Legacy: Set the Element Value. More...
void *	GetElementAddress (tCodecLeafIndex nElementLeafIndex)
	Legacy:Get the Element Address object. More...

Private Attributes
ucom::ant::object_ptr< const streaming::ant::ISample >	m_pSample

Additional Inherited Members
Public Types inherited from cSampleCodec
typedef ddl::codec::CodecElement< sample_codec_access< cSampleCodec > >	tElement
	Iterator value element type for the codec to get value, set value and get element information. More...
typedef ddl::codec::ChildElements< sample_codec_access< cSampleCodec > >	tElements
	Iterator container to iterate all elements of the codec. More...
Public Types inherited from cSampleDecoderBase
typedef ddl::codec::DecoderElement< sample_decoder_access< const cSampleDecoderBase > >	tElement
	Iterator value element type for the codec to get value, set value and get element information. More...
typedef ddl::codec::ChildElements< sample_decoder_access< const cSampleDecoderBase > >	tElements
	Iterator container to iterate all elements of the decoder. More...
Public Types inherited from cDecoderLegacy
typedef ddl::StructElement	DefinedStructElementType
	type definition for the old access_element API.
Static Public Member Functions inherited from cDecoderLegacy
static const char *	GetStructElementName (const ddl::StructElement *pElement)
	Legacy: Get the Struct Element Name for access_element legacy support. More...
Protected Member Functions inherited from cSampleDecoderBase
void	ResetFirst ()

Detailed Description

Helper class that combines a Sample Codec with a Sample instance.

Definition at line 160 of file codec_sample_streamer.h.

Constructor & Destructor Documentation

cSampleWithCodec()

cSampleWithCodec	(	cSampleCodec &&	oCodec,
		const ucom::ant::iobject_ptr< const streaming::ant::ISample > &	pSample
	)

Constructor that initializes a valid object.

Parameters

[in]	oCodec	The codec the encodes values into the sample.
[in]	pSample	The sample.

Member Function Documentation

Release()

ucom::ant::object_ptr<const streaming::ant::ISample> Release

(

)

Retrieve the sample instance.

Call this when you're done updating the sample data in order to write it via streaming::flash::ISampleWriter::Write.

Do not call any other methods of the object after you have called this method.

Returns

A Pointer to the sample.

Referenced by encoding_sample_writer< WriterImplementation >::Write().