erpcgen::ConstType Class Reference

Const class. More...

#include <ConstType.hpp>

Inheritance diagram for erpcgen::ConstType:

Public Member Functions
	ConstType (const Token &tok, DataType *dataType, Value *value)
	Constructor. More...
DataType *	getDataType ()
	This function returns pointer to element data type. More...
Value *	getValue ()
	This function returns value of constant data type. More...
void	setDataType (DataType *dataType)
	This function sets constant data type. More...
void	setValue (Value *value)
	This function sets constant value. 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...
bool	isConstSymbol () const
	This function is testing symbol type. More...
bool	isEnumMemberSymbol () const
	This function is testing symbol type. More...
bool	isFunctionSymbol () const
	This function is testing symbol type. More...
bool	isInterfaceSymbol () const
	This function is testing symbol type. More...
bool	isProgramSymbol () const
	This function is testing symbol type. More...
bool	isStructMemberSymbol () const
	This function is testing symbol type. More...
bool	isDatatypeSymbol () const
	This function is testing symbol type. More...
bool	isUnionCaseSymbol () const
	This function is testing symbol type. 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 std::string	getDescription () const
	This function returns description about the symbol (symbol name). 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 (const std::string &name, Annotation::program_lang_t lang)
	Find annotation in the annotation list. More...
std::vector< Annotation * >	getAnnotations (const 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 (const 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 (const std::string &comment)
	This function set inline comment for this symbol declared in IDL file. More...

Protected Attributes
DataType *	m_dataType
Value *	m_value
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 }
	Supported symbol types.

Detailed Description

Const class.

Constructor & Destructor Documentation

erpcgen::ConstType::ConstType ( const Token &  tok, DataType *  dataType, Value *  value  )

inline

Constructor.

This function set symbol token to given token, data type to given data type and value to given value.

Parameters

[in]	tok	Token, which contains name and location.
[in]	dataType	Given data type..
[in]	value	Given value.

Member Function Documentation

DataType* erpcgen::ConstType::getDataType ( )

inline

This function returns pointer to element data type.

Returns

Pointer to element data type.

Value* erpcgen::ConstType::getValue ( )

inline

This function returns value of constant data type.

Returns

Pointer to value.

void erpcgen::ConstType::setDataType ( DataType *  dataType )

inline

This function sets constant data type.

Parameters

[in]

dataType

Constant data type.

void erpcgen::ConstType::setValue ( Value *  value )

inline

This function sets constant value.

Parameters

[in]

value

Constant value.

Member Data Documentation

DataType* erpcgen::ConstType::m_dataType

protected

Constant data type.

Value* erpcgen::ConstType::m_value

protected

Constant value.

---

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

• ConstType.hpp