SUMO - Simulation of Urban MObility
SUMOSAXAttributesImpl_Cached Class Reference

Encapsulated Xerces-SAX-attributes. More...

#include <SUMOSAXAttributesImpl_Cached.h>

Inheritance diagram for SUMOSAXAttributesImpl_Cached:
Inheritance graph
Collaboration diagram for SUMOSAXAttributesImpl_Cached:
Collaboration graph

Public Member Functions

template<typename T >
get (int attr, const char *objectid, bool &ok, bool report=true) const
 Tries to read given attribute assuming it is an int. More...
 
template<>
int getInternal (const int attr) const
 
template<>
long long int getInternal (const int attr) const
 
template<>
double getInternal (const int attr) const
 
template<>
bool getInternal (const int attr) const
 
template<>
std::string getInternal (const int attr) const
 
template<>
RGBColor getInternal (const int) const
 
template<>
PositionVector getInternal (const int attr) const
 
template<>
Boundary getInternal (const int attr) const
 
template<typename T >
getOpt (int attr, const char *objectid, bool &ok, T defaultValue, bool report=true) const
 Tries to read given attribute assuming it is an int. More...
 
SUMOTime getOptSUMOTimeReporting (int attr, const char *objectid, bool &ok, SUMOTime defaultValue, bool report=true) const
 Tries to read given attribute assuming it is a SUMOTime. More...
 
SUMOTime getSUMOTimeReporting (int attr, const char *objectid, bool &ok, bool report=true) const
 Tries to read given attribute assuming it is a SUMOTime. More...
 
 SUMOSAXAttributesImpl_Cached (const std::map< std::string, std::string > &attrs, const std::map< int, std::string > &predefinedTagsMML, const std::string &objectType)
 Constructor. More...
 
virtual ~SUMOSAXAttributesImpl_Cached ()
 Destructor. More...
 

virtual methods for retrieving attribute values

const std::string & getObjectType () const
 return the objecttype to which these attributes belong More...
 
static const std::string ENCODING = " encoding=\"UTF-8\""
 The encoding of parsed strings. More...
 
static void parseStringVector (const std::string &def, std::vector< std::string > &into)
 Splits the given string. More...
 
static void parseStringSet (const std::string &def, std::set< std::string > &into)
 Splits the given string, stores it in a set. More...
 
template<typename T >
getInternal (const int attr) const
 
void emitUngivenError (const std::string &attrname, const char *objectid) const
 
void emitEmptyError (const std::string &attrname, const char *objectid) const
 
void emitFormatError (const std::string &attrname, const std::string &type, const char *objectid) const
 

methods for retrieving attribute values

std::map< std::string, std::string > myAttrs
 The encapsulated attributes. More...
 
const std::map< int, std::string > & myPredefinedTagsMML
 Map of attribute ids to their (readable) string-representation. More...
 
bool hasAttribute (int id) const
 Returns the information whether the named (by its enum-value) attribute is within the current list. More...
 
bool getBool (int id) const
 Returns the bool-value of the named (by its enum-value) attribute. More...
 
int getInt (int id) const
 Returns the int-value of the named (by its enum-value) attribute. More...
 
long long int getLong (int id) const
 Returns the long-value of the named (by its enum-value) attribute. More...
 
std::string getString (int id) const
 Returns the string-value of the named (by its enum-value) attribute. More...
 
std::string getStringSecure (int id, const std::string &def) const
 Returns the string-value of the named (by its enum-value) attribute. More...
 
double getFloat (int id) const
 Returns the double-value of the named (by its enum-value) attribute. More...
 
bool hasAttribute (const std::string &id) const
 Returns the information whether the named attribute is within the current list. More...
 
double getFloat (const std::string &id) const
 Returns the double-value of the named attribute. More...
 
std::string getStringSecure (const std::string &id, const std::string &def) const
 Returns the string-value of the named (by its enum-value) attribute. More...
 
SumoXMLEdgeFunc getEdgeFunc (bool &ok) const
 Returns the value of the named attribute. More...
 
SumoXMLNodeType getNodeType (bool &ok) const
 Returns the value of the named attribute. More...
 
RGBColor getColor () const
 Returns the value of the named attribute. More...
 
PositionVector getShape (int attr) const
 Tries to read given attribute assuming it is a PositionVector. More...
 
Boundary getBoundary (int attr) const
 Tries to read given attribute assuming it is a Boundary. More...
 
std::vector< std::string > getStringVector (int attr) const
 Tries to read given attribute assuming it is a string vector. More...
 
std::string getName (int attr) const
 Converts the given attribute id into a man readable string. More...
 
void serialize (std::ostream &os) const
 Prints all attribute names and values into the given stream. More...
 
SUMOSAXAttributesclone () const
 return a new deep-copy attributes object More...
 
const char * getAttributeValueSecure (int id) const
 Returns Xerces-value of the named attribute. More...
 
 SUMOSAXAttributesImpl_Cached (const SUMOSAXAttributesImpl_Cached &src)
 Invalidated copy constructor. More...
 
SUMOSAXAttributesImpl_Cachedoperator= (const SUMOSAXAttributesImpl_Cached &src)
 Invalidated assignment operator. More...
 

Detailed Description

Encapsulated Xerces-SAX-attributes.

See also
SUMOSAXAttributes

Definition at line 50 of file SUMOSAXAttributesImpl_Cached.h.

Constructor & Destructor Documentation

◆ SUMOSAXAttributesImpl_Cached() [1/2]

SUMOSAXAttributesImpl_Cached::SUMOSAXAttributesImpl_Cached ( const std::map< std::string, std::string > &  attrs,
const std::map< int, std::string > &  predefinedTagsMML,
const std::string &  objectType 
)

Constructor.

Parameters
[in]attrsThe encapsulated xerces-attributes
[in]predefinedTagsMap of attribute ids to their xerces-representation
[in]predefinedTagsMMLMap of attribute ids to their (readable) string-representation

Definition at line 49 of file SUMOSAXAttributesImpl_Cached.cpp.

Referenced by clone().

◆ ~SUMOSAXAttributesImpl_Cached()

SUMOSAXAttributesImpl_Cached::~SUMOSAXAttributesImpl_Cached ( )
virtual

Destructor.

Definition at line 58 of file SUMOSAXAttributesImpl_Cached.cpp.

◆ SUMOSAXAttributesImpl_Cached() [2/2]

SUMOSAXAttributesImpl_Cached::SUMOSAXAttributesImpl_Cached ( const SUMOSAXAttributesImpl_Cached src)
private

Invalidated copy constructor.

Member Function Documentation

◆ clone()

SUMOSAXAttributes * SUMOSAXAttributesImpl_Cached::clone ( ) const
virtual

return a new deep-copy attributes object

Implements SUMOSAXAttributes.

Definition at line 239 of file SUMOSAXAttributesImpl_Cached.cpp.

References SUMOSAXAttributes::getObjectType(), myAttrs, myPredefinedTagsMML, and SUMOSAXAttributesImpl_Cached().

◆ emitEmptyError()

void SUMOSAXAttributes::emitEmptyError ( const std::string &  attrname,
const char *  objectid 
) const
protectedinherited

◆ emitFormatError()

void SUMOSAXAttributes::emitFormatError ( const std::string &  attrname,
const std::string &  type,
const char *  objectid 
) const
protectedinherited

◆ emitUngivenError()

void SUMOSAXAttributes::emitUngivenError ( const std::string &  attrname,
const char *  objectid 
) const
protectedinherited

◆ get()

template<typename T >
T SUMOSAXAttributes::get ( int  attr,
const char *  objectid,
bool &  ok,
bool  report = true 
) const
inherited

Tries to read given attribute assuming it is an int.

If an error occurs (the attribute is not there, it is not numeric), "ok" is set to false. If report is true an error message is written to MsgHandler::getErrorInstance.

If the value could be read, "ok" is not changed, and the value is returned.

Parameters
[in]attrThe id of the attribute to read
[in]objectidThe name of the parsed object; used for error message generation
[out]okWhether the value could be read
[in]reportWhether errors shall be written to msg handler's error instance
Returns
The read value if given and correct; -1 if an error occured

Definition at line 445 of file SUMOSAXAttributes.h.

References SUMOSAXAttributes::emitEmptyError(), SUMOSAXAttributes::emitFormatError(), SUMOSAXAttributes::emitUngivenError(), SUMOSAXAttributes::getName(), and SUMOSAXAttributes::hasAttribute().

Referenced by NIImporter_SUMO::addConnection(), NLHandler::addConnection(), NIXMLConnectionsHandler::addCrossing(), NLHandler::addDistrict(), NLHandler::addDistrictEdge(), NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addE3Entry(), NLHandler::addE3Exit(), NIImporter_SUMO::addEdge(), NIXMLEdgesHandler::addEdge(), NLHandler::addEdgeLaneMeanData(), NLHandler::addInstantE1Detector(), NIXMLNodesHandler::addJoinCluster(), NIXMLNodesHandler::addJoinExclusion(), NIImporter_SUMO::addJunction(), NIImporter_SUMO::addLane(), NLHandler::addLane(), NIXMLEdgesHandler::addLane(), NIXMLNodesHandler::addNode(), SUMORouteHandler::addParam(), NLHandler::addParam(), RORouteHandler::addPersonTrip(), NIImporter_SUMO::addPhase(), NLHandler::addPhase(), ShapeHandler::addPOI(), ShapeHandler::addPoly(), NIImporter_SUMO::addRequest(), NLHandler::addRequest(), NLHandler::addRouteProbeDetector(), NIXMLEdgesHandler::addSplit(), ROJTRTurnDefLoader::addToEdge(), NLHandler::addVTypeProbeDetector(), MSRouteHandler::addWalk(), RORouteHandler::addWalk(), NIXMLConnectionsHandler::addWalkingArea(), NLHandler::addWAUTJunction(), NLHandler::addWAUTSwitch(), NLHandler::beginE3Detector(), NLHandler::beginEdgeParsing(), ROJTRTurnDefLoader::beginFromEdge(), SUMOVehicleParserHelper::beginVTypeParsing(), NLTriggerBuilder::buildVaporizer(), NIXMLEdgesHandler::deleteEdge(), NIXMLNodesHandler::deleteNode(), NLTriggerBuilder::getLane(), NLTriggerBuilder::getPosition(), NLHandler::initJunctionLogic(), NIImporter_SUMO::initTrafficLightLogic(), NIXMLTrafficLightsHandler::initTrafficLightLogic(), NLHandler::initTrafficLightLogic(), NIImporter_SUMO::loadLocation(), RODFDetectorHandler::myStartElement(), GUISettingsHandler::myStartElement(), PCTypeDefHandler::myStartElement(), NIXMLTrafficLightsHandler::myStartElement(), MSStateHandler::myStartElement(), NIXMLConnectionsHandler::myStartElement(), ODAmitranHandler::myStartElement(), NIXMLTypesHandler::myStartElement(), MSRouteHandler::myStartElement(), ShapeHandler::myStartElement(), RONetHandler::myStartElement(), ROJTRTurnDefLoader::myStartElement(), RORouteHandler::myStartElement(), PCNetProjectionLoader::myStartElement(), TrajectoriesHandler::myStartElement(), NIXMLNodesHandler::myStartElement(), NIXMLEdgesHandler::myStartElement(), PCLoaderXML::myStartElement(), NIImporter_MATSim::NodesHandler::myStartElement(), NIImporter_SUMO::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_Streckendefinition::myStartElement(), NLHandler::myStartElement(), NIImporter_MATSim::EdgesHandler::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_Zuflussdefinition::myStartElement(), PCLoaderOSM::NodesHandler::myStartElement(), SAXWeightsHandler::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_Parkplatzdefinition::myStartElement(), PCLoaderOSM::RelationsHandler::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_Fahrzeugklassendefinition::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_VWunschentscheidungsdefinition::myStartElement(), NIImporter_OpenStreetMap::NodesHandler::myStartElement(), PCLoaderOSM::EdgesHandler::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_Geschwindigkeitsverteilungsdefinition::myStartElement(), NIImporter_OpenStreetMap::EdgesHandler::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_Routenentscheidungsdefinition::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_ConflictArea::myStartElement(), NIImporter_OpenStreetMap::RelationHandler::myStartElement(), NIImporter_OpenDrive::myStartElement(), ODDistrictHandler::openDistrict(), NLHandler::openJunction(), MSRouteHandler::openRoute(), RORouteHandler::openRoute(), MSRouteHandler::openRouteDistribution(), RORouteHandler::openRouteDistribution(), MSRouteHandler::openVehicleTypeDistribution(), RORouteHandler::openVehicleTypeDistribution(), NLHandler::openWAUT(), RONetHandler::parseAccess(), NLTriggerBuilder::parseAndAddLotEntry(), NLTriggerBuilder::parseAndBeginParkingArea(), NLTriggerBuilder::parseAndBuildCalibrator(), NLTriggerBuilder::parseAndBuildChargingStation(), NLTriggerBuilder::parseAndBuildLaneSpeedTrigger(), NLTriggerBuilder::parseAndBuildRerouter(), NLTriggerBuilder::parseAndBuildStoppingPlace(), GNEAttributeCarrier::parseAttributeFromXML(), SUMOVehicleParserHelper::parseCommonAttributes(), RONetHandler::parseConnection(), NIXMLConnectionsHandler::parseDeprecatedLaneDefinition(), RONetHandler::parseDistrict(), RONetHandler::parseDistrictEdge(), RONetHandler::parseEdge(), SUMOVehicleParserHelper::parseFlowAttributes(), SUMOVehicleParserHelper::parseJMParams(), RONetHandler::parseJunction(), RONetHandler::parseLane(), NIXMLConnectionsHandler::parseLaneDefinition(), SUMOVehicleParserHelper::parseLCParams(), AGActivityGenHandler::parseStation(), SUMORouteHandler::parseStop(), RONetHandler::parseStoppingPlace(), ODDistrictHandler::parseTAZ(), SUMOVehicleParserHelper::parseVehicleAttributes(), SUMOVehicleParserHelper::parseVTypeEmbedded(), MSRouteHandler::parseWalkPositions(), NIXMLNodesHandler::processNodeType(), NIImporter_SUMO::readPosition(), NIXMLTrafficLightsHandler::removeTlConnection(), NIXMLTrafficLightsHandler::retrieveEdge(), NIXMLTrafficLightsHandler::retrieveLaneIndex(), NLHandler::setLocation(), and NIXMLEdgesHandler::setNodes().

◆ getAttributeValueSecure()

const char * SUMOSAXAttributesImpl_Cached::getAttributeValueSecure ( int  id) const
private

Returns Xerces-value of the named attribute.

It is assumed that this attribute is within the stored attributes.

Parameters
[in]idThe id of the attribute to retrieve the vale of
Returns
The xerces-value of the attribute

Definition at line 111 of file SUMOSAXAttributesImpl_Cached.cpp.

References myAttrs, and myPredefinedTagsMML.

Referenced by getBool(), getFloat(), getInt(), getLong(), getString(), and getStringSecure().

◆ getBool()

bool SUMOSAXAttributesImpl_Cached::getBool ( int  id) const
virtual

Returns the bool-value of the named (by its enum-value) attribute.

Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using TplConvert<XMLCh>::_2bool. If the attribute is empty or ==0, TplConvert<XMLCh>::_2bool throws an EmptyData-exception which is passed. If the value can not be parsed to a bool, TplConvert<XMLCh>::_2bool throws a BoolFormatException-exception which is passed.

Parameters
[in]idThe id of the attribute to return the value of
Returns
The attribute's value as a bool, if it could be read and parsed
Exceptions
EmptyDataIf the attribute is not known or the attribute value is an empty string
BoolFormatExceptionIf the attribute value can not be parsed to a bool

Implements SUMOSAXAttributes.

Definition at line 73 of file SUMOSAXAttributesImpl_Cached.cpp.

References TplConvert::_2bool(), and getAttributeValueSecure().

◆ getBoundary()

Boundary SUMOSAXAttributesImpl_Cached::getBoundary ( int  attr) const
virtual

Tries to read given attribute assuming it is a Boundary.

Parameters
[in]attrThe id of the attribute to read
Returns
The read value if given and not empty; "" if an error occured

Implements SUMOSAXAttributes.

Definition at line 197 of file SUMOSAXAttributesImpl_Cached.cpp.

References TplConvert::_2double(), getString(), StringTokenizer::next(), and StringTokenizer::size().

◆ getColor()

RGBColor SUMOSAXAttributesImpl_Cached::getColor ( ) const
virtual

Returns the value of the named attribute.

Tries to retrieve the attribute from the the attribute list.

Returns
The attribute's value as a RGBColor, if it could be read and parsed

Implements SUMOSAXAttributes.

Definition at line 169 of file SUMOSAXAttributesImpl_Cached.cpp.

References getString(), RGBColor::parseColor(), and SUMO_ATTR_COLOR.

◆ getEdgeFunc()

SumoXMLEdgeFunc SUMOSAXAttributesImpl_Cached::getEdgeFunc ( bool &  ok) const
virtual

Returns the value of the named attribute.

Tries to retrieve the attribute from the the attribute list.

Returns
The attribute's value as a SumoXMLEdgeFunc, if it could be read and parsed

Implements SUMOSAXAttributes.

Definition at line 143 of file SUMOSAXAttributesImpl_Cached.cpp.

References EDGEFUNC_NORMAL, SUMOXMLDefinitions::EdgeFunctions, StringBijection< T >::get(), getString(), hasAttribute(), and SUMO_ATTR_FUNCTION.

◆ getFloat() [1/2]

double SUMOSAXAttributesImpl_Cached::getFloat ( int  id) const
virtual

Returns the double-value of the named (by its enum-value) attribute.

Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using TplConvert<XMLCh>::_2double. If the attribute is empty or ==0, TplConvert<XMLCh>::_2double throws an EmptyData-exception which is passed. If the value can not be parsed to a double, TplConvert<XMLCh>::_2double throws a NumberFormatException-exception which is passed.

Parameters
[in]idThe id of the attribute to return the value of
Returns
The attribute's value as a float, if it could be read and parsed
Exceptions
EmptyDataIf the attribute is not known or the attribute value is an empty string
NumberFormatExceptionIf the attribute value can not be parsed to an double

Implements SUMOSAXAttributes.

Definition at line 105 of file SUMOSAXAttributesImpl_Cached.cpp.

References TplConvert::_2double(), and getAttributeValueSecure().

◆ getFloat() [2/2]

double SUMOSAXAttributesImpl_Cached::getFloat ( const std::string &  id) const
virtual

Returns the double-value of the named attribute.

Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using TplConvert<XMLCh>::_2double. If the attribute is empty or ==0, TplConvert<XMLCh>::_2double throws an EmptyData-exception which is passed. If the value can not be parsed to a double, TplConvert<XMLCh>::_2double throws a NumberFormatException-exception which is passed.

Parameters
[in]idThe name of the attribute to return the value of
Returns
The attribute's value as a float, if it could be read and parsed
Exceptions
EmptyDataIf the attribute is not known or the attribute value is an empty string
NumberFormatExceptionIf the attribute value can not be parsed to an double

Implements SUMOSAXAttributes.

Definition at line 119 of file SUMOSAXAttributesImpl_Cached.cpp.

References TplConvert::_2double(), and myAttrs.

◆ getInt()

int SUMOSAXAttributesImpl_Cached::getInt ( int  id) const
virtual

Returns the int-value of the named (by its enum-value) attribute.

Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using TplConvert<XMLCh>::_2int. If the attribute is empty or ==0, TplConvert<XMLCh>::_2int throws an EmptyData-exception which is passed. If the value can not be parsed to an int, TplConvert<XMLCh>::_2int throws a NumberFormatException-exception which is passed.

Parameters
[in]idThe id of the attribute to return the value of
Returns
The attribute's value as an int, if it could be read and parsed
Exceptions
EmptyDataIf the attribute is not known or the attribute value is an empty string
NumberFormatExceptionIf the attribute value can not be parsed to an int

