InterfaceConstant Class Reference

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

#include <interfaces/generator/constant.h>

List of all members.


Public Member Functions

 InterfaceConstant (const std::string &name, const std::string &type, const std::string &value, const std::string &comment)
 Constructor.
std::string getName ()
 Get name of constant.
std::string getValue ()
 Get value of constant.
std::string getType ()
 Get type of constant.
std::string getComment ()
 Get comment of constant.

Detailed Description

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

Definition at line 28 of file constant.h.

Constructor & Destructor Documentation

InterfaceConstant::InterfaceConstant ( const std::string &  name,
const std::string &  type,
const std::string &  value,
const std::string &  comment 
)

Constructor.

Parameters:
name name of constant
type type of constant
value value of constant
comment comment of message
Exceptions:
InterfaceGeneratorInvalidTypeException thrown if InterfaceDataTypeChecker reports an invalid type.
InterfaceGeneratorInvalidValueException thrown if InterfaceDataTypeChecker reports an illegal value for the given type.

Definition at line 43 of file constant.cpp.

References InterfaceDataTypeChecker::validType(), and InterfaceDataTypeChecker::validValue().

Member Function Documentation

std::string InterfaceConstant::getComment (  ) 

Get comment of constant.

Returns:
comment of constant.

Definition at line 98 of file constant.cpp.

std::string InterfaceConstant::getName ( void   ) 

Get name of constant.

Returns:
name of constant.

Definition at line 68 of file constant.cpp.

std::string InterfaceConstant::getType (  ) 

Get type of constant.

Returns:
type of constnat.

Definition at line 88 of file constant.cpp.

std::string InterfaceConstant::getValue (  ) 

Get value of constant.

Returns:
value of constant.

Definition at line 78 of file constant.cpp.

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