workspace/conan/dev_essential/1.3.3/dw/stable/package/37682420cd166e229516a41c8d6a139a0b13e1e1/include/ddl/codec/legacy/access_element.h File Reference

Access Element legacy API header for old legacy Codec API. More...

Go to the source code of this file.

Namespaces
	ddl
	definition of the ddl namespace
	ddl::access_element
	definition of the access_element namespace (codecs)

Macros
#define	DDL_GET_ENUM_CASE(__variant_type, __data_type)
	For internal use only. More...

Functions
template<typename T >
a_util::result::Result	findIndex (const T &decoder, const std::string &element_name, size_t &index)
	find the index of an element by name. More...
template<typename T >
a_util::result::Result	findStructIndex (const T &decoder, const std::string &struct_name, size_t &index)
	find the index of the first element of a sub-structure by name. More...
template<typename T >
a_util::result::Result	findArrayIndex (const T &decoder, const std::string &array_name, size_t &index)
	find the index of the first element of an array by name. More...
template<typename T >
a_util::result::Result	findArrayEndIndex (const T &decoder, const std::string &array_name, size_t &index)
	find the index of the first element after an array by name. More...
template<typename T >
a_util::result::Result	getValue (const T &decoder, const std::string &element_name, void *value)
	Get the value of an element by name. More...
template<typename T >
a_util::result::Result	setValue (T &codec, const std::string &element_name, const void *value)
	Set the value of an element by name. More...
template<typename T >
a_util::variant::Variant	getValue (const T &decoder, const std::string &element_name)
	Get the value of an element by name. More...
template<typename T >
a_util::result::Result	setValue (T &codec, const std::string &element_name, const a_util::variant::Variant &value)
	Set the value of an element by name. More...
template<typename T >
a_util::variant::Variant	getValue (const T &decoder, size_t element_index)
	Get the value of an element by index. More...
template<typename T >
const void *	getValueAddress (const T &decoder, const std::string &element_name)
	Get a pointer to an element by name. More...
template<typename T >
void *	getValueAddress (T &codec, const std::string &element_name)
	Get a pointer to an element by name. More...
template<typename STRUCT , typename T >
const STRUCT *	getStructAddress (const T &decoder, const std::string &struct_name)
	Get a pointer to a sub-structure by name. More...
template<typename STRUCT , typename T >
STRUCT *	getStructAddress (T &codec, const std::string &struct_name)
	Get a pointer to a sub-structure by name. More...
template<typename T , typename CODEC >
a_util::result::Result	getStructValue (const CODEC &decoder, const std::string &struct_name, T *struct_value)
	Copy a sub-structure out of the structure. More...
template<typename T , typename CODEC >
a_util::result::Result	setStructValue (CODEC &codec, const std::string &struct_name, const T *struct_value)
	Copy a sub-structure into the structure. More...
template<typename ARRAY_TYPE , typename T >
const ARRAY_TYPE *	getArrayAddress (const T &decoder, const std::string &array_name)
	Get a pointer to an array by name. More...
template<typename ARRAY_TYPE , typename T >
ARRAY_TYPE *	getArrayAddress (T &codec, const std::string &array_name)
	Get a pointer to an array by name. More...
template<typename CODEC >
a_util::result::Result	getArray (const CODEC &decoder, const std::string &array_name, const void *&start_address, size_t &size)
	Get information about an array. More...
template<typename T , typename CODEC >
a_util::result::Result	getArrayValue (const CODEC &decoder, const std::string &array_name, T *array_value)
	Copy an array out of the structure. More...
template<typename T >
a_util::result::Result	reset (T &codec, const std::string &element_name)
	Set the value of the requested element to zero. More...
template<typename T >
std::string	getValueAsString (const T &decoder, size_t element_index)
	Get the value of an element as a string, using enum value names if available. More...
template<typename T >
std::string	getValueAsString (const T &decoder, const std::string &element_name)
	Get the value of an element as a string, using enum value names if available. More...

Detailed Description

Access Element legacy API header for old legacy Codec API.

Copyright

Copyright @ 2023 VW Group. 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/.

Definition in file workspace/conan/dev_essential/1.3.3/dw/stable/package/37682420cd166e229516a41c8d6a139a0b13e1e1/include/ddl/codec/legacy/access_element.h.

Macro Definition Documentation

DDL_GET_ENUM_CASE

#define DDL_GET_ENUM_CASE	(		__variant_type,
			__data_type
	)

Value:

    case a_util::variant::VT_##__variant_type: {                                                   \
        __data_type xValue = value.get##__variant_type();                                          \
        for (AccessEnumType::const_iterator it = element->p_enum->begin();                         \
             it != element->p_enum->end();                                                         \
             ++it) {                                                                               \
            if (xValue == it->second.as##__variant_type()) {                                       \
                return it->first;                                                                  \
            }                                                                                      \
        }                                                                                          \
        break;                                                                                     \
    }

For internal use only.

Definition at line 491 of file workspace/conan/dev_essential/1.3.3/dw/stable/package/37682420cd166e229516a41c8d6a139a0b13e1e1/include/ddl/codec/legacy/access_element.h.