FOX need this. More...

Inheritance diagram for GNESingleParametersDialog::ParametersOperations::GNEParameterHandler:

Collaboration diagram for GNESingleParametersDialog::ParametersOperations::GNEParameterHandler:

Public Member Functions
void	characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
	The inherited method called when characters occurred. More...

void	endElement (const XMLCh const uri, const XMLCh const localname, const XMLCh *const qname)
	The inherited method called when a tag is being closed. More...

const std::string &	getFileName () const
	returns the current file name More...

	GNEParameterHandler (ParametersOperations *ParametersOperationsParent, const std::string &file)
	Constructor. More...

void	registerParent (const int tag, GenericSAXHandler *handler)
	Assigning a parent handler which is enabled when the specified tag is closed. More...

void	setFileName (const std::string &name)
	Sets the current file name. More...

void	startElement (const XMLCh const uri, const XMLCh const localname, const XMLCh *const qname, const XERCES_CPP_NAMESPACE::Attributes &attrs)
	The inherited method called when a new tag opens. More...

	~GNEParameterHandler ()
	Destructor. More...

inherited from SAXHandler
ParametersOperations *	myParametersOperationsParent
	pointer to ParametersOperations parent More...

void	myStartElement (int element, const SUMOSAXAttributes &attrs)
	Called on the opening of a tag;. More...

attributes parsing
AttrMap	myPredefinedTags

std::vector< std::string >	myPredefinedTagsMML
	the map from ids to their string representation More...

typedef std::vector< XMLCh * >	AttrMap

elements parsing
TagMap	myTagMap

std::vector< std::string >	myCharactersVector
	A list of character strings obtained so far to build the complete characters string at the end. More...

GenericSAXHandler *	myParentHandler
	The handler to give control back to. More...

int	myParentIndicator
	The tag indicating that control should be given back. More...

std::string	myFileName
	The name of the currently parsed file. More...

std::string	myExpectedRoot
	The root element to expect, empty string disables the check. More...

bool	myRootSeen
	whether the reader has already seen the root element More...

typedef std::map< std::string, int >	TagMap

SAX ErrorHandler callbacks
void	warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
	Handler for XML-warnings. More...

void	error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
	Handler for XML-errors. More...

void	fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
	Handler for XML-errors. More...

std::string	buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
	Builds an error message. More...

virtual void	myCharacters (int element, const std::string &chars)
	Callback method for characters to implement by derived classes. More...

virtual void	myEndElement (int element)
	Callback method for a closing tag to implement by derived classes. More...

XMLCh *	convert (const std::string &name) const
	converts from c++-string into unicode More...

int	convertTag (const std::string &tag) const
	Converts a tag from its string into its numerical representation. More...

Detailed Description

FOX need this.

load parameters from a filename

Definition at line 193 of file GNESingleParametersDialog.h.

Member Typedef Documentation

◆ AttrMap

typedef std::vector<XMLCh*> GenericSAXHandler::AttrMap

privateinherited

Definition at line 279 of file GenericSAXHandler.h.

◆ TagMap

typedef std::map<std::string, int> GenericSAXHandler::TagMap

privateinherited

Definition at line 293 of file GenericSAXHandler.h.

Constructor & Destructor Documentation

◆ GNEParameterHandler()

GNESingleParametersDialog::ParametersOperations::GNEParameterHandler::GNEParameterHandler	(	ParametersOperations *	ParametersOperationsParent,
		const std::string &	file
	)

Constructor.

Definition at line 433 of file GNESingleParametersDialog.cpp.

◆ ~GNEParameterHandler()

GNESingleParametersDialog::ParametersOperations::GNEParameterHandler::~GNEParameterHandler ( )

Destructor.

Definition at line 439 of file GNESingleParametersDialog.cpp.

Member Function Documentation

◆ buildErrorMessage()

std::string GenericSAXHandler::buildErrorMessage ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

protectedinherited

Builds an error message.

The error message includes the file name and the line/column information as supported by the given SAXParseException

Parameters

[in] exception The name of the currently processed file

Returns: A string describing the given exception

Definition at line 188 of file GenericSAXHandler.cpp.

References GenericSAXHandler::getFileName(), and transcode().

