SAI Metadata
Loading...
Searching...
No Matches
_sai_struct_member_info_t Struct Reference

Defines struct member info for non object id object type. More...

#include <saimetadatatypes.h>

Public Attributes

sai_attr_value_type_t membervaluetype
 Member value type.
 
const char *const membername
 Member name.
 
bool isvlan
 Indicates whether field is vlan.
 
const sai_object_type_t *const allowedobjecttypes
 Specified allowed object types.
 
size_t allowedobjecttypeslength
 Length of allowed object types.
 
bool isenum
 Indicates whether member is enum value.
 
const sai_enum_metadata_t *const enummetadata
 Provides enum metadata if member is enum.
 
const sai_meta_get_struct_member_oid_fn getoid
 If struct member is OID this function will get its value.
 
const sai_meta_set_struct_member_oid_fn setoid
 If struct member is OID this function will set its value.
 
size_t offset
 Member offset from the struct beginning in bytes.
 
size_t size
 Member size using sizeof operator.
 

Detailed Description

Defines struct member info for non object id object type.

Definition at line 1320 of file saimetadatatypes.h.

Member Data Documentation

◆ allowedobjecttypes

const sai_object_type_t* const _sai_struct_member_info_t::allowedobjecttypes

Specified allowed object types.

If object attr value type is OBJECT_ID this list specifies what object type can be used.

Definition at line 1343 of file saimetadatatypes.h.

◆ allowedobjecttypeslength

size_t _sai_struct_member_info_t::allowedobjecttypeslength

Length of allowed object types.

Definition at line 1348 of file saimetadatatypes.h.

◆ enummetadata

const sai_enum_metadata_t* const _sai_struct_member_info_t::enummetadata

Provides enum metadata if member is enum.

Definition at line 1363 of file saimetadatatypes.h.

◆ getoid

const sai_meta_get_struct_member_oid_fn _sai_struct_member_info_t::getoid

If struct member is OID this function will get its value.

Definition at line 1369 of file saimetadatatypes.h.

◆ isenum

bool _sai_struct_member_info_t::isenum

Indicates whether member is enum value.

Type must be set as INT32.

Note
Could be deduced from enum type string or enum vector values and attr value type.

Definition at line 1358 of file saimetadatatypes.h.

◆ isvlan

bool _sai_struct_member_info_t::isvlan

Indicates whether field is vlan.

Definition at line 1335 of file saimetadatatypes.h.

◆ membername

const char* const _sai_struct_member_info_t::membername

Member name.

Definition at line 1330 of file saimetadatatypes.h.

◆ membervaluetype

sai_attr_value_type_t _sai_struct_member_info_t::membervaluetype

Member value type.

Definition at line 1325 of file saimetadatatypes.h.

◆ offset

size_t _sai_struct_member_info_t::offset

Member offset from the struct beginning in bytes.

Macro offsetof is used to calculate this field, and it value can be different depending on compiler setting for struct packing.

Definition at line 1383 of file saimetadatatypes.h.

◆ setoid

const sai_meta_set_struct_member_oid_fn _sai_struct_member_info_t::setoid

If struct member is OID this function will set its value.

Definition at line 1375 of file saimetadatatypes.h.

◆ size

size_t _sai_struct_member_info_t::size

Member size using sizeof operator.

Definition at line 1388 of file saimetadatatypes.h.


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