Fawkes API  Fawkes Development Version
InterfacePseudoMap Class Reference

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

#include "pseudomap.h"

Public Types

typedef std::list< std::pair< std::string, std::string > > RefList
 Reference list. More...
 

Public Member Functions

 InterfacePseudoMap (std::string name, std::string type, std::string keytype, std::string comment)
 Constructor. More...
 
void valid ()
 Assert validity. More...
 
std::string getName () const
 Get name of field. More...
 
std::string getComment () const
 Get comment of field. More...
 
std::string getType () const
 Get type of field. More...
 
std::string getKeyType () const
 Get type of key value. More...
 
void addRef (std::string fieldname, std::string key)
 Add reference. More...
 
RefListgetRefList ()
 Get reference list. More...
 

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

◆ RefList

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::InterfacePseudoMap ( std::string  name,
std::string  type,
std::string  keytype,
std::string  comment 
)

Constructor.

Parameters
namename of the pseudo map
typetype of the values in the map
keytypetype of the keys
commentcomment of the pseudo map

Definition at line 43 of file pseudomap.cpp.

Member Function Documentation

◆ addRef()

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

Add reference.

Parameters
fieldnamename of the field that is referenced
keykey of the field in the pseudo map

Definition at line 129 of file pseudomap.cpp.

Referenced by InterfaceParser::getPseudoMaps().

◆ getComment()

std::string InterfacePseudoMap::getComment ( ) const

Get comment of field.

Returns
comment of field.

Definition at line 77 of file pseudomap.cpp.

◆ getKeyType()

std::string InterfacePseudoMap::getKeyType ( ) const

Get type of key value.

Returns
type of key

Definition at line 87 of file pseudomap.cpp.

◆ getName()

std::string InterfacePseudoMap::getName ( void  ) const

Get name of field.

Returns
name of field.

Definition at line 57 of file pseudomap.cpp.

◆ getRefList()

InterfacePseudoMap::RefList & InterfacePseudoMap::getRefList ( )

Get reference list.

Returns
reference list

Definition at line 139 of file pseudomap.cpp.

◆ getType()

std::string InterfacePseudoMap::getType ( ) const

Get type of field.

Returns
type of field.

Definition at line 67 of file pseudomap.cpp.

◆ valid()

void InterfacePseudoMap::valid ( )

Assert validity.

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

Exceptions
InterfaceGeneratorInvalidTypeExceptionthrown if InterfaceDataTypeChecker reports invalid type.
InterfaceGeneratorInvalidValueExceptionthrown if any supplied value is illegal.
InterfaceGeneratorInvalidFlagExceptionthrown 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: