Helper methods for parsing vehicle attributes. More...

#include <SUMOVehicleParserHelper.h>

Static Public Member Functions
static SUMOVTypeParameter *	beginVTypeParsing (const SUMOSAXAttributes &attrs) throw (ProcessError)
	Starts to parse a vehicle type.
static void	closeVTypeParsing (SUMOVTypeParameter &vtype)
	Closes parsing of the vehicle type.
static SUMOEmissionClass	parseEmissionClass (const SUMOSAXAttributes &attrs, const std::string &id)
	Parses the vehicle emission class.
static SUMOVehicleParameter *	parseFlowAttributes (const SUMOSAXAttributes &attrs) throw (ProcessError)
	Parses a flow's attributes.
static SUMOVehicleShape	parseGuiShape (const SUMOSAXAttributes &attrs, const std::string &id)
	Parses the vehicle class.
static SUMOVehicleParameter *	parseVehicleAttributes (const SUMOSAXAttributes &attrs, bool skipID=false, bool skipDepart=false) throw (ProcessError)
	Parses a vehicle's attributes.
static SUMOVehicleClass	parseVehicleClass (const SUMOSAXAttributes &attrs, const std::string &id)
	Parses the vehicle class.
static void	parseVTypeEmbedded (SUMOVTypeParameter &into, int element, const SUMOSAXAttributes &attrs, bool fromVType=false) throw (ProcessError)
	Parses an element embedded in vtype definition.
Private Types
typedef std::map< SumoXMLTag, std::set< SumoXMLAttr > >	CFAttrMap
Static Private Member Functions
static const CFAttrMap &	getAllowedCFModelAttrs ()
static void	parseCommonAttributes (const SUMOSAXAttributes &attrs, SUMOVehicleParameter *ret, std::string element) throw (ProcessError)
	Parses attributes common to vehicles and flows.
Private Attributes
static bool	gHaveWarnedAboutDeprecatedArrivalLane = false
static bool	gHaveWarnedAboutDeprecatedArrivalPos = false
static bool	gHaveWarnedAboutDeprecatedArrivalSpeed = false
static bool	gHaveWarnedAboutDeprecatedDepartLane = false
static bool	gHaveWarnedAboutDeprecatedDepartPos = false
static bool	gHaveWarnedAboutDeprecatedDepartSpeed = false
static bool	gHaveWarnedAboutDeprecatedMaxSpeed = false
static bool	gHaveWarnedAboutDeprecatedTazs = false
static bool	gHaveWarnedAboutDeprecatedVClass = false
Static Private Attributes
static CFAttrMap	allowedCFModelAttrs
static bool	gHaveWarnedAboutDeprecatedNumber = false

Detailed Description

Helper methods for parsing vehicle attributes.

This class supports helper methods for parsing a vehicle's attributes.

Definition at line 51 of file SUMOVehicleParserHelper.h.

Member Typedef Documentation

typedef std::map<SumoXMLTag, std::set<SumoXMLAttr> > SUMOVehicleParserHelper::CFAttrMap [private]

Definition at line 181 of file SUMOVehicleParserHelper.h.

Member Function Documentation

SUMOVTypeParameter * SUMOVehicleParserHelper::beginVTypeParsing ( const SUMOSAXAttributes & attrs ) throw (ProcessError) [static]

Starts to parse a vehicle type.

Parameters:

[in] attr The SAX-attributes to get vehicle parameter from

Exceptions:

ProcessError If an attribute's value is invalid

See also:: SUMOVTypeParameter

Note:: : the caller is responsible for deleting the returned pointer

Definition at line 451 of file SUMOVehicleParserHelper.cpp.

Referenced by RORDLoader_TripDefs::myStartElement(), RORDLoader_SUMOBase::myStartElement(), and MSRouteHandler::myStartElement().

static void SUMOVehicleParserHelper::closeVTypeParsing ( SUMOVTypeParameter & vtype ) [inline, static]

Closes parsing of the vehicle type.