Implements SUMOSAXAttributes.

Definition at line 79 of file SUMOSAXAttributesImpl_Cached.cpp.

References TplConvert::_2int(), and getAttributeValueSecure().

◆ getInternal() [1/9]

template<>
int SUMOSAXAttributes::getInternal ( const int  attr) const
inherited

Definition at line 183 of file SUMOSAXAttributes.cpp.

References SUMOSAXAttributes::getInt().

◆ getInternal() [2/9]

template<>
long long int SUMOSAXAttributes::getInternal ( const int  attr) const
inherited

Definition at line 191 of file SUMOSAXAttributes.cpp.

References SUMOSAXAttributes::getLong().

◆ getInternal() [3/9]

template<>
double SUMOSAXAttributes::getInternal ( const int  attr) const
inherited

Definition at line 199 of file SUMOSAXAttributes.cpp.

References SUMOSAXAttributes::getFloat().

◆ getInternal() [4/9]

template<>
bool SUMOSAXAttributes::getInternal ( const int  attr) const
inherited

Definition at line 207 of file SUMOSAXAttributes.cpp.

References SUMOSAXAttributes::getBool().

◆ getInternal() [5/9]

template<>
std::string SUMOSAXAttributes::getInternal ( const int  attr) const
inherited

Definition at line 215 of file SUMOSAXAttributes.cpp.

References SUMOSAXAttributes::getString().

◆ getInternal() [6/9]

template<>
RGBColor SUMOSAXAttributes::getInternal ( const int  ) const
inherited

Definition at line 227 of file SUMOSAXAttributes.cpp.

References SUMOSAXAttributes::getColor().

◆ getInternal() [7/9]

template<>
PositionVector SUMOSAXAttributes::getInternal ( const int  attr) const
inherited

Definition at line 235 of file SUMOSAXAttributes.cpp.

References SUMOSAXAttributes::getShape().

◆ getInternal() [8/9]

template<>
Boundary SUMOSAXAttributes::getInternal ( const int  attr) const
inherited

Definition at line 243 of file SUMOSAXAttributes.cpp.

References SUMOSAXAttributes::getBoundary().

◆ getInternal() [9/9]

template<typename T >
T SUMOSAXAttributes::getInternal ( const int  attr) const
protectedinherited

◆ getLong()

long long int SUMOSAXAttributesImpl_Cached::getLong ( int  id) const
virtual

Returns the long-value of the named (by its enum-value) attribute.

Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using TplConvert<XMLCh>::_2long. If the attribute is empty or ==0, TplConvert<XMLCh>::_2long throws an EmptyData-exception which is passed. If the value can not be parsed to a long, TplConvert<XMLCh>::_2long throws a NumberFormatException-exception which is passed.

Parameters
[in]idThe id of the attribute to return the value of
Returns
The attribute's value as an int, if it could be read and parsed
Exceptions
EmptyDataIf the attribute is not known or the attribute value is an empty string
NumberFormatExceptionIf the attribute value can not be parsed to an int

Implements SUMOSAXAttributes.

Definition at line 85 of file SUMOSAXAttributesImpl_Cached.cpp.

References TplConvert::_2long(), and getAttributeValueSecure().

◆ getName()

std::string SUMOSAXAttributesImpl_Cached::getName ( int  attr) const
virtual

Converts the given attribute id into a man readable string.

Returns a "?" if the attribute is not known.

Parameters
[in]attrThe id of the attribute to return the name of
Returns
The name of the described attribute

Implements SUMOSAXAttributes.

Definition at line 221 of file SUMOSAXAttributesImpl_Cached.cpp.

References myPredefinedTagsMML.

◆ getNodeType()

SumoXMLNodeType SUMOSAXAttributesImpl_Cached::getNodeType ( bool &  ok) const
virtual

Returns the value of the named attribute.

Tries to retrieve the attribute from the the attribute list.

Returns
The attribute's value as a SumoXMLNodeType, if it could be read and parsed

Implements SUMOSAXAttributes.

Definition at line 156 of file SUMOSAXAttributesImpl_Cached.cpp.

References StringBijection< T >::get(), getString(), hasAttribute(), NODETYPE_UNKNOWN, SUMOXMLDefinitions::NodeTypes, and SUMO_ATTR_TYPE.

◆ getObjectType()

const std::string& SUMOSAXAttributes::getObjectType ( ) const
inlineinherited

◆ getOpt()

template<typename T >
T SUMOSAXAttributes::getOpt ( int  attr,
const char *  objectid,
bool &  ok,
defaultValue,
bool  report = true 
) const
inherited

Tries to read given attribute assuming it is an int.

If the attribute is not existing in the current element, the default value is returned. If an error occurs on parsing (the attribute is empty, it is not numeric), "ok" is set to false. If report is true an error message is written to MsgHandler::getErrorInstance.

If the value could be read, "ok" is not changed, and the value is returned.

