ADTF  3.14.3
StaticDecoder

Decoder for static structures defined by a DataDefinition definition. More...

Inheritance diagram for StaticDecoder:
[legend]

Public Member Functions

 StaticDecoder ()=default
 Default constructor.
 
 StaticDecoder (const StaticDecoder &)=delete
 Noncopyable.
 
StaticDecoderoperator= (const StaticDecoder &)=delete
 Noncopyable.
 
 StaticDecoder (StaticDecoder &&)=default
 Move constructor.
 
StaticDecoderoperator= (StaticDecoder &&)=default
 Move assignment operator.
 
virtual a_util::result::Result isValid () const
 
virtual size_t getElementCount () const
 
a_util::result::Result getElement (size_t index, const StructElement *&element) const
 Access information about an element. More...
 
a_util::result::Result getElementValue (size_t index, void *value) const
 Returns the current value of the given element by copying its data to the passed-in location. More...
 
a_util::result::Result getElementValue (size_t index, a_util::variant::Variant &value) const
 Returns the current value of the given element as a variant. More...
 
const void * getElementAddress (size_t index) const
 
size_t getStaticBufferSize (DataRepresentation rep=deserialized) const
 
DataRepresentation getRepresentation () const
 

Protected Member Functions

 StaticDecoder (a_util::memory::shared_ptr< const StructLayout > layout, const void *data, size_t data_size, DataRepresentation rep)
 For internal use only.
 
virtual const StructLayoutElement * getLayoutElement (size_t index) const
 For internal use only.
 

Protected Attributes

a_util::memory::shared_ptr< const StructLayout > _layout
 For internal use only.
 
const void * _data
 For internal use only.
 
size_t _data_size
 For internal use only.
 
const ElementAccessor * _element_accessor
 For internal use only.
 

Detailed Description

Member Function Documentation

◆ getElement()

a_util::result::Result getElement ( size_t  index,
const StructElement *&  element 
) const

Access information about an element.

Parameters
[in]indexThe index of the element.
[out]elementPointer that will be updated to point to the element information.
Return values
ERR_INVALID_INDEXInvalid element index.

◆ getElementAddress()

const void* getElementAddress ( size_t  index) const
Parameters
[in]indexThe index of the element.
Returns
A pointer to the element or NULL in case of an error.

◆ getElementCount()

virtual size_t getElementCount ( ) const
virtual
Returns
The amount of elements contained in the data structure.

Reimplemented in Decoder.

◆ getElementValue() [1/2]

a_util::result::Result getElementValue ( size_t  index,
a_util::variant::Variant value 
) const

Returns the current value of the given element as a variant.

Parameters
[in]indexThe index of the element.
[out]valueThe will be set to the current value.
Return values
ERR_INVALID_INDEXInvalid element index.

◆ getElementValue() [2/2]

a_util::result::Result getElementValue ( size_t  index,
void *  value 
) const

Returns the current value of the given element by copying its data to the passed-in location.

Parameters
[in]indexThe index of the element.
[out]valueThe location where the value should be copied to.
Return values
ERR_INVALID_INDEXInvalid element index.

◆ getRepresentation()

DataRepresentation getRepresentation ( ) const
Returns
The data representation which this decoder handles.

◆ getStaticBufferSize()

size_t getStaticBufferSize ( DataRepresentation  rep = deserialized) const
Parameters
[in]repThe data representation for which the buffer size should be returned.
Returns
The size of the structure in the requested data representation.

◆ isValid()

virtual a_util::result::Result isValid ( ) const
virtual
Returns
Whether or not the decoder is valid.
Return values
ERR_INVALID_ARGThe passed data is not large enough.

Reimplemented in Decoder.


Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Thu Jun 9 2022 by doxygen 1.9.1)