InterfacePseudoMap Class Reference

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

#include "pseudomap.h"

List of all members.

Public Types
typedef std::list< std::pair < std::string, std::string > >	RefList
	Reference list.
Public Member Functions
	InterfacePseudoMap (std::string name, std::string type, std::string keytype, std::string comment)
	Constructor.
void	valid ()
	Assert validity.
std::string	getName () const
	Get name of field.
std::string	getComment () const
	Get comment of field.
std::string	getType () const
	Get type of field.
std::string	getKeyType () const
	Get type of key value.
void	addRef (std::string fieldname, std::string key)
	Add reference.
RefList &	getRefList ()
	Get reference list.

---

Detailed Description

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

Author:

Tim Niemueller

Definition at line 31 of file pseudomap.h.

---

Member Typedef Documentation

typedef std::list<std::pair<std::string, std::string> > InterfacePseudoMap::RefList

Reference list.

Definition at line 35 of file pseudomap.h.

---

Constructor & Destructor Documentation

InterfacePseudoMap::InterfacePseudoMap	(	std::string	name,
		std::string	type,
		std::string	keytype,
		std::string	comment
	)

Constructor.

Parameters:

	name	name of the pseudo map
	type	type of the values in the map
	keytype	type of the keys
	comment	comment of the pseudo map

Definition at line 43 of file pseudomap.cpp.

---

Member Function Documentation

void InterfacePseudoMap::addRef	(	std::string	fieldname,
		std::string	key
	)

Add reference.

Parameters:

	fieldname	name of the field that is referenced
	key	key of the field in the pseudo map

Definition at line 129 of file pseudomap.cpp.

Referenced by InterfaceParser::getPseudoMaps().

std::string InterfacePseudoMap::getComment

(

)

const

Get comment of field.

Returns:

comment of field.

Definition at line 77 of file pseudomap.cpp.

std::string InterfacePseudoMap::getKeyType

(

)

const

Get type of key value.

Returns:

type of key

Definition at line 87 of file pseudomap.cpp.

std::string InterfacePseudoMap::getName

(

void

)

const

Get name of field.

Returns:

name of field.

Definition at line 57 of file pseudomap.cpp.

InterfacePseudoMap::RefList & InterfacePseudoMap::getRefList

(

)

Get reference list.

Returns:

reference list

Definition at line 139 of file pseudomap.cpp.

std::string InterfacePseudoMap::getType

(

)

const

Get type of field.

Returns:

type of field.

Definition at line 67 of file pseudomap.cpp.

void InterfacePseudoMap::valid

(

)

Assert validity.

Calling valid() acts like an assertion. An Exception is thrown if something is wrong.

Exceptions:

	InterfaceGeneratorInvalidTypeException	thrown if InterfaceDataTypeChecker reports invalid type.
	InterfaceGeneratorInvalidValueException	thrown if any supplied value is illegal.
	InterfaceGeneratorInvalidFlagException	thrown if invalid flag has been supplied.

Definition at line 104 of file pseudomap.cpp.

Referenced by InterfaceParser::getPseudoMaps().

---

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

• src/interfaces/generator/pseudomap.h
• src/interfaces/generator/pseudomap.cpp