Returns:: The resulting vehicle type parameter

See also:: SUMOVTypeParameter

Definition at line 110 of file SUMOVehicleParserHelper.h.

References UNUSED_PARAMETER.

Referenced by RORDLoader_TripDefs::myEndElement(), RORDLoader_SUMOBase::myEndElement(), and MSRouteHandler::myEndElement().

const SUMOVehicleParserHelper::CFAttrMap & SUMOVehicleParserHelper::getAllowedCFModelAttrs ( ) [static, private]

void SUMOVehicleParserHelper::parseCommonAttributes	(	const SUMOSAXAttributes &	attrs,
		SUMOVehicleParameter *	ret,
		std::string	element
	)		throw (ProcessError) `[static, private]`

Parses attributes common to vehicles and flows.

Parses all attributes stored in "SUMOVehicleParameter".

See also:: SUMOVehicleParameter

Parameters:

[in]	attr	The SAX-attributes to get vehicle parameter from
[out]	ret	The parameter to parse into
[in]	element	The name of the element (vehicle or flow)

Exceptions:

ProcessError If an attribute's value is invalid

Definition at line 225 of file SUMOVehicleParserHelper.cpp.

SUMOEmissionClass SUMOVehicleParserHelper::parseEmissionClass	(	const SUMOSAXAttributes &	attrs,
		const std::string &	id
	)		`[static]`

Parses the vehicle emission class.

When given, the vehicle emission class is parsed using getVehicleEmissionTypeID. Exceptions occuring within this process are catched and reported.

If no vehicle class is available in the attributes, the default class (SVE_UNKNOWN) is returned.

Parameters:

[in]	attrs	The attributes to read the class from
[in]	id	The id of the parsed element, for error message generation

Returns:: The parsed vehicle emission class

See also:: SUMOEmissionClass

Todo:: Recheck how errors are handled and what happens if they occure

Definition at line 644 of file SUMOVehicleParserHelper.cpp.

References SUMOSAXAttributes::getObjectType(), SUMOSAXAttributes::getOptStringReporting(), getVehicleEmissionTypeID(), SUMO_ATTR_EMISSIONCLASS, SVE_UNKNOWN, and WRITE_ERROR.

SUMOVehicleParameter * SUMOVehicleParserHelper::parseFlowAttributes ( const SUMOSAXAttributes & attrs ) throw (ProcessError) [static]

Parses a flow's attributes.

Parses all attributes stored in "SUMOVehicleParameter".

See also:: SUMOVehicleParameter

Parameters:

[in] attr The SAX-attributes to get vehicle parameter from

Returns:: The parsed attribute structure if no error occured, 0 otherwise

Exceptions:

ProcessError If an attribute's value is invalid

Note:: : the caller is responsible for deleting the returned pointer

Definition at line 64 of file SUMOVehicleParserHelper.cpp.

References SUMOVehicleParameter::depart, OptionsCont::getOptions(), SUMOVehicleParameter::id, SUMOVehicleParameter::repetitionNumber, SUMOVehicleParameter::repetitionOffset, SUMOVehicleParameter::setParameter, string2time(), SUMO_ATTR_BEGIN, SUMO_ATTR_END, SUMO_ATTR_ID, SUMO_ATTR_NO__DEPRECATED, SUMO_ATTR_NUMBER, SUMO_ATTR_PERIOD, SUMO_ATTR_VEHSPERHOUR, SUMOReal, SUMOTime_MAX, TIME2STEPS, toString(), VEHPARS_PERIODFREQ_SET, and WRITE_WARNING.

Referenced by MSRouteHandler::myStartElement().

SUMOVehicleShape SUMOVehicleParserHelper::parseGuiShape	(	const SUMOSAXAttributes &	attrs,
		const std::string &	id
	)		`[static]`

Parses the vehicle class.

When given, the vehicle class is parsed using getVehicleShapeID. Exceptions occuring within this process are catched and reported.

If no vehicle class is available in the attributes, the default class (SVS_UNKNOWN) is returned.

Parameters:

[in]	attrs	The attributes to read the class from
[in]	id	The id of the parsed element, for error message generation

Returns:: The parsed vehicle shape

See also:: SUMOVehicleShape

Todo:: Recheck how errors are handled and what happens if they occure

Definition at line 661 of file SUMOVehicleParserHelper.cpp.

References SUMOSAXAttributes::getObjectType(), SUMOSAXAttributes::getOptStringReporting(), SUMO_ATTR_GUISHAPE, SumoVehicleShapeStrings, SVS_UNKNOWN, and WRITE_ERROR.

SUMOVehicleParameter * SUMOVehicleParserHelper::parseVehicleAttributes	(	const SUMOSAXAttributes &	attrs,
		bool	skipID = `false`,
		bool	skipDepart = `false`
	)		throw (ProcessError) `[static]`

Parses a vehicle's attributes.

Parses all attributes stored in "SUMOVehicleParameter".

See also:: SUMOVehicleParameter

Parameters:

[in]	attr	The SAX-attributes to get vehicle parameter from
[in]	skipID	Whether parsing the id shall be skipped
[in]	skipDepart	Whether parsing the departure time shall be skipped

Returns:: The parsed attribute structure if no error occured, 0 otherwise

Exceptions:

ProcessError If an attribute's value is invalid

Note:: : the caller is responsible for deleting the returned pointer

Definition at line 168 of file SUMOVehicleParserHelper.cpp.

References SUMOVehicleParameter::depart, DEPART_GIVEN, DEPART_TRIGGERED, SUMOVehicleParameter::departProcedure, SUMOVehicleParameter::id, SUMOVehicleParameter::repetitionNumber, SUMOVehicleParameter::repetitionOffset, SUMOVehicleParameter::setParameter, SUMO_ATTR_DEPART, SUMO_ATTR_ID, SUMO_ATTR_PERIOD, SUMO_ATTR_REPNUMBER, VEHPARS_PERIODFREQ_SET, VEHPARS_PERIODNUM_SET, and WRITE_WARNING.

Referenced by RORDLoader_TripDefs::myStartElement(), RORDLoader_SUMOBase::myStartElement(), MSRouteHandler::myStartElement(), and RORDGenerator_ODAmounts::parseFlowAmountDef().

SUMOVehicleClass SUMOVehicleParserHelper::parseVehicleClass	(	const SUMOSAXAttributes &	attrs,
		const std::string &	id
	)		`[static]`

Parses the vehicle class.

When given, the vehicle class is parsed using getVehicleClassID. Exceptions occuring within this process are catched and reported.

If no vehicle class is available in the attributes, the default class (SVC_UNKNOWN) is returned.

Parameters:

[in]	attrs	The attributes to read the class from
[in]	id	The id of the parsed element, for error message generation

Returns:: The parsed vehicle class

See also:: SUMOVehicleClass

Todo:: Recheck how errors are handled and what happens if they occure

Definition at line 624 of file SUMOVehicleParserHelper.cpp.

References SUMOSAXAttributes::getObjectType(), SUMOSAXAttributes::getOptStringReporting(), getVehicleClassID(), SUMOSAXAttributes::hasAttribute(), SUMO_ATTR_VCLASS, SUMO_ATTR_VCLASS__DEPRECATED, SVC_UNKNOWN, and WRITE_ERROR.

void SUMOVehicleParserHelper::parseVTypeEmbedded	(	SUMOVTypeParameter &	into,
		int	element,
		const SUMOSAXAttributes &	attrs,
		bool	fromVType = `false`
	)		throw (ProcessError) `[static]`

Parses an element embedded in vtype definition.

Parameters:

	in,filled]	into The structure to fill with parsed values
[in]	element	The id of the currently parsed XML-element
[in]	attr	The SAX-attributes to get vehicle parameter from
[in]	fromVType	Whether the attributes are a part of the vtype-definition