InterfaceEnumConstant Class Reference

Interface generator internal representation of a enum constant as parsed from the XML template file. More...

#include <interfaces/generator/enum_constant.h>

List of all members.


Public Member Functions

 InterfaceEnumConstant (const std::string &name, const std::string &comment)
 Constructor.
std::string getName ()
 Get name of enum constant.
std::string getComment ()
 Get comment of enum constant.
std::vector< std::pair
< std::string, std::string > > 		getItems ()
 Get enumeration items.
void addItem (std::string name, std::string comment)
 Add an item.

Detailed Description

Interface generator internal representation of a enum constant as parsed from the XML template file.

Definition at line 30 of file enum_constant.h.

Constructor & Destructor Documentation

InterfaceEnumConstant::InterfaceEnumConstant ( const std::string &  name,
const std::string &  comment 
)

Constructor.

Parameters:
name name of enumeration constant
comment comment of enumeration constant.

Definition at line 36 of file enum_constant.cpp.

Member Function Documentation

void InterfaceEnumConstant::addItem ( std::string  name,
std::string  comment 
)

Add an item.

Parameters:
name name of item
comment comment of item.

Definition at line 81 of file enum_constant.cpp.

Referenced by InterfaceParser::parse().

std::string InterfaceEnumConstant::getComment (  ) 

Get comment of enum constant.

Returns:
comment of enum constant.

Definition at line 59 of file enum_constant.cpp.

std::vector< std::pair< std::string, std::string > > InterfaceEnumConstant::getItems (  ) 

Get enumeration items.

Returns:
vector of enum items. First item in pair contains item name, second item the comment.

Definition at line 70 of file enum_constant.cpp.

std::string InterfaceEnumConstant::getName ( void   ) 

Get name of enum constant.

return name of enum constant.

Definition at line 49 of file enum_constant.cpp.

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