ADTF  3.18.2
StructElementLegacy< AccessType >

Legacy helper for the ddl::StructElement. More...

Public Member Functions

const ddl::StructElementgetStructElement () const
 Get the converted StructElement pointer. More...
 
const ddl::StructElementgetStructElement (const AccessType &access, size_t leaf_index) const
 Fill the local Struct Element and retrieves the Struct Element pointer for legacy. More...
 
a_util::result::Result getStructElement (const AccessType &access, size_t leaf_index, const ddl::StructElement *&struct_element) const
 Fill the local Struct Element and retrieves the Struct Element pointer for legacy in struct_element. More...
 

Private Attributes

ddl::StructElement _legacy_struct_element = {}
 

Detailed Description

template<typename AccessType>
class ddl::access_element::StructElementLegacy< AccessType >

Legacy helper for the ddl::StructElement.

Template Parameters
AccessTypeThe type to get the ElementLayout from to convert to the ddl::StructElement structure.

Definition at line 35 of file access_element_legacy.h.

Member Function Documentation

◆ getStructElement() [1/3]

const ddl::StructElement* getStructElement ( ) const
inline

Get the converted StructElement pointer.

Remarks
The content of this pointer is only valid as long as no other getStructElement call
Returns
const ddl::StructElement*

Definition at line 42 of file access_element_legacy.h.

Referenced by StructElementLegacy< AccessType >::getStructElement().

◆ getStructElement() [2/3]

const ddl::StructElement* getStructElement ( const AccessType &  access,
size_t  leaf_index 
) const
inline

Fill the local Struct Element and retrieves the Struct Element pointer for legacy.

Parameters
accessThe access instance to get the layout information from.
leaf_indexThe leaf index.
Returns
const ddl::StructElement*

Definition at line 53 of file access_element_legacy.h.

References StructElementLegacy< AccessType >::getStructElement(), StructElement::name, StructElement::p_enum, StructElement::type, and ddl::dd::type_info.

◆ getStructElement() [3/3]

a_util::result::Result getStructElement ( const AccessType &  access,
size_t  leaf_index,
const ddl::StructElement *&  struct_element 
) const
inline

Fill the local Struct Element and retrieves the Struct Element pointer for legacy in struct_element.

Parameters
accessThe access instance to get the layout information from.
leaf_indexThe leaf index
struct_elementthe pointer reference to return the StructElement
Returns
a_util::result::Result

Definition at line 73 of file access_element_legacy.h.

References StructElementLegacy< AccessType >::getStructElement().