| eRPC Generator (erpcgen) Rev. 1.8.1 NXP Semiconductors

- Main Page
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Protected Attributes | List of all members
erpcgen::EnumMember Class Reference

Member of a enum. More...

`#include <EnumMember.h>`

Inheritance diagram for erpcgen::EnumMember:

## Public Member Functions
| EnumMember (const Token &tok, uint32_t value)
| Constructor. More...
| EnumMember (const Token &tok)
| Constructor. More...
void | setValue (IntegerValue value)
| This function set enum member value. More...
uint32_t | getValue () const
| This function returns enum member value. More...
bool | hasValue () const
| This function return true if enum member has set value. More...
virtual std::string | getDescription () const
| This function returns description about the enum member. More...
Public Member Functions inherited from erpcgen::Symbol
| Symbol (symbol_type_t symType)
| Constructor. More...
| Symbol (symbol_type_t symType, const std::string &name)
| Constructor. More...
| Symbol (symbol_type_t symType, const Token &tok)
| Constructor. More...
virtual | ~Symbol ()
| Destructor.
symbol_type_t | getSymbolType () const
| This function returns symbol type. More...
const std::string & | getName () const
| This function returns symbol name. More...
void | setName (const std::string &newName)
| This function set symbol name. More...
token_loc_t & | getLocation ()
| This function returns location for symbol. More...
void | setLocation (const token_loc_t &loc)
| This function set location for symbol. More...
int | getFirstLine () const
| This function return first line from location of symbol. More...
int | getLastLine () const
| This function return last line from location of symbol. More...
virtual bool | isBuiltin () const
| This function return "false" value as default for identify builtin type. More...
void | addAnnotation (const Annotation &a)
| This function add annotation to vector of symbol annotations. More...
std::string | printAnnotations ()
| This function returns description about annotation. More...
Annotation * | findAnnotation (std::string name, Annotation::program_lang_t lang)
| Find annotation in the annotation list. More...
std::vector< Annotation * > | getAnnotations (std::string name, Annotation::program_lang_t lang)
| Find annotations matching name in the annotation list. More...
const std::vector< Annotation > & | getAnnotations () const
| Return all Symbol annotations. More...
Value * | getAnnValue (const std::string annName, Annotation::program_lang_t lang)
| This function search and returns Value object for given annotation name. More...
std::string | getAnnStringValue (const std::string annName, Annotation::program_lang_t lang)
| This function search and returns string for given annotation name. More...
std::string | getMlComment ()
| This function returns multiline comment for this symbol declared in IDL file. More...
void | setMlComment (std::string comment)
| This function set multiline comment for this symbol declared in IDL file. More...
std::string | getIlComment ()
| This function returns inline comment for this symbol declared in IDL file. More...
void | setIlComment (std::string comment)
| This function set inline comment for this symbol declared in IDL file. More...

## Protected Attributes
IntegerValue | m_value
bool | m_valueSet
Protected Attributes inherited from erpcgen::Symbol
symbol_type_t | m_symbolType
std::string | m_name
token_loc_t | m_location
std::vector< Annotation > | m_annotations
std::string | m_mlComment
std::string | m_ilComment

## Additional Inherited Members
Public Types inherited from erpcgen::Symbol
enum | symbol_type_t { kConstSymbol, kEnumMemberSymbol, kFunctionSymbol, kInterfaceSymbol, kProgramSymbol, kStructMemberSymbol, kTypenameSymbol, kUnionCaseMemberSymbol, kAliasTypeSymbol, kArrayTypeSymbol, kBuiltinTypeSymbol, kEnumTypeSymbol, kFunctionTypeSymbol, kListTypeSymbol, kStructTypeSymbol, kUnionTypeSymbol }
| Supported symbol types.

## Detailed Description

Member of a enum.

## Constructor & Destructor Documentation

erpcgen::EnumMember::EnumMember | ( | const Token & | tok,
|  | uint32_t | value
| ) |  |
| inline

Constructor.

This function sets the value and token

Parameters

  [in] | tok | Token, which contains name and location.
  [in] | value | Given value.

erpcgen::EnumMember::EnumMember | ( | const Token & | tok | ) |
| inline

Constructor.

This function set token to given token.

Parameters

  [in] | tok | Token, which contains name and location.

## Member Function Documentation

string EnumMember::getDescription | ( |  | ) | const
| virtual

This function returns description about the enum member.

Returns
  String description about enum member.

See also
  std::string AliasType::getDescription() const
  std::string EnumType::getDescription() const
  std::string StructMember::getDescription() const
  std::string StructType::getDescription() const
  std::string VoidType::getDescription() const
  std::string ArrayType::getDescription() const
  std::string ListType::getDescription() const
  std::string UnionType::getDescription() const

Reimplemented from erpcgen::Symbol.

uint32_t erpcgen::EnumMember::getValue | ( |  | ) | const
| inline

This function returns enum member value.

Returns
  String representation of enum member value.

bool erpcgen::EnumMember::hasValue | ( |  | ) | const
| inline

This function return true if enum member has set value.

Return values

  true | When enum member has set value.
  false | When enum member has not set value.

void erpcgen::EnumMember::setValue | ( | IntegerValue | value | ) |
| inline

This function set enum member value.

Parameters

  [in] | value | Value of enum member.

## Member Data Documentation

IntegerValue erpcgen::EnumMember::m_value
| protected

Integer value of enum member.

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

- EnumMember.h
- Type.cpp