Parameters
[in]attrThe id of the attribute to read
[in]objectidThe name of the parsed object; used for error message generation
[out]okWhether the value could be read
[in]defaultValueThe value to return if the attribute is not within the element
[in]reportWhether errors shall be written to msg handler's error instance
Returns
The read value if given and correct; the default value if the attribute does not exist; -1 if an error occured

Definition at line 471 of file SUMOSAXAttributes.h.

References SUMOSAXAttributes::emitEmptyError(), SUMOSAXAttributes::emitFormatError(), SUMOSAXAttributes::getName(), and SUMOSAXAttributes::hasAttribute().

Referenced by NLTriggerBuilder::addAccess(), NLDiscreteEventBuilder::addAction(), NIImporter_SUMO::addConnection(), NLHandler::addConnection(), NIXMLConnectionsHandler::addCrossing(), NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addE3Entry(), NLHandler::addE3Exit(), NIImporter_SUMO::addEdge(), NIXMLEdgesHandler::addEdge(), NLHandler::addEdgeLaneMeanData(), NLHandler::addInstantE1Detector(), NIImporter_SUMO::addJunction(), NIImporter_SUMO::addLane(), NLHandler::addLane(), NIXMLEdgesHandler::addLane(), MSRouteHandler::addPersonTrip(), RORouteHandler::addPersonTrip(), ShapeHandler::addPOI(), ShapeHandler::addPoly(), NIImporter_SUMO::addProhibition(), NLHandler::addRequest(), NLHandler::addRouteProbeDetector(), NIXMLEdgesHandler::addSplit(), MSRouteHandler::addStop(), RORouteHandler::addStop(), NIXMLTrafficLightsHandler::addTlConnection(), MSRouteHandler::addWalk(), RORouteHandler::addWalk(), NIXMLConnectionsHandler::addWalkingArea(), NLHandler::addWAUTJunction(), NLHandler::beginE3Detector(), NLHandler::beginEdgeParsing(), SUMOVehicleParserHelper::beginVTypeParsing(), NLDiscreteEventBuilder::buildSaveTLStateCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchesCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchStatesCommand(), NIXMLEdgesHandler::deleteEdge(), NLTriggerBuilder::getFileName(), GNEAdditionalHandler::getFileName(), NLTriggerBuilder::getPosition(), NIImporter_SUMO::initTrafficLightLogic(), NIXMLTrafficLightsHandler::initTrafficLightLogic(), NLHandler::initTrafficLightLogic(), RODFDetectorHandler::myStartElement(), GUISettingsHandler::myStartElement(), PCTypeDefHandler::myStartElement(), NIXMLTypesHandler::myStartElement(), NIXMLConnectionsHandler::myStartElement(), MSRouteHandler::myStartElement(), RORouteHandler::myStartElement(), TrajectoriesHandler::myStartElement(), PCLoaderXML::myStartElement(), MSCalibrator::myStartElement(), NIImporter_SUMO::myStartElement(), MSLaneSpeedTrigger::myStartElement(), NLHandler::myStartElement(), NIImporter_MATSim::EdgesHandler::myStartElement(), PCLoaderOSM::NodesHandler::myStartElement(), SAXWeightsHandler::myStartElement(), MSTriggeredRerouter::myStartElement(), PCLoaderOSM::RelationsHandler::myStartElement(), PCLoaderOSM::EdgesHandler::myStartElement(), NIImporter_OpenDrive::myStartElement(), NLHandler::openJunction(), MSRouteHandler::openRoute(), RORouteHandler::openRoute(), RORouteHandler::openRouteDistribution(), RONetHandler::parseAccess(), NLTriggerBuilder::parseAndAddLotEntry(), NLTriggerBuilder::parseAndBeginParkingArea(), NLTriggerBuilder::parseAndBuildCalibrator(), NLTriggerBuilder::parseAndBuildChargingStation(), NLTriggerBuilder::parseAndBuildRerouter(), NLTriggerBuilder::parseAndBuildStoppingPlace(), SUMOVehicleParserHelper::parseCommonAttributes(), RONetHandler::parseConnection(), RONetHandler::parseEdge(), MSRouteHandler::parseFromViaTo(), RORouteHandler::parseFromViaTo(), AGActivityGenHandler::parseGeneralCityInfo(), SUMOVehicleParserHelper::parseGuiShape(), RONetHandler::parseJunction(), RONetHandler::parseLane(), NIXMLConnectionsHandler::parseLaneBound(), AGActivityGenHandler::parseParameters(), SUMORouteHandler::parseStop(), RONetHandler::parseStoppingPlace(), SUMOVehicleParserHelper::parseVehicleAttributes(), SUMOVehicleParserHelper::parseVehicleClass(), MSRouteHandler::parseWalkPositions(), NIXMLNodesHandler::processNodeType(), NIXMLNodesHandler::processTrafficLightDefinitions(), NIImporter_SUMO::readPosition(), NIXMLEdgesHandler::tryGetLaneSpread(), NIXMLEdgesHandler::tryGetShape(), and SUMOSAXAttributes::~SUMOSAXAttributes().

◆ getOptSUMOTimeReporting()

SUMOTime SUMOSAXAttributes::getOptSUMOTimeReporting ( int  attr,
const char *  objectid,
bool &  ok,
SUMOTime  defaultValue,
bool  report = true 
) const
inherited

Tries to read given attribute assuming it is a SUMOTime.

If the attribute is not existing in the current element, the default value is returned. If an error occurs on parsing (the attribute is empty, it is not numeric), "ok" is set to false. If report is true an error message is written to MsgHandler::getErrorInstance.

Otherwise, "ok" is not changed.

In dependence to the used time representation, either get<int> or get<double> is used.

Parameters
[in]attrThe id of the attribute to read
[in]objectidThe name of the parsed object; used for error message generation
[out]okWhether the value could be read
[in]defaultValueThe value to return if the attribute is not within the element
[in]reportWhether errors shall be written to msg handler's error instance
Returns
The read value if given and correct; the default value if the attribute does not exist; -1 if an error occured

Definition at line 84 of file SUMOSAXAttributes.cpp.

References SUMOSAXAttributes::emitEmptyError(), SUMOSAXAttributes::emitFormatError(), SUMOSAXAttributes::getFloat(), SUMOSAXAttributes::getName(), and SUMOSAXAttributes::hasAttribute().

Referenced by NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), MSRouteHandler::addPersonTrip(), NIImporter_SUMO::addPhase(), NLHandler::addPhase(), NLHandler::addRouteProbeDetector(), MSRouteHandler::addWalk(), NLHandler::beginE3Detector(), NLHandler::initTrafficLightLogic(), GUISettingsHandler::myStartElement(), MSCalibrator::myStartElement(), MSTriggeredRerouter::myStartElement(), NLHandler::openWAUT(), NLTriggerBuilder::parseAndBuildCalibrator(), SUMORouteHandler::parseStop(), and SUMOSAXAttributes::~SUMOSAXAttributes().

◆ getShape()

PositionVector SUMOSAXAttributesImpl_Cached::getShape ( int  attr) const
virtual

Tries to read given attribute assuming it is a PositionVector.

Parameters
[in]attrThe id of the attribute to read
Returns
The read value if given and not empty; "" if an error occured

Implements SUMOSAXAttributes.

Definition at line 175 of file SUMOSAXAttributesImpl_Cached.cpp.

References TplConvert::_2double(), getString(), StringTokenizer::hasNext(), and StringTokenizer::next().

◆ getString()

std::string SUMOSAXAttributesImpl_Cached::getString ( int  id) const
virtual

Returns the string-value of the named (by its enum-value) attribute.

Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using TplConvert<XMLCh>::_2str. If the attribute is ==0, TplConvert<XMLCh>::_2str throws an EmptyData-exception which is passed.

Parameters
[in]idThe id of the attribute to return the value of
Returns
The attribute's value as a string, if it could be read and parsed
Exceptions
EmptyDataIf the attribute is not known or the attribute value is an empty string

Implements SUMOSAXAttributes.

Definition at line 91 of file SUMOSAXAttributesImpl_Cached.cpp.

References getAttributeValueSecure().

Referenced by getBoundary(), getColor(), getEdgeFunc(), getNodeType(), getShape(), and getStringVector().

◆ getStringSecure() [1/2]

std::string SUMOSAXAttributesImpl_Cached::getStringSecure ( int  id,
const std::string &  def 
) const
virtual

Returns the string-value of the named (by its enum-value) attribute.

Tries to retrieve the attribute from the the attribute list. The retrieved attribute (which may be 0) is then parsed using TplConvert<XMLCh>::_2strSec. If the attribute is ==0, TplConvert<XMLCh>::_2strSec returns the default value.

Parameters
[in]idThe id of the attribute to return the value of
[in]defThe default value to return if the attribute is not in attributes
Returns
The attribute's value as a string, if it could be read and parsed
Exceptions
EmptyDataIf the attribute is not known or the attribute value is an empty string

Implements SUMOSAXAttributes.

Definition at line 97 of file SUMOSAXAttributesImpl_Cached.cpp.

References getAttributeValueSecure().

◆ getStringSecure() [2/2]

std::string SUMOSAXAttributesImpl_Cached::getStringSecure ( const std::string &  id,
const std::string &  def 
) const
virtual

Returns the string-value of the named (by its enum-value) attribute.

Tries to retrieve the attribute from the the attribute list. If the attribute is ==0, TplConvert<XMLCh>::_2strSec returns the default value.

Parameters
[in]idThe name of the attribute to return the value of
[in]defThe default value to return if the attribute is not in attributes
Returns
The attribute's value as a string, if it could be read and parsed

Implements SUMOSAXAttributes.

Definition at line 131 of file SUMOSAXAttributesImpl_Cached.cpp.

References myAttrs.

◆ getStringVector()

std::vector< std::string > SUMOSAXAttributesImpl_Cached::getStringVector ( int  attr) const
virtual

Tries to read given attribute assuming it is a string vector.

Parameters
[in]attrThe id of the attribute to read
Returns
The read value if given and not empty; empty vector if an error occured

Implements SUMOSAXAttributes.

Definition at line 212 of file SUMOSAXAttributesImpl_Cached.cpp.

