ddl/codec/struct_element.h

116 lines
2.6 KiB
C
Raw Normal View History

2019-12-12 13:41:47 +00:00
/**
* @file
* Implementation of the ADTF default media description.
*
* @copyright
* @verbatim
Copyright @ 2017 Audi Electronics Venture GmbH. All rights reserved.
This Source Code Form is subject to the terms of the Mozilla
Public License, v. 2.0. If a copy of the MPL was not distributed
with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular file, then
You may include the notice in a location (such as a LICENSE file in a
relevant directory) where a recipient would be likely to look for such a notice.
You may add additional accurate notices of copyright ownership.
@endverbatim
*/
#ifndef DDL_STRUCT_ELEMENT_CLASS_HEADER
#define DDL_STRUCT_ELEMENT_CLASS_HEADER
#include <map>
#include <string>
#include "a_util/variant.h"
#include "a_util/result.h"
namespace ddl
{
/**
* Enumeration for the data representation
*/
enum DataRepresentation
{
serialized, ///< serialized data, i.e network, on disks, can msgs, ...
deserialized ///< deserialized data, c-structs, arrays, ...
};
/**
* Typedef for enumerations name -> value.
*/
typedef std::map<std::string, a_util::variant::Variant> EnumType;
/**
* Information about an element accessible with a decoder or codec.
*/
struct StructElement
{
std::string name; ///< The full name of the element.
a_util::variant::VariantType type; ///< The type of the element.
const EnumType* p_enum; ///< pointer to an enum, can be NULL.
};
// The following classes are for internal use only
/**
* \cond INTERNAL
*/
struct Position
{
size_t bit_offset;
size_t bit_size;
};
struct StructLayoutElement: public StructElement
{
Position deserialized;
Position serialized;
int byte_order;
const a_util::variant::Variant* constant;
};
struct DynamicStructLayoutElement
{
std::string name;
size_t alignment;
std::string size_element_name;
std::vector<StructLayoutElement> static_elements;
std::vector<DynamicStructLayoutElement> dynamic_elements;
DynamicStructLayoutElement() = default;
DynamicStructLayoutElement(size_t alignment):
alignment(alignment)
{
}
bool isAlignmentElement() const
{
return name.empty();
}
bool isDynamicArray() const
{
return !size_element_name.empty();
}
};
struct Offsets
{
size_t deserialized;
size_t serialized;
};
/**
* \endcond INTERNAL
*/
}
#endif