ADTF
Loading...
Searching...
No Matches
ddl::access_element::StructElementLegacy< AccessType > Class Template Reference

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

#include <access_element_legacy.h>

Public Member Functions

const ddl::StructElementgetStructElement () const
 Get the converted StructElement pointer.
 
const ddl::StructElementgetStructElement (const AccessType &access, size_t leaf_index) const
 Fill the local Struct Element and retrieves the Struct Element pointer for legacy.
 
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.
 

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.

Member Function Documentation

◆ getStructElement() [1/3]

template<typename AccessType>
const ddl::StructElement * ddl::access_element::StructElementLegacy< AccessType >::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*

◆ getStructElement() [2/3]

template<typename AccessType>
const ddl::StructElement * ddl::access_element::StructElementLegacy< AccessType >::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*

◆ getStructElement() [3/3]

template<typename AccessType>
a_util::result::Result ddl::access_element::StructElementLegacy< AccessType >::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

The documentation for this class was generated from the following file: