SUMOSAXAttributes Class Reference

Encapsulated SAX-Attributes. More...

#include <SUMOSAXAttributes.h>

Inheritance diagram for SUMOSAXAttributes:

Public Member Functions
template<>
std::string	fromString (const std::string &value) const
template<>
int	fromString (const std::string &value) const
template<>
long long int	fromString (const std::string &value) const
template<>
double	fromString (const std::string &value) const
template<>
bool	fromString (const std::string &value) const
template<>
RGBColor	fromString (const std::string &value) const
template<>
Position	fromString (const std::string &value) const
template<>
PositionVector	fromString (const std::string &value) const
template<>
Boundary	fromString (const std::string &value) const
template<>
SumoXMLEdgeFunc	fromString (const std::string &value) const
template<>
SumoXMLNodeType	fromString (const std::string &value) const
template<>
RightOfWay	fromString (const std::string &value) const
template<>
FringeType	fromString (const std::string &value) const
template<>
ParkingType	fromString (const std::string &value) const
template<>
std::vector< std::string >	fromString (const std::string &value) const
template<>
std::vector< int >	fromString (const std::string &value) const
template<>
std::vector< double >	fromString (const std::string &value) const
template<typename T >
T	get (int attr, const char *objectid, bool &ok, bool report=true) const
	Tries to read given attribute assuming it is an int.
template<typename T >
T	getOpt (int attr, const char *objectid, bool &ok, T defaultValue=T(), bool report=true) const
	Tries to read given attribute assuming it is an int.
SUMOTime	getOptOffsetReporting (int attr, const char *objectid, bool &ok, SUMOTime defaultValue, bool report=true) const
	Tries to read given attribute assuming it is a tls offset (SUMOTime or "begin")
SUMOTime	getOptPeriod (const char *objectid, bool &ok, SUMOTime defaultValue, bool report=true) const
	Tries to read the SUMOTime 'period' attribute.
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.
SUMOTime	getPeriod (const char *objectid, bool &ok, bool report=true) const
	Tries to read the SUMOTime 'period' attribute.
SUMOTime	getSUMOTimeReporting (int attr, const char *objectid, bool &ok, bool report=true) const
	Tries to read given attribute assuming it is a SUMOTime.
	SUMOSAXAttributes (const std::string &objectType)
virtual	~SUMOSAXAttributes ()
	Destructor.

virtual methods for retrieving attribute values
static const std::string	ENCODING = " encoding=\"UTF-8\""
	The encoding of parsed strings.
std::string	myObjectType
	the object type to use in error reporting
virtual bool	hasAttribute (int id) const =0
	Returns the information whether the named (by its enum-value) attribute is within the current list.
virtual bool	hasAttribute (const std::string &id) const =0
	Returns the information whether the named attribute is within the current list.
bool	getBool (int id) const
	Returns the bool-value of the named (by its enum-value) attribute.
int	getInt (int id) const
	Returns the int-value of the named (by its enum-value) attribute.
virtual long long int	getLong (int id) const
	Returns the long-value of the named (by its enum-value) attribute.
virtual std::string	getString (int id, bool *isPresent=nullptr) const =0
	Returns the string-value of the named (by its enum-value) attribute.
virtual std::string	getStringSecure (int id, const std::string &def) const =0
	Returns the string-value of the named (by its enum-value) attribute.
double	getFloat (int id) const
	Returns the double-value of the named (by its enum-value) attribute.
virtual double	getFloat (const std::string &id) const =0
	Returns the double-value of the named attribute.
virtual std::string	getStringSecure (const std::string &id, const std::string &def) const =0
	Returns the string-value of the named (by its enum-value) attribute.
virtual std::string	getName (int attr) const =0
	Converts the given attribute id into a man readable string.
virtual void	serialize (std::ostream &os) const =0
	Prints all attribute names and values into the given stream.
virtual std::vector< std::string >	getAttributeNames () const =0
	Retrieves all attribute names.
const std::string &	getObjectType () const
	return the objecttype to which these attributes belong
virtual SUMOSAXAttributes *	clone () const =0
	return a new deep-copy attributes object
std::ostream &	operator<< (std::ostream &os, const SUMOSAXAttributes &src)
template<typename T >
T	fromString (const std::string &value) 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
	SUMOSAXAttributes (const SUMOSAXAttributes &src)=delete
	Invalidated copy constructor.
SUMOSAXAttributes &	operator= (const SUMOSAXAttributes &src)=delete
	Invalidated assignment operator.

Detailed Description

Encapsulated SAX-Attributes.

This class is an interface for using encapsulated SAX-attributes. Encapsulation is done to allow a common access without the need to import all the Xerces-definitions.

Definition at line 56 of file SUMOSAXAttributes.h.

Constructor & Destructor Documentation

SUMOSAXAttributes() [1/2]

SUMOSAXAttributes::SUMOSAXAttributes

(

const std::string &

objectType

)

Definition at line 45 of file SUMOSAXAttributes.cpp.

~SUMOSAXAttributes()

virtual SUMOSAXAttributes::~SUMOSAXAttributes ( )

inlinevirtual

Destructor.

Definition at line 65 of file SUMOSAXAttributes.h.

SUMOSAXAttributes() [2/2]

SUMOSAXAttributes::SUMOSAXAttributes ( const SUMOSAXAttributes &  src )

privatedelete

Invalidated copy constructor.

Member Function Documentation

clone()

virtual SUMOSAXAttributes * SUMOSAXAttributes::clone ( ) const

pure virtual

return a new deep-copy attributes object

Implemented in SUMOSAXAttributesImpl_Cached, and SUMOSAXAttributesImpl_Xerces.

Referenced by MSStateHandler::myStartElement().

Here is the caller graph for this function:

emitEmptyError()

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

protected

Definition at line 220 of file SUMOSAXAttributes.cpp.

References myObjectType, and WRITE_ERROR.

Referenced by get(), getOpt(), getOptOffsetReporting(), getOptPeriod(), getOptSUMOTimeReporting(), getPeriod(), and getSUMOTimeReporting().

Here is the caller graph for this function:

emitFormatError()

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

protected

Definition at line 234 of file SUMOSAXAttributes.cpp.

References myObjectType, and WRITE_ERROR.

Referenced by get(), getOpt(), getOptOffsetReporting(), getOptPeriod(), getOptSUMOTimeReporting(), getPeriod(), and getSUMOTimeReporting().

Here is the caller graph for this function:

emitUngivenError()

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

protected

Definition at line 206 of file SUMOSAXAttributes.cpp.

References myObjectType, and WRITE_ERROR.

Referenced by get(), getPeriod(), and getSUMOTimeReporting().

Here is the caller graph for this function:

fromString() [1/18]

template<>

std::string SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 51 of file SUMOSAXAttributes.cpp.

fromString() [2/18]

template<>

int SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 249 of file SUMOSAXAttributes.cpp.

References StringUtils::toInt().

fromString() [3/18]

template<>

long long int SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 256 of file SUMOSAXAttributes.cpp.

References StringUtils::toLong().

fromString() [4/18]

template<>

double SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 263 of file SUMOSAXAttributes.cpp.

References StringUtils::toDouble().

fromString() [5/18]

template<>

bool SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 270 of file SUMOSAXAttributes.cpp.

References StringUtils::toBool().

fromString() [6/18]

template<>

RGBColor SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 277 of file SUMOSAXAttributes.cpp.

References RGBColor::parseColor().

fromString() [7/18]

template<>

Position SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 284 of file SUMOSAXAttributes.cpp.

References StringTokenizer::hasNext(), StringTokenizer::next(), StringTokenizer::size(), and StringUtils::toDouble().

fromString() [8/18]

template<>

PositionVector SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 313 of file SUMOSAXAttributes.cpp.

References StringTokenizer::hasNext(), StringTokenizer::next(), StringTokenizer::size(), and StringUtils::toDouble().

fromString() [9/18]

template<>

Boundary SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 336 of file SUMOSAXAttributes.cpp.

References StringTokenizer::next(), StringTokenizer::size(), and StringUtils::toDouble().

fromString() [10/18]

template<>

SumoXMLEdgeFunc SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 351 of file SUMOSAXAttributes.cpp.

References SUMOXMLDefinitions::EdgeFunctions, and StringBijection< T >::get().

fromString() [11/18]

template<>

SumoXMLNodeType SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 361 of file SUMOSAXAttributes.cpp.

References StringBijection< T >::get(), and SUMOXMLDefinitions::NodeTypes.

fromString() [12/18]

template<>

RightOfWay SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 371 of file SUMOSAXAttributes.cpp.

References StringBijection< T >::get(), and SUMOXMLDefinitions::RightOfWayValues.

fromString() [13/18]

template<>

FringeType SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 381 of file SUMOSAXAttributes.cpp.

References SUMOXMLDefinitions::FringeTypeValues, and StringBijection< T >::get().

fromString() [14/18]

template<>

ParkingType SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 391 of file SUMOSAXAttributes.cpp.

References OFFROAD, ONROAD, OPPORTUNISTIC, StringUtils::toBool(), and toString().

fromString() [15/18]

template<>

std::vector< std::string > SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 402 of file SUMOSAXAttributes.cpp.

References StringTokenizer::getVector().

fromString() [16/18]

template<>

std::vector< int > SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 413 of file SUMOSAXAttributes.cpp.

References StringTokenizer::getVector(), and StringUtils::toInt().

fromString() [17/18]

template<>

std::vector< double > SUMOSAXAttributes::fromString

(

const std::string &

value

)

const

Definition at line 428 of file SUMOSAXAttributes.cpp.

References StringTokenizer::getVector(), and StringUtils::toDouble().

fromString() [18/18]

template<typename T >

T SUMOSAXAttributes::fromString ( const std::string &  value ) const

protected

get()

template<typename T >

T SUMOSAXAttributes::get	(	int	attr,
		const char *	objectid,
		bool &	ok,
		bool	report = true
	)		const

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]	attr	The id of the attribute to read
[in]	objectid	The name of the parsed object; used for error message generation
[out]	ok	Whether the value could be read
[in]	report	Whether errors shall be written to msg handler's error instance

Returns

The read value if given and correct; -1 if an error occurred

Definition at line 454 of file SUMOSAXAttributes.h.

References emitEmptyError(), emitFormatError(), emitUngivenError(), getName(), and getString().

Referenced by NIXMLPTHandler::addAccess(), NLHandler::addAssignment(), NLHandler::addCondition(), NLHandler::addConflict(), NIImporter_SUMO::addConnection(), NLHandler::addConnection(), NLNetShapeHandler::addConnection(), NIXMLConnectionsHandler::addCrossing(), NLHandler::addDeadlock(), NLHandler::addDistrict(), NLHandler::addDistrictEdge(), NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addE3Entry(), NLHandler::addE3Exit(), NIImporter_SUMO::addEdge(), NIXMLEdgesHandler::addEdge(), NLHandler::addEdgeLaneMeanData(), ROJTRTurnDefLoader::addEdgeRel(), NLHandler::addFunction(), NLHandler::addInstantE1Detector(), NIXMLNodesHandler::addJoinCluster(), NIXMLNodesHandler::addJoinExclusion(), NIImporter_SUMO::addJunction(), NLNetShapeHandler::addJunction(), NIImporter_SUMO::addLane(), NIXMLEdgesHandler::addLane(), NLHandler::addLane(), NLNetShapeHandler::addLane(), NIXMLNodesHandler::addNode(), NLHandler::addParam(), RONetHandler::addParam(), SUMORouteHandler::addParam(), NLHandler::addPhase(), NIImporter_SUMO::addPhase(), ShapeHandler::addPOI(), ShapeHandler::addPoly(), NLHandler::addPredecessorConstraint(), NIXMLPTHandler::addPTLine(), NIXMLPTHandler::addPTLineFromFlow(), NIXMLPTHandler::addPTLineRoute(), NIXMLPTHandler::addPTLineStop(), NIXMLPTHandler::addPTStop(), NIImporter_SUMO::addRequest(), NLHandler::addRequest(), RORouteHandler::addRide(), MSRouteHandler::addRideOrTransport(), NIImporter_SUMO::addRoundabout(), NIXMLEdgesHandler::addRoundabout(), NLHandler::addRoundabout(), NIXMLPTHandler::addRoute(), NLHandler::addRouteProbeDetector(), NIXMLPTHandler::addRouteStop(), NIXMLEdgesHandler::addSplit(), MSRouteHandler::addStop(), RORouteHandler::addStop(), ROJTRTurnDefLoader::addToEdge(), MSRouteHandler::addTranship(), RORouteHandler::addTransport(), NLHandler::addVTypeProbeDetector(), MSRouteHandler::addWalk(), RORouteHandler::addWalk(), NIXMLConnectionsHandler::addWalkingArea(), NLHandler::addWAUTJunction(), NLHandler::addWAUTSwitch(), NLHandler::beginE3Detector(), NLHandler::beginEdgeParsing(), ROJTRTurnDefLoader::beginFromEdge(), SUMOVehicleParserHelper::beginVTypeParsing(), NLTriggerBuilder::buildVaporizer(), NIXMLConnectionsHandler::delConnection(), NIXMLEdgesHandler::deleteEdge(), NIXMLNodesHandler::deleteNode(), NLTriggerBuilder::getLane(), NLTriggerBuilder::getPosition(), NLHandler::initJunctionLogic(), NLHandler::initTrafficLightLogic(), NIImporter_SUMO::initTrafficLightLogic(), NIXMLTrafficLightsHandler::initTrafficLightLogic(), NIImporter_SUMO::loadLocation(), MSDevice_Vehroutes::loadState(), MSRailSignalConstraint_Predecessor::loadState(), MSDriveWay::loadState(), RODFDetectorHandler::myStartElement(), ROJTRTurnDefLoader::myStartElement(), MSStateHandler::myStartElement(), NIImporter_MATSim::NodesHandler::myStartElement(), NIImporter_MATSim::EdgesHandler::myStartElement(), NIImporter_OpenDrive::myStartElement(), NIImporter_SUMO::myStartElement(), NIXMLConnectionsHandler::myStartElement(), NIXMLEdgesHandler::myStartElement(), NIXMLNodesHandler::myStartElement(), NIXMLPTHandler::myStartElement(), NIXMLTrafficLightsHandler::myStartElement(), NIXMLTypesHandler::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_Streckendefinition::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_Zuflussdefinition::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_Parkplatzdefinition::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_Fahrzeugklassendefinition::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_VWunschentscheidungsdefinition::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_Geschwindigkeitsverteilungsdefinition::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_Routenentscheidungsdefinition::myStartElement(), NIImporter_Vissim::NIVissimXMLHandler_ConflictArea::myStartElement(), NLHandler::myStartElement(), ODAmitranHandler::myStartElement(), PCLoaderOSM::NodesHandler::myStartElement(), PCLoaderOSM::RelationsHandler::myStartElement(), PCLoaderOSM::EdgesHandler::myStartElement(), PCLoaderXML::myStartElement(), PCNetProjectionLoader::myStartElement(), PCTypeDefHandler::myStartElement(), RONetHandler::myStartElement(), TrajectoriesHandler::myStartElement(), GUISettingsHandler::myStartElement(), ShapeHandler::myStartElement(), NIImporter_OpenStreetMap::NodesHandler::myStartElement(), NIImporter_OpenStreetMap::EdgesHandler::myStartElement(), NIImporter_OpenStreetMap::RelationHandler::myStartElement(), ODDistrictHandler::openDistrict(), NLHandler::openJunction(), MSRouteHandler::openRoute(), RORouteHandler::openRoute(), MSRouteHandler::openRouteDistribution(), RORouteHandler::openRouteDistribution(), MSRouteHandler::openVehicleTypeDistribution(), RORouteHandler::openVehicleTypeDistribution(), NLHandler::openWAUT(), RONetHandler::parseAccess(), AdditionalHandler::parseAccessAttributes(), NLTriggerBuilder::parseAndAddLotEntry(), NLTriggerBuilder::parseAndBeginParkingArea(), NLTriggerBuilder::parseAndBuildCalibrator(), NLTriggerBuilder::parseAndBuildChargingStation(), NLTriggerBuilder::parseAndBuildLaneSpeedTrigger(), NLTriggerBuilder::parseAndBuildOverheadWireClamp(), NLTriggerBuilder::parseAndBuildOverheadWireSection(), NLTriggerBuilder::parseAndBuildOverheadWireSegment(), NLTriggerBuilder::parseAndBuildRerouter(), NLTriggerBuilder::parseAndBuildStoppingPlace(), NLTriggerBuilder::parseAndBuildTractionSubstation(), AdditionalHandler::parseBusStopAttributes(), AdditionalHandler::parseCalibratorAttributes(), AdditionalHandler::parseCalibratorFlowAttributes(), SUMOVehicleParserHelper::parseCFMParams(), AdditionalHandler::parseChargingStationAttributes(), AdditionalHandler::parseClosingLaneRerouteAttributes(), AdditionalHandler::parseClosingRerouteAttributes(), SUMOVehicleParserHelper::parseCommonAttributes(), NIXMLConnectionsHandler::parseConnection(), RONetHandler::parseConnection(), AdditionalHandler::parseContainerStopAttributes(), NIXMLConnectionsHandler::parseDeprecatedLaneDefinition(), AdditionalHandler::parseDestProbRerouteAttributes(), RONetHandler::parseDistrict(), RONetHandler::parseDistrictEdge(), AdditionalHandler::parseE1Attributes(), AdditionalHandler::parseE1InstantAttributes(), AdditionalHandler::parseE2Attributes(), AdditionalHandler::parseE3Attributes(), RONetHandler::parseEdge(), DataHandler::parseEdgeData(), MeanDataHandler::parseEdgeMeanData(), DataHandler::parseEdgeRelationData(), AdditionalHandler::parseEntryAttributes(), AdditionalHandler::parseExitAttributes(), RouteHandler::parseFlow(), SUMOVehicleParserHelper::parseFlowAttributes(), MSRouteHandler::parseFromViaTo(), RORouteHandler::parseFromViaTo(), SUMOVehicleParserHelper::parseID(), DataHandler::parseInterval(), SUMOVehicleParserHelper::parseJMParams(), AdditionalHandler::parseJpsObstacleAttributes(), AdditionalHandler::parseJpsWalkableAreaAttributes(), RONetHandler::parseJunction(), RONetHandler::parseLane(), NIXMLConnectionsHandler::parseLaneBound(), NIXMLConnectionsHandler::parseLaneDefinition(), MeanDataHandler::parseLaneMeanData(), SUMOVehicleParserHelper::parseLCParams(), AdditionalHandler::parseOverheadWire(), AdditionalHandler::parseOverheadWireClamp(), AdditionalHandler::parseParameters(), RouteHandler::parseParameters(), AdditionalHandler::parseParkingAreaAttributes(), AdditionalHandler::parseParkingAreaRerouteAttributes(), AdditionalHandler::parseParkingSpaceAttributes(), AdditionalHandler::parsePOIAttributes(), AdditionalHandler::parsePolyAttributes(), AdditionalHandler::parseRerouterAttributes(), RouteHandler::parseRoute(), RouteHandler::parseRouteDistribution(), AdditionalHandler::parseRouteProbeAttributes(), AdditionalHandler::parseRouteProbRerouteAttributes(), AGActivityGenHandler::parseStation(), SUMORouteHandler::parseStop(), RouteHandler::parseStopParameters(), RONetHandler::parseStoppingPlace(), ODDistrictHandler::parseTAZ(), AdditionalHandler::parseTAZAttributes(), DataHandler::parseTAZRelationData(), AdditionalHandler::parseTAZSinkAttributes(), AdditionalHandler::parseTAZSourceAttributes(), AdditionalHandler::parseTractionSubstation(), AdditionalHandler::parseTrainStopAttributes(), RouteHandler::parseTrip(), AdditionalHandler::parseVaporizerAttributes(), AdditionalHandler::parseVariableSpeedSignAttributes(), SUMOVehicleParserHelper::parseVehicleAttributes(), RouteHandler::parseVTypeDistribution(), MSRouteHandler::parseWalkPositions(), RORouteHandler::parseWalkPositions(), NIXMLNodesHandler::processNodeType(), NIXMLNodesHandler::processTrafficLightDefinitions(), NIImporter_SUMO::readPosition(), NIXMLTrafficLightsHandler::removeTlConnection(), NIXMLTrafficLightsHandler::retrieveEdge(), NIXMLTrafficLightsHandler::retrieveLaneIndex(), NLHandler::setLocation(), RONetHandler::setLocation(), NIXMLEdgesHandler::setNodes(), SAXWeightsHandler::tryParseEdgeRel(), and SAXWeightsHandler::tryParseTazRel().

getAttributeNames()

virtual std::vector< std::string > SUMOSAXAttributes::getAttributeNames ( ) const

pure virtual

Retrieves all attribute names.

Implemented in SUMOSAXAttributesImpl_Cached, and SUMOSAXAttributesImpl_Xerces.

Referenced by DataHandler::getAttributes(), and GUINet::DiscoverAttributes::myStartElement().

Here is the caller graph for this function:

getBool()

bool SUMOSAXAttributes::getBool ( int  id ) const

inline

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

Tries to retrieve the attribute from 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]

id

The 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

EmptyData	If the attribute is not known or the attribute value is an empty string
BoolFormatException	If the attribute value can not be parsed to a bool

Definition at line 244 of file SUMOSAXAttributes.h.

References getString(), and StringUtils::toBool().

getFloat() [1/2]

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

pure virtual

Returns the double-value of the named attribute.

Tries to retrieve the attribute from 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]

id

The 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

EmptyData	If the attribute is not known or the attribute value is an empty string
NumberFormatException	If the attribute value can not be parsed to an double

Implemented in SUMOSAXAttributesImpl_Cached, and SUMOSAXAttributesImpl_Xerces.

getFloat() [2/2]

double SUMOSAXAttributes::getFloat ( int  id ) const

inline

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

Tries to retrieve the attribute from 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]

id

The 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

EmptyData	If the attribute is not known or the attribute value is an empty string
NumberFormatException	If the attribute value can not be parsed to an double

Definition at line 333 of file SUMOSAXAttributes.h.

References getString(), and StringUtils::toDouble().

Referenced by NIImporter_SUMO::addLane(), MSStateHandler::closeVehicle(), MSVehicle::loadState(), MSStateHandler::myEndElement(), VehicleEngineHandler::myStartElement(), TrajectoriesHandler::myStartElement(), AGActivityGenHandler::parseBusStation(), AGActivityGenHandler::parseCityGates(), AGActivityGenHandler::parseClosingHour(), AGActivityGenHandler::parseOpeningHour(), AGActivityGenHandler::parseSchool(), AGActivityGenHandler::parseStreets(), SAXWeightsHandler::tryParse(), SAXWeightsHandler::tryParseEdgeRel(), and SAXWeightsHandler::tryParseTazRel().

Here is the caller graph for this function:

getInt()

int SUMOSAXAttributes::getInt ( int  id ) const

inline

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

Tries to retrieve the attribute from 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]

id

The 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

EmptyData	If the attribute is not known or the attribute value is an empty string
NumberFormatException	If the attribute value can not be parsed to an int

Definition at line 263 of file SUMOSAXAttributes.h.

References getString(), and StringUtils::toInt().

Referenced by MSStateHandler::myEndElement(), VehicleEngineHandler::myStartElement(), MSStateHandler::myStartElement(), AGActivityGenHandler::parseBracket(), AGActivityGenHandler::parseBusLine(), AGActivityGenHandler::parseBusStation(), AGActivityGenHandler::parseClosingHour(), AGActivityGenHandler::parseFrequency(), AGActivityGenHandler::parseGeneralCityInfo(), AGActivityGenHandler::parseOpeningHour(), and AGActivityGenHandler::parseSchool().

Here is the caller graph for this function:

getLong()

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

inlinevirtual

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

Tries to retrieve the attribute from 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]

id

The 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

EmptyData	If the attribute is not known or the attribute value is an empty string
NumberFormatException	If the attribute value can not be parsed to an int

Definition at line 283 of file SUMOSAXAttributes.h.

References getString(), and StringUtils::toLong().

Referenced by MSVehicleTransfer::loadState().

Here is the caller graph for this function:

getName()

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

pure virtual

Converts the given attribute id into a man readable string.

Parameters

[in]

attr

The id of the attribute to return the name of

Returns

The name of the described attribute

Implemented in SUMOSAXAttributesImpl_Cached, and SUMOSAXAttributesImpl_Xerces.

Referenced by get(), getOpt(), getOptOffsetReporting(), getOptPeriod(), getOptSUMOTimeReporting(), getPeriod(), getSUMOTimeReporting(), and SUMOVehicleParserHelper::parseFlowAttributes().

Here is the caller graph for this function:

getObjectType()

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

inline

return the objecttype to which these attributes belong

Definition at line 388 of file SUMOSAXAttributes.h.

References myObjectType.

Referenced by SUMOSAXAttributesImpl_Cached::clone(), SUMOSAXAttributesImpl_Xerces::clone(), SUMOVehicleParserHelper::parseGuiShape(), ODDistrictHandler::parseTAZ(), and SUMOVehicleParserHelper::parseVehicleClass().

Here is the caller graph for this function:

getOpt()

template<typename T >

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

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]	attr	The id of the attribute to read
[in]	objectid	The name of the parsed object; used for error message generation
[out]	ok	Whether the value could be read
[in]	defaultValue	The value to return if the attribute is not within the element
[in]	report	Whether 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 occurred

Definition at line 480 of file SUMOSAXAttributes.h.

References emitEmptyError(), emitFormatError(), getName(), and getString().

Referenced by NIXMLPTHandler::addAccess(), NLTriggerBuilder::addAccess(), NLDiscreteEventBuilder::addAction(), NIImporter_SUMO::addConnection(), NLHandler::addConnection(), NIXMLConnectionsHandler::addCrossing(), NLHandler::addDistrict(), NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addE3Entry(), NLHandler::addE3Exit(), NIImporter_SUMO::addEdge(), NIXMLEdgesHandler::addEdge(), NLHandler::addEdgeLaneMeanData(), NLHandler::addInstantE1Detector(), NIXMLNodesHandler::addJoinCluster(), NIImporter_SUMO::addJunction(), NLNetShapeHandler::addJunction(), NIImporter_SUMO::addLane(), NIXMLEdgesHandler::addLane(), NLHandler::addLane(), NLHandler::addMesoEdgeType(), MSRouteHandler::addPersonTrip(), RORouteHandler::addPersonTrip(), NLHandler::addPhase(), NIImporter_SUMO::addPhase(), ShapeHandler::addPOI(), ShapeHandler::addPoly(), NLHandler::addPredecessorConstraint(), NIImporter_SUMO::addProhibition(), NIXMLConnectionsHandler::addProhibition(), NIXMLPTHandler::addPTLine(), NIXMLPTHandler::addPTLineFromFlow(), NIXMLPTHandler::addPTStop(), NLHandler::addRequest(), RORouteHandler::addRide(), MSRouteHandler::addRideOrTransport(), NLHandler::addRouteProbeDetector(), NIXMLEdgesHandler::addSplit(), MSRouteHandler::addStop(), RORouteHandler::addStop(), NIXMLTrafficLightsHandler::addTlConnection(), MSRouteHandler::addTranship(), MSRouteHandler::addWalk(), RORouteHandler::addWalk(), NIXMLConnectionsHandler::addWalkingArea(), NLHandler::addWAUTJunction(), NLHandler::beginE3Detector(), NLHandler::beginEdgeParsing(), SUMOVehicleParserHelper::beginVTypeParsing(), NLDiscreteEventBuilder::buildSaveTLSProgramCommand(), NLDiscreteEventBuilder::buildSaveTLStateCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchesCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchStatesCommand(), NIXMLEdgesHandler::deleteEdge(), NLTriggerBuilder::getFileName(), NLTriggerBuilder::getParkingArea(), NLTriggerBuilder::getPosition(), NLHandler::initTrafficLightLogic(), NIImporter_SUMO::initTrafficLightLogic(), NIXMLTrafficLightsHandler::initTrafficLightLogic(), MSVehicleTransfer::loadState(), MSDriveWay::loadState(), RODFDetectorHandler::myStartElement(), MSStateHandler::myStartElement(), MSCalibrator::myStartElement(), MSLaneSpeedTrigger::myStartElement(), MSTriggeredRerouter::myStartElement(), NIImporter_MATSim::EdgesHandler::myStartElement(), NIImporter_OpenDrive::myStartElement(), NIImporter_SUMO::myStartElement(), NIXMLTypesHandler::myStartElement(), NLHandler::myStartElement(), PCLoaderOSM::NodesHandler::myStartElement(), PCLoaderOSM::RelationsHandler::myStartElement(), PCLoaderOSM::EdgesHandler::myStartElement(), PCLoaderXML::myStartElement(), PCTypeDefHandler::myStartElement(), TrajectoriesHandler::myStartElement(), GUISettingsHandler::myStartElement(), SAXWeightsHandler::myStartElement(), MSDevice_FCDReplay::FCDHandler::myStartElement(), NIImporter_OpenStreetMap::NodesHandler::myStartElement(), NIImporter_OpenStreetMap::EdgesHandler::myStartElement(), NIImporter_OpenStreetMap::RelationHandler::myStartElement(), NLHandler::openJunction(), MSRouteHandler::openRoute(), RORouteHandler::openRoute(), RORouteHandler::openRouteDistribution(), RONetHandler::parseAccess(), AdditionalHandler::parseAccessAttributes(), NLTriggerBuilder::parseAndAddLotEntry(), NLTriggerBuilder::parseAndBeginParkingArea(), NLTriggerBuilder::parseAndBuildCalibrator(), NLTriggerBuilder::parseAndBuildChargingStation(), NLTriggerBuilder::parseAndBuildOverheadWireSection(), NLTriggerBuilder::parseAndBuildOverheadWireSegment(), NLTriggerBuilder::parseAndBuildRerouter(), NLTriggerBuilder::parseAndBuildStoppingPlace(), NLTriggerBuilder::parseAndBuildTractionSubstation(), AdditionalHandler::parseBusStopAttributes(), AdditionalHandler::parseCalibratorAttributes(), AdditionalHandler::parseChargingStationAttributes(), AdditionalHandler::parseClosingLaneRerouteAttributes(), AdditionalHandler::parseClosingRerouteAttributes(), NIXMLConnectionsHandler::parseConnection(), RONetHandler::parseConnection(), AdditionalHandler::parseContainerStopAttributes(), AdditionalHandler::parseDestProbRerouteAttributes(), AdditionalHandler::parseE1Attributes(), AdditionalHandler::parseE1InstantAttributes(), AdditionalHandler::parseE2Attributes(), AdditionalHandler::parseE3Attributes(), RONetHandler::parseEdge(), MeanDataHandler::parseEdgeMeanData(), AdditionalHandler::parseEntryAttributes(), AdditionalHandler::parseExitAttributes(), RouteHandler::parseFlow(), MSRouteHandler::parseFromViaTo(), RORouteHandler::parseFromViaTo(), AGActivityGenHandler::parseGeneralCityInfo(), SUMOVehicleParserHelper::parseGuiShape(), AdditionalHandler::parseJpsObstacleAttributes(), AdditionalHandler::parseJpsWalkableAreaAttributes(), RONetHandler::parseJunction(), RONetHandler::parseLane(), NIXMLConnectionsHandler::parseLaneBound(), MeanDataHandler::parseLaneMeanData(), AdditionalHandler::parseOverheadWire(), AGActivityGenHandler::parseParameters(), AdditionalHandler::parseParkingAreaAttributes(), AdditionalHandler::parseParkingAreaRerouteAttributes(), AdditionalHandler::parseParkingSpaceAttributes(), RouteHandler::parsePersonTrip(), AdditionalHandler::parsePOIAttributes(), AdditionalHandler::parsePolyAttributes(), AdditionalHandler::parseRerouterAttributes(), RouteHandler::parseRide(), RouteHandler::parseRoute(), RouteHandler::parseRouteDistribution(), AdditionalHandler::parseRouteProbeAttributes(), AdditionalHandler::parseRouteProbRerouteAttributes(), SUMORouteHandler::parseStop(), RouteHandler::parseStopParameters(), RONetHandler::parseStoppingPlace(), AdditionalHandler::parseTAZAttributes(), AdditionalHandler::parseTractionSubstation(), AdditionalHandler::parseTrainStopAttributes(), RouteHandler::parseTranship(), RouteHandler::parseTransport(), RouteHandler::parseTrip(), AdditionalHandler::parseVaporizerAttributes(), AdditionalHandler::parseVariableSpeedSignAttributes(), AdditionalHandler::parseVariableSpeedSignStepAttributes(), SUMOVehicleParserHelper::parseVehicleAttributes(), SUMOVehicleParserHelper::parseVehicleClass(), RouteHandler::parseVTypeDistribution(), RouteHandler::parseWalk(), RORouteHandler::parseWalkPositions(), CommonXMLStructure::PlanParameters::PlanParameters(), NIXMLNodesHandler::processNodeType(), NIXMLNodesHandler::processTrafficLightDefinitions(), NIImporter_SUMO::readPosition(), RORouteHandler::retrieveStoppingPlace(), MSRouteHandler::retrieveStoppingPlace(), StopOffset::StopOffset(), NIXMLEdgesHandler::tryGetLaneSpread(), and NIXMLEdgesHandler::tryGetShape().

getOptOffsetReporting()

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

Tries to read given attribute assuming it is a tls offset (SUMOTime or "begin")

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]	attr	The id of the attribute to read
[in]	objectid	The name of the parsed object; used for error message generation
[out]	ok	Whether the value could be read
[in]	defaultValue	The value to return if the attribute is not within the element
[in]	report	Whether 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 occurred

Definition at line 147 of file SUMOSAXAttributes.cpp.

References emitEmptyError(), emitFormatError(), getName(), getString(), string2time(), and SUMOTime_MAX.

Referenced by NLHandler::initTrafficLightLogic(), NIImporter_SUMO::initTrafficLightLogic(), and NIXMLTrafficLightsHandler::initTrafficLightLogic().

Here is the caller graph for this function:

getOptPeriod()

SUMOTime SUMOSAXAttributes::getOptPeriod	(	const char *	objectid,
		bool &	ok,
		SUMOTime	defaultValue,
		bool	report = true
	)		const

Tries to read the SUMOTime 'period' attribute.

If 'period' cannot be found, tries 'freq' as an alias.

If both attributes do not exist 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]	objectid	The name of the parsed object; used for error message generation
[out]	ok	Whether the value could be read
[in]	defaultValue	The value to return if the attribute is not within the element
[in]	report	Whether 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 occurred

Definition at line 175 of file SUMOSAXAttributes.cpp.

References emitEmptyError(), emitFormatError(), getName(), getString(), string2time(), SUMO_ATTR_FREQUENCY, and SUMO_ATTR_PERIOD.

Referenced by NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), NLHandler::addRouteProbeDetector(), NLHandler::addVTypeProbeDetector(), NLHandler::beginE3Detector(), NLTriggerBuilder::parseAndBuildCalibrator(), AdditionalHandler::parseCalibratorAttributes(), AdditionalHandler::parseE1Attributes(), AdditionalHandler::parseE2Attributes(), AdditionalHandler::parseE3Attributes(), and AdditionalHandler::parseRouteProbeAttributes().

Here is the caller graph for this function:

getOptSUMOTimeReporting()

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

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]	attr	The id of the attribute to read
[in]	objectid	The name of the parsed object; used for error message generation
[out]	ok	Whether the value could be read
[in]	defaultValue	The value to return if the attribute is not within the element
[in]	report	Whether 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 occurred

Definition at line 123 of file SUMOSAXAttributes.cpp.

References emitEmptyError(), emitFormatError(), getName(), getString(), and string2time().

Referenced by NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), NLHandler::addMesoEdgeType(), MSRouteHandler::addPersonTrip(), RORouteHandler::addPersonTrip(), NLHandler::addPhase(), NIImporter_SUMO::addPhase(), MSRouteHandler::addRideOrTransport(), NLHandler::addRouteProbeDetector(), MSRouteHandler::addWalk(), NLHandler::beginE3Detector(), MSStateHandler::myStartElement(), MSCalibrator::myStartElement(), MSTriggeredRerouter::myStartElement(), GUISettingsHandler::myStartElement(), MSRouteHandler::openRoute(), RORouteHandler::openRoute(), NLHandler::openWAUT(), NLTriggerBuilder::parseAndBuildChargingStation(), AdditionalHandler::parseChargingStationAttributes(), AdditionalHandler::parseE2Attributes(), AdditionalHandler::parseE3Attributes(), MeanDataHandler::parseEdgeMeanData(), MeanDataHandler::parseLaneMeanData(), AdditionalHandler::parseRerouterAttributes(), RouteHandler::parseRoute(), AdditionalHandler::parseRouteProbeAttributes(), SUMORouteHandler::parseStop(), RouteHandler::parseStopParameters(), RouteHandler::parseTranship(), and RouteHandler::parseWalk().

Here is the caller graph for this function:

getPeriod()

SUMOTime SUMOSAXAttributes::getPeriod	(	const char *	objectid,
		bool &	ok,
		bool	report = true
	)		const

Tries to read the SUMOTime 'period' attribute.

If 'period' cannot be found, tries 'freq' as an alias.

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]	objectid	The name of the parsed object; used for error message generation
[out]	ok	Whether the value could be read
[in]	report	Whether errors shall be written to msg handler's error instance

Returns

The read value if given and correct; -1 if an error occurred

Definition at line 88 of file SUMOSAXAttributes.cpp.

References emitEmptyError(), emitFormatError(), emitUngivenError(), getName(), getString(), string2time(), SUMO_ATTR_FREQUENCY, and SUMO_ATTR_PERIOD.

Referenced by NLHandler::addE2Detector().

Here is the caller graph for this function:

getString()

virtual std::string SUMOSAXAttributes::getString ( int  id, bool *  isPresent = nullptr  ) const

pure virtual

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

Tries to retrieve the attribute from 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]

id

The 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

EmptyData

If the attribute is not known or the attribute value is an empty string

Implemented in SUMOSAXAttributesImpl_Cached, and SUMOSAXAttributesImpl_Xerces.

Referenced by NLTriggerBuilder::addAccess(), NLHandler::addParam(), RONetHandler::addParam(), SUMORouteHandler::addParam(), get(), getBool(), getFloat(), getInt(), getLong(), getOpt(), getOptOffsetReporting(), getOptPeriod(), getOptSUMOTimeReporting(), getPeriod(), getSUMOTimeReporting(), MSDevice_Routing::loadState(), MSDevice_Transportable::loadState(), MSDevice_Tripinfo::loadState(), MSDevice_Vehroutes::loadState(), MSTransportableDevice_Routing::loadState(), MSAbstractLaneChangeModel::loadState(), MSRailSignalConstraint_Predecessor::loadState(), MSDevice_Battery::loadState(), MSDevice_StationFinder::loadState(), MEVehicle::loadState(), MSVehicle::loadState(), MSVehicleTransfer::loadState(), MSStateHandler::myEndElement(), ROMARouteHandler::myStartElement(), VehicleEngineHandler::myStartElement(), MSStateHandler::MSStateTimeHandler::myStartElement(), MSStateHandler::myStartElement(), GNEMultipleParametersDialog::ParametersOperations::GNEParameterHandler::myStartElement(), GNESingleParametersDialog::ParametersOperations::GNEParameterHandler::myStartElement(), GNEVTypeDistributionsDialog::ParametersOperations::GNEParameterHandler::myStartElement(), NIImporter_SUMO::myStartElement(), NIXMLConnectionsHandler::myStartElement(), NIXMLEdgesHandler::myStartElement(), NIXMLNodesHandler::myStartElement(), NIXMLPTHandler::myStartElement(), NIXMLTrafficLightsHandler::myStartElement(), NLHandler::myStartElement(), TrajectoriesHandler::myStartElement(), ShapeHandler::myStartElement(), MSDevice_FCDReplay::FCDHandler::myStartElement(), AGActivityGenHandler::parseBusLine(), AGActivityGenHandler::parseBusStation(), AGActivityGenHandler::parseCityGates(), AdditionalHandler::parseParameters(), RouteHandler::parseParameters(), AGActivityGenHandler::parseSchool(), and AGActivityGenHandler::parseStreets().

getStringSecure() [1/2]

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

pure virtual

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

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

Parameters

[in]	id	The name of the attribute to return the value of
[in]	def	The 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

Implemented in SUMOSAXAttributesImpl_Cached, and SUMOSAXAttributesImpl_Xerces.

getStringSecure() [2/2]

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

pure virtual

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

Tries to retrieve the attribute from 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]	id	The id of the attribute to return the value of
[in]	def	The 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

EmptyData

If the attribute is not known or the attribute value is an empty string

Implemented in SUMOSAXAttributesImpl_Cached, and SUMOSAXAttributesImpl_Xerces.

Referenced by NIXMLEdgesHandler::addEdge(), NLHandler::addPhase(), NIXMLPTHandler::addPTLine(), NLHandler::addVTypeProbeDetector(), DataHandler::getAttributes(), MSTriggeredRerouter::myStartElement(), PCLoaderOSM::RelationsHandler::myStartElement(), GUISettingsHandler::myStartElement(), NIImporter_OpenStreetMap::RelationHandler::myStartElement(), NLHandler::openJunction(), GUISettingsHandler::parseColor(), GUISettingsHandler::parseRainbowSettings(), GUISettingsHandler::parseSizeSettings(), and GUISettingsHandler::parseTextSettings().

Here is the caller graph for this function:

getSUMOTimeReporting()

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

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]	attr	The id of the attribute to read
[in]	objectid	The name of the parsed object; used for error message generation
[out]	ok	Whether the value could be read
[in]	report	Whether errors shall be written to msg handler's error instance

Returns

The read value if given and correct; -1 if an error occurred

Definition at line 60 of file SUMOSAXAttributes.cpp.

References emitEmptyError(), emitFormatError(), emitUngivenError(), getName(), getString(), and string2time().

Referenced by NLHandler::addPhase(), NLHandler::addWAUTSwitch(), SUMOVehicleParserHelper::beginVTypeParsing(), NLTriggerBuilder::buildVaporizer(), GUINet::DiscoverAttributes::myStartElement(), MSCalibrator::myStartElement(), MSLaneSpeedTrigger::myStartElement(), TrajectoriesHandler::myStartElement(), GUISettingsHandler::myStartElement(), SUMORouteHandler::myStartElement(), SAXWeightsHandler::myStartElement(), MSDevice_FCDReplay::FCDHandler::myStartElement(), AdditionalHandler::parseCalibratorFlowAttributes(), SUMOVehicleParserHelper::parseFlowAttributes(), RouteHandler::parseInterval(), AdditionalHandler::parseRerouterIntervalAttributes(), AdditionalHandler::parseVaporizerAttributes(), and AdditionalHandler::parseVariableSpeedSignStepAttributes().

Here is the caller graph for this function:

hasAttribute() [1/2]

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

pure virtual

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

Parameters

[in]

id

The name of the attribute to search for

Returns

Whether the named attribute is within the attributes

Implemented in SUMOSAXAttributesImpl_Cached, and SUMOSAXAttributesImpl_Xerces.

hasAttribute() [2/2]

virtual bool SUMOSAXAttributes::hasAttribute ( int  id ) const

pure virtual

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

Parameters

[in]

id

The id of the attribute to search for

Returns

Whether the attribute is within the attributes

Implemented in SUMOSAXAttributesImpl_Cached, and SUMOSAXAttributesImpl_Xerces.