Referenced by GenericSAXHandler::error(), GenericSAXHandler::fatalError(), and GenericSAXHandler::warning().

Here is the caller graph for this function:

◆ characters()

void GenericSAXHandler::characters	(	const XMLCh *const	chars,
		const XERCES3_SIZE_t	length
	)

inherited

The inherited method called when characters occurred.

The retrieved characters are converted into a string and appended into a private buffer. They are reported as soon as the element ends.

Todo:

recheck/describe what happens with characters when a new element is opened

describe characters processing in the class' head

Definition at line 171 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myCharactersVector, and StringUtils::transcode().

◆ convert()

XMLCh * GenericSAXHandler::convert ( const std::string & name ) const

privateinherited

converts from c++-string into unicode

Todo:: recheck encoding

Parameters

[in] name The string to convert

Returns: The string converted into a XMLCh-string

Definition at line 84 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::GenericSAXHandler().

Here is the caller graph for this function:

◆ convertTag()

int GenericSAXHandler::convertTag ( const std::string & tag ) const

privateinherited

Converts a tag from its string into its numerical representation.

Returns the enum-representation stored for the given tag. If the tag is not known, SUMO_TAG_NOTHING is returned.

Parameters

[in] tag The string to convert

Returns: The int-value that represents the string, SUMO_TAG_NOTHING if the named attribute is not known

Definition at line 178 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myTagMap, and SUMO_TAG_NOTHING.

Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::startElement().

Here is the caller graph for this function:

◆ endElement()

void GenericSAXHandler::endElement	(	const XMLCh *const	uri,
		const XMLCh *const	localname,
		const XMLCh *const	qname
	)

inherited

The inherited method called when a tag is being closed.

This method calls the user-implemented methods myCharacters with the previously collected and converted characters.

Then, myEndElement is called, supplying it the qname converted to its enum- and string-representations.

Todo:

recheck/describe encoding of the string-representation

do not generate and report the string-representation

Definition at line 122 of file GenericSAXHandler.cpp.

References GenericSAXHandler::convertTag(), GenericSAXHandler::myCharacters(), GenericSAXHandler::myCharactersVector, GenericSAXHandler::myEndElement(), GenericSAXHandler::myParentHandler, GenericSAXHandler::myParentIndicator, XMLSubSys::setHandler(), SUMO_TAG_INCLUDE, SUMO_TAG_NOTHING, and StringUtils::transcode().

◆ error()

void GenericSAXHandler::error ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

inherited

Handler for XML-errors.

The message is built using buildErrorMessage and thrown within a ProcessError.

Parameters

[in] exception The occurred exception to process

Exceptions

ProcessError On any call

Definition at line 207 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

Referenced by MSRouteHandler::addFlowPerson(), MSRouteHandler::closeContainer(), MSRouteHandler::closePerson(), MSRouteHandler::closePersonFlow(), NIImporter_OpenDrive::geomFromSpiral(), and MSRouteHandler::myStartElement().

Here is the caller graph for this function:

◆ fatalError()

void GenericSAXHandler::fatalError ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

inherited

Handler for XML-errors.

The message is built using buildErrorMessage and thrown within a ProcessError.

Exceptions

ProcessError On any call

Parameters

[in] exception The occurred exception to process

Definition at line 213 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

◆ getFileName()

const std::string & GenericSAXHandler::getFileName ( ) const

inherited

returns the current file name

Returns: The name of the currently processed file

Definition at line 78 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myFileName.

Referenced by NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), NLHandler::addInstantE1Detector(), ShapeHandler::addPOI(), ShapeHandler::addPoly(), NLHandler::addRouteProbeDetector(), NLHandler::addVTypeProbeDetector(), NLHandler::beginE3Detector(), GenericSAXHandler::buildErrorMessage(), PCNetProjectionLoader::load(), NLHandler::myEndElement(), RODFDetectorHandler::myStartElement(), NLHandler::myStartElement(), GUISettingsHandler::myStartElement(), SUMORouteHandler::myStartElement(), GNEAdditionalHandler::parseAndBuildPOI(), GNEAdditionalHandler::parseAndBuildPoly(), XMLSubSys::runParser(), GenericSAXHandler::startElement(), and SUMORouteLoader::SUMORouteLoader().

Here is the caller graph for this function:

◆ myCharacters()

