Defines enum metadata information. More...

#include <saimetadatatypes.h>

Public Attributes
const char *const	name
	String representation of enum type definition.

const size_t	valuescount
	Values count in enum.

const int *const	values
	Array of enum values.

const char const const	valuesnames
	Array of enum values string names.

const char const const	valuesshortnames
	Array of enum values string short names.

bool	containsflags
	Indicates whether enumeration contains flags.

sai_enum_flags_type_t	flagstype
	Defines enum flags type, if enum contains flags.

const int *const	ignorevalues
	Array of enum ignored values.

const char const const	ignorevaluesnames
	Array of enum ignored values string names.

sai_object_type_t	objecttype
	Object type to which this enum belongs.

Detailed Description

Defines enum metadata information.

Definition at line 814 of file saimetadatatypes.h.

Member Data Documentation

◆ containsflags

bool _sai_enum_metadata_t::containsflags

Indicates whether enumeration contains flags.

When set to true numbers of enumeration are not sequential.

Definition at line 846 of file saimetadatatypes.h.

◆ flagstype

sai_enum_flags_type_t _sai_enum_metadata_t::flagstype

Defines enum flags type, if enum contains flags.

If contains flags is false, then flag type must be SAI_ENUM_FLAGS_TYPE_NONE.

Definition at line 854 of file saimetadatatypes.h.

◆ ignorevalues

const int* const _sai_enum_metadata_t::ignorevalues

Array of enum ignored values.

Definition at line 859 of file saimetadatatypes.h.

◆ ignorevaluesnames

const char* const* const _sai_enum_metadata_t::ignorevaluesnames

Array of enum ignored values string names.

Definition at line 864 of file saimetadatatypes.h.

◆ name

const char* const _sai_enum_metadata_t::name

String representation of enum type definition.

Definition at line 819 of file saimetadatatypes.h.

◆ objecttype

sai_object_type_t _sai_enum_metadata_t::objecttype

Object type to which this enum belongs.

If enum don't belong to any object type then this field will be equal to SAI_OBJECT_TYPE_NULL.

Definition at line 872 of file saimetadatatypes.h.

◆ values

const int* const _sai_enum_metadata_t::values

Array of enum values.

Definition at line 829 of file saimetadatatypes.h.

◆ valuescount

const size_t _sai_enum_metadata_t::valuescount

Values count in enum.

Definition at line 824 of file saimetadatatypes.h.

◆ valuesnames

const char* const* const _sai_enum_metadata_t::valuesnames

Array of enum values string names.

Definition at line 834 of file saimetadatatypes.h.

◆ valuesshortnames

const char* const* const _sai_enum_metadata_t::valuesshortnames

Array of enum values string short names.

Definition at line 839 of file saimetadatatypes.h.

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

saimetadatatypes.h

Public Attributes