Referenced by NIImporter_SUMO::addConnection(), NLNetShapeHandler::addConnection(), NIXMLConnectionsHandler::addCrossing(), NLHandler::addDistrict(), NIXMLEdgesHandler::addEdge(), ROJTRTurnDefLoader::addEdgeRel(), NIXMLNodesHandler::addJoinCluster(), NIImporter_SUMO::addJunction(), NIImporter_SUMO::addLane(), NIXMLEdgesHandler::addLane(), NIXMLNodesHandler::addNode(), NLHandler::addParam(), RONetHandler::addParam(), SUMORouteHandler::addParam(), MSRouteHandler::addPersonTrip(), RORouteHandler::addPersonTrip(), NLHandler::addPhase(), ShapeHandler::addPOI(), ShapeHandler::addPoly(), NIXMLPTHandler::addPTLine(), NIXMLPTHandler::addPTLineStop(), RORouteHandler::addRide(), MSRouteHandler::addRideOrTransport(), NIXMLPTHandler::addRouteStop(), NIXMLEdgesHandler::addSplit(), MSRouteHandler::addStop(), RORouteHandler::addStop(), MSRouteHandler::addTranship(), MSRouteHandler::addWalk(), RORouteHandler::addWalk(), NIXMLConnectionsHandler::addWalkingArea(), NLHandler::beginEdgeParsing(), SUMOVehicleParserHelper::beginVTypeParsing(), NIXMLConnectionsHandler::delConnection(), NIXMLTrafficLightsHandler::initTrafficLightLogic(), RouteHandler::isEmbeddedRoute(), MSDevice_Vehroutes::loadState(), MSAbstractLaneChangeModel::loadState(), MEVehicle::loadState(), MSVehicle::loadState(), MSVehicleTransfer::loadState(), MSDriveWay::loadState(), ROJTRTurnDefLoader::myStartElement(), ROMARouteHandler::myStartElement(), VehicleEngineHandler::myStartElement(), MSStateHandler::myStartElement(), MSLaneSpeedTrigger::myStartElement(), MSTriggeredRerouter::myStartElement(), GNEMultipleParametersDialog::ParametersOperations::GNEParameterHandler::myStartElement(), GNESingleParametersDialog::ParametersOperations::GNEParameterHandler::myStartElement(), GNEVTypeDistributionsDialog::ParametersOperations::GNEParameterHandler::myStartElement(), NIImporter_MATSim::EdgesHandler::myStartElement(), NIImporter_OpenDrive::myStartElement(), NIImporter_SUMO::myStartElement(), NIXMLConnectionsHandler::myStartElement(), NIXMLEdgesHandler::myStartElement(), NIXMLNodesHandler::myStartElement(), NIXMLPTHandler::myStartElement(), NIXMLTrafficLightsHandler::myStartElement(), NIXMLTypesHandler::myStartElement(), PCLoaderOSM::RelationsHandler::myStartElement(), PCTypeDefHandler::myStartElement(), TrajectoriesHandler::myStartElement(), GUISettingsHandler::myStartElement(), ShapeHandler::myStartElement(), NIImporter_OpenStreetMap::RelationHandler::myStartElement(), ODDistrictHandler::openDistrict(), NLHandler::openJunction(), MSRouteHandler::openRoute(), RORouteHandler::openRoute(), MSRouteHandler::openRouteDistribution(), RORouteHandler::openRouteDistribution(), MSRouteHandler::openVehicleTypeDistribution(), RORouteHandler::openVehicleTypeDistribution(), NLTriggerBuilder::parseAndBeginParkingArea(), NLTriggerBuilder::parseAndBuildCalibrator(), AdditionalHandler::parseCalibratorAttributes(), AdditionalHandler::parseCalibratorFlowAttributes(), SUMOVehicleParserHelper::parseCFMParams(), SUMOVehicleParserHelper::parseCommonAttributes(), NIXMLConnectionsHandler::parseConnection(), RONetHandler::parseDistrict(), AdditionalHandler::parseE2Attributes(), RouteHandler::parseFlow(), SUMOVehicleParserHelper::parseFlowAttributes(), MSRouteHandler::parseFromViaTo(), RORouteHandler::parseFromViaTo(), SUMOVehicleParserHelper::parseID(), SUMOVehicleParserHelper::parseJMParams(), NIXMLConnectionsHandler::parseLaneBound(), NIXMLConnectionsHandler::parseLaneInfo(), SUMOVehicleParserHelper::parseLCParams(), AdditionalHandler::parseParameters(), RouteHandler::parseParameters(), AdditionalHandler::parsePOIAttributes(), RouteHandler::parseRoute(), SUMORouteHandler::parseStop(), RouteHandler::parseStopParameters(), AGActivityGenHandler::parseStreets(), RouteHandler::parseTranship(), RouteHandler::parseTrip(), RouteHandler::parseWalk(), MSRouteHandler::parseWalkPositions(), RORouteHandler::parseWalkPositions(), NIXMLNodesHandler::processNodeType(), NIXMLNodesHandler::processTrafficLightDefinitions(), NIXMLEdgesHandler::setNodes(), StopOffset::StopOffset(), NIXMLEdgesHandler::tryGetShape(), SAXWeightsHandler::tryParse(), SAXWeightsHandler::tryParseEdgeRel(), and SAXWeightsHandler::tryParseTazRel().

operator=()

SUMOSAXAttributes & SUMOSAXAttributes::operator= ( const SUMOSAXAttributes &  src )

privatedelete

Invalidated assignment operator.

serialize()

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

pure virtual

Prints all attribute names and values into the given stream.

Parameters

[in]

os

The stream to use

Implemented in SUMOSAXAttributesImpl_Cached, and SUMOSAXAttributesImpl_Xerces.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const SUMOSAXAttributes &  src  )

friend

Definition at line 420 of file SUMOSAXAttributes.h.

Field Documentation

ENCODING

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

static

The encoding of parsed strings.

Definition at line 398 of file SUMOSAXAttributes.h.

Referenced by OptionsCont::writeXMLHeader().

myObjectType

std::string SUMOSAXAttributes::myObjectType

private

the object type to use in error reporting

Definition at line 415 of file SUMOSAXAttributes.h.

Referenced by emitEmptyError(), emitFormatError(), emitUngivenError(), and getObjectType().

---

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

• SUMOSAXAttributes.h
• SUMOSAXAttributes.cpp