void GenericSAXHandler::myCharacters	(	int	element,
		const std::string &	chars
	)

protectedvirtualinherited

Callback method for characters to implement by derived classes.

Called by "endElement" (see there).

Parameters

[in]	element	The opened element, given as a int
[in]	chars	The complete embedded character string @exceptions ProcessError These method may throw a ProcessError if something fails

Reimplemented in NIImporter_OpenDrive, and NIImporter_ITSUMO::Handler.

Definition at line 223 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

Here is the caller graph for this function:

◆ myEndElement()

void GenericSAXHandler::myEndElement ( int element )

protectedvirtualinherited

Callback method for a closing tag to implement by derived classes.

Called by "endElement" (see there).

Parameters

[in] element The closed element, given as a int @exceptions ProcessError These method may throw a ProcessError if something fails

Reimplemented in SAXWeightsHandler, NIImporter_OpenStreetMap::RelationHandler, NIImporter_OpenStreetMap::EdgesHandler, NIImporter_OpenStreetMap::NodesHandler, SUMORouteHandler, ShapeHandler, RONetHandler, PCLoaderOSM::EdgesHandler, PCLoaderOSM::RelationsHandler, PCLoaderOSM::NodesHandler, ODDistrictHandler, NLHandler, NIImporter_Vissim::NIVissimXMLHandler_Routenentscheidungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Geschwindigkeitsverteilungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_VWunschentscheidungsdefinition, NIImporter_Vissim::NIVissimXMLHandler_Fahrzeugklassendefinition, NIImporter_Vissim::NIVissimXMLHandler_Streckendefinition, NIXMLTrafficLightsHandler, NIXMLPTHandler, NIXMLNodesHandler, NIXMLEdgesHandler, NIImporter_SUMO, NIImporter_OpenDrive, NIImporter_ITSUMO::Handler, GNEDataHandler, GNEAdditionalHandler, MSTriggeredRerouter, MSLaneSpeedTrigger, MSCalibrator, MSStateHandler, ROMARouteHandler, and GUITriggeredRerouter.

Definition at line 227 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

Here is the caller graph for this function:

◆ myStartElement()

void GNESingleParametersDialog::ParametersOperations::GNEParameterHandler::myStartElement	(	int	element,
		const SUMOSAXAttributes &	attrs
	)

virtual

Called on the opening of a tag;.

Parameters

[in]	element	ID of the currently opened element
[in]	attrs	Attributes within the currently opened element

Exceptions

ProcessError If something fails

See also: SAXHandler::myStartElement

Reimplemented from GenericSAXHandler.

Definition at line 443 of file GNESingleParametersDialog.cpp.

References SUMOSAXAttributes::getString(), SUMOSAXAttributes::hasAttribute(), SUMOXMLDefinitions::isValidParameterKey(), SUMO_ATTR_KEY, SUMO_ATTR_VALUE, SUMO_TAG_NOTHING, SUMO_TAG_PARAM, and WRITE_WARNING.

◆ registerParent()

void GenericSAXHandler::registerParent	(	const int	tag,
		GenericSAXHandler *	handler
	)

inherited

Assigning a parent handler which is enabled when the specified tag is closed.

Definition at line 163 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myParentHandler, GenericSAXHandler::myParentIndicator, and XMLSubSys::setHandler().

Referenced by NLTriggerBuilder::parseAndBuildCalibrator(), NLTriggerBuilder::parseAndBuildLaneSpeedTrigger(), and NLTriggerBuilder::parseAndBuildRerouter().

Here is the caller graph for this function:

◆ setFileName()

void GenericSAXHandler::setFileName ( const std::string & name )

inherited

Sets the current file name.

Parameters

[in] name The name of the currently processed file

Todo:: Hmmm - this is as unsafe as having a direct access to the variable; recheck

Definition at line 72 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myFileName.

Referenced by NIImporter_SUMO::_loadNetwork(), GUISettingsHandler::GUISettingsHandler(), NIImporter_OpenStreetMap::load(), NIImporter_Vissim::load(), PCNetProjectionLoader::load(), NITypeLoader::load(), loadNet(), ROLoader::loadNet(), NIImporter_ITSUMO::loadNetwork(), NIImporter_MATSim::loadNetwork(), NIImporter_OpenDrive::loadNetwork(), main(), and XMLSubSys::runParser().

