GATE
C/C++ Framework
Loading...
Searching...
No Matches
StructDescriptorBase< cpp_struct_type > Struct Template Reference

Initializes a C-struct desriptor and provides methods to create member items. More...

#include <structs.hpp>

Inheritance diagram for StructDescriptorBase< cpp_struct_type >:
DynStructDescriptorBase< cpp_struct_type >

Public Member Functions

template<class member_type>
gate_struct_item_t buildMemberItem (member_type cpp_struct_type::*memberPtr, char const *name, char const *description=NULL, enumint_t flags=0)
 Builds a member item record based on a c++ member pointer and meta informations.
void setMemberItems (gate_struct_item_t const *items, gate_size_t items_count)
 Sets the descriptor's items and count fields.

Detailed Description

template<class cpp_struct_type>
struct gate::StructDescriptorBase< cpp_struct_type >

Initializes a C-struct desriptor and provides methods to create member items.

Template Parameters
cpp_struct_type

Member Function Documentation

◆ buildMemberItem()

template<class cpp_struct_type>
template<class member_type>
gate_struct_item_t buildMemberItem ( member_type cpp_struct_type::* memberPtr,
char const * name,
char const * description = NULL,
enumint_t flags = 0 )
inline

Builds a member item record based on a c++ member pointer and meta informations.

Template Parameters
member_typeType of member to be referenced
Parameters
memberPtrPointer to member in covered c++ struct
nameStatic name string of referenced member
descriptionOptional static description text of referenced member
flagsOptional flags describing the member's behavior
Returns
generated item record with all required fields

◆ setMemberItems()

template<class cpp_struct_type>
void setMemberItems ( gate_struct_item_t const * items,
gate_size_t items_count )
inline

Sets the descriptor's items and count fields.

Parameters
items
items_count

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