References getString(), and SUMOSAXAttributes::parseStringVector().

◆ getSUMOTimeReporting()

SUMOTime SUMOSAXAttributes::getSUMOTimeReporting ( int  attr,
const char *  objectid,
bool &  ok,
bool  report = true 
) const
inherited

Tries to read given attribute assuming it is a SUMOTime.

If an error occurs (the attribute is not there, it is not numeric), "ok" is set to false and an error message is written to MsgHandler::getErrorInstance.

Otherwise, "ok" is not changed.

In dependence to the used time representation, either get<int> or get<double> is used.

Parameters
[in]attrThe id of the attribute to read
[in]objectidThe name of the parsed object; used for error message generation
[out]okWhether the value could be read
[in]reportWhether errors shall be written to msg handler's error instance
Returns
The read value if given and correct; -1 if an error occured

Definition at line 58 of file SUMOSAXAttributes.cpp.

References SUMOSAXAttributes::emitEmptyError(), SUMOSAXAttributes::emitFormatError(), SUMOSAXAttributes::emitUngivenError(), SUMOSAXAttributes::getFloat(), SUMOSAXAttributes::getName(), SUMOSAXAttributes::hasAttribute(), and TIME2STEPS.

Referenced by NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addPhase(), NLHandler::addRouteProbeDetector(), NLHandler::addVTypeProbeDetector(), NLHandler::addWAUTSwitch(), NLHandler::beginE3Detector(), SUMOVehicleParserHelper::beginVTypeParsing(), NLTriggerBuilder::buildVaporizer(), SUMORouteHandler::myStartElement(), TrajectoriesHandler::myStartElement(), MSCalibrator::myStartElement(), MSLaneSpeedTrigger::myStartElement(), SUMOVehicleParserHelper::parseFlowAttributes(), and SUMOSAXAttributes::~SUMOSAXAttributes().

◆ hasAttribute() [1/2]

bool SUMOSAXAttributesImpl_Cached::hasAttribute ( int  id) const
virtual

Returns the information whether the named (by its enum-value) attribute is within the current list.

Parameters
[in]idThe id of the searched attribute
Returns
Whether the attribute is within the attributes

Implements SUMOSAXAttributes.

Definition at line 63 of file SUMOSAXAttributesImpl_Cached.cpp.

References myAttrs, and myPredefinedTagsMML.

Referenced by getEdgeFunc(), and getNodeType().

◆ hasAttribute() [2/2]

bool SUMOSAXAttributesImpl_Cached::hasAttribute ( const std::string &  id) const
virtual

Returns the information whether the named attribute is within the current list.

Implements SUMOSAXAttributes.

Definition at line 125 of file SUMOSAXAttributesImpl_Cached.cpp.

References myAttrs.

◆ operator=()

SUMOSAXAttributesImpl_Cached& SUMOSAXAttributesImpl_Cached::operator= ( const SUMOSAXAttributesImpl_Cached src)
private

Invalidated assignment operator.

◆ parseStringSet()

void SUMOSAXAttributes::parseStringSet ( const std::string &  def,
std::set< std::string > &  into 
)
staticinherited

Splits the given string, stores it in a set.

Spaces, ",", and ";" are assumed to be separator characters. Though, in the case a "," or a ";" occurs, a warning is generated (once).

Parameters
[in]defThe string to split
[out]intoThe set to fill

Definition at line 166 of file SUMOSAXAttributes.cpp.

References StringTokenizer::hasNext(), SUMOSAXAttributes::myHaveInformedAboutDeprecatedDivider, StringTokenizer::next(), and WRITE_WARNING.

Referenced by SUMORouteHandler::parseStop().

◆ parseStringVector()

◆ serialize()

void SUMOSAXAttributesImpl_Cached::serialize ( std::ostream &  os) const
virtual

Prints all attribute names and values into the given stream.

Parameters
[in]osThe stream to use

Implements SUMOSAXAttributes.

Definition at line 230 of file SUMOSAXAttributesImpl_Cached.cpp.

References myAttrs.

Field Documentation

◆ ENCODING

const std::string SUMOSAXAttributes::ENCODING = " encoding=\"UTF-8\""
staticinherited

The encoding of parsed strings.

Definition at line 384 of file SUMOSAXAttributes.h.

Referenced by OptionsCont::writeConfiguration(), OptionsCont::writeSchema(), and OptionsCont::writeXMLHeader().

◆ myAttrs

std::map<std::string, std::string> SUMOSAXAttributesImpl_Cached::myAttrs
private

The encapsulated attributes.

Definition at line 300 of file SUMOSAXAttributesImpl_Cached.h.

Referenced by clone(), getAttributeValueSecure(), getFloat(), getStringSecure(), hasAttribute(), and serialize().

◆ myPredefinedTagsMML

const std::map<int, std::string>& SUMOSAXAttributesImpl_Cached::myPredefinedTagsMML
private

Map of attribute ids to their (readable) string-representation.

Definition at line 303 of file SUMOSAXAttributesImpl_Cached.h.

Referenced by clone(), getAttributeValueSecure(), getName(), and hasAttribute().


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