Here is the caller graph for this function:

◆ startElement()

void GenericSAXHandler::startElement	(	const XMLCh *const	uri,
		const XMLCh *const	localname,
		const XMLCh *const	qname,
		const XERCES_CPP_NAMESPACE::Attributes &	attrs
	)

inherited

The inherited method called when a new tag opens.

The method parses the supplied XMLCh*-qname using the internal name/enum-map to obtain the enum representation of the attribute name.

Then, "myStartElement" is called supplying the enumeration value, the string-representation of the name and the attributes.

Todo:

recheck/describe encoding of the string-representation

do not generate and report the string-representation

Definition at line 97 of file GenericSAXHandler.cpp.

◆ warning()

void GenericSAXHandler::warning ( const XERCES_CPP_NAMESPACE::SAXParseException & exception )

inherited

Handler for XML-warnings.

The message is built using buildErrorMessage and reported to the warning-instance of the MsgHandler.

Parameters

[in] exception The occurred exception to process

Definition at line 201 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

◆ myCharactersVector

std::vector<std::string> GenericSAXHandler::myCharactersVector

privateinherited

A list of character strings obtained so far to build the complete characters string at the end.

Definition at line 300 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::characters(), GenericSAXHandler::endElement(), and GenericSAXHandler::startElement().

◆ myExpectedRoot

std::string GenericSAXHandler::myExpectedRoot

privateinherited

The root element to expect, empty string disables the check.

Definition at line 312 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ myFileName

std::string GenericSAXHandler::myFileName

privateinherited

The name of the currently parsed file.

Definition at line 309 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::getFileName(), and GenericSAXHandler::setFileName().

◆ myParametersOperationsParent

ParametersOperations* GNESingleParametersDialog::ParametersOperations::GNEParameterHandler::myParametersOperationsParent

private

pointer to ParametersOperations parent

Definition at line 213 of file GNESingleParametersDialog.h.

◆ myParentHandler

GenericSAXHandler* GenericSAXHandler::myParentHandler

privateinherited

The handler to give control back to.

Definition at line 303 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::registerParent().

◆ myParentIndicator

int GenericSAXHandler::myParentIndicator

privateinherited

The tag indicating that control should be given back.

Definition at line 306 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::endElement(), and GenericSAXHandler::registerParent().

◆ myPredefinedTags

AttrMap GenericSAXHandler::myPredefinedTags

privateinherited

Definition at line 282 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::GenericSAXHandler(), GenericSAXHandler::startElement(), and GenericSAXHandler::~GenericSAXHandler().

◆ myPredefinedTagsMML

std::vector<std::string> GenericSAXHandler::myPredefinedTagsMML

privateinherited

the map from ids to their string representation

Definition at line 285 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::GenericSAXHandler(), and GenericSAXHandler::startElement().

◆ myRootSeen

bool GenericSAXHandler::myRootSeen

privateinherited

whether the reader has already seen the root element

Definition at line 315 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::startElement().

◆ myTagMap

TagMap GenericSAXHandler::myTagMap

privateinherited

Definition at line 296 of file GenericSAXHandler.h.

Referenced by GenericSAXHandler::convertTag(), and GenericSAXHandler::GenericSAXHandler().

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

Public Member Functions

inherited from SAXHandler

attributes parsing

elements parsing

SAX ErrorHandler callbacks

Detailed Description

Member Typedef Documentation

◆ AttrMap

◆ TagMap

Constructor & Destructor Documentation

◆ GNEParameterHandler()

◆ ~GNEParameterHandler()

Member Function Documentation

◆ buildErrorMessage()

◆ characters()

◆ convert()

◆ convertTag()

◆ endElement()

◆ error()

◆ fatalError()

◆ getFileName()

◆ myCharacters()

◆ myEndElement()

◆ myStartElement()

◆ registerParent()

◆ setFileName()

◆ startElement()

◆ warning()

Field Documentation

◆ myCharactersVector

◆ myExpectedRoot

◆ myFileName

◆ myParametersOperationsParent

◆ myParentHandler

◆ myParentIndicator

◆ myPredefinedTags

◆ myPredefinedTagsMML

◆ myRootSeen

◆ myTagMap