An XML-handler for visualisation schemes. More...

#include <GUISettingsHandler.h>

Inheritance diagram for GUISettingsHandler:

Public Member Functions
std::string	addSettings (GUISUMOAbstractView *view=0) const throw ()
	Adds the parsed settings to the global list of settings.
void	characters (const XMLCh *const chars, const XERCES3_SIZE_t length)
	The inherited method called when characters occured.
void	endElement (const XMLCh const uri, const XMLCh const localname, const XMLCh *const qname)
	The inherited method called when a tag is being closed.
const std::vector < GUISUMOAbstractView::Decal > &	getDecals () const throw ()
	Returns the parsed decals.
SUMOReal	getDelay () const throw ()
	Returns the parsed delay.
const std::string &	getFileName () const throw ()
	returns the current file name
	GUISettingsHandler (const std::string &content, bool isFile=true) throw ()
	Constructor.
bool	hasDecals () const throw ()
	Returns whether any decals have been parsed.
void	registerParent (const int tag, GenericSAXHandler *handler)
	Assigning a parent handler which is enabled when the specified tag is closed.
void	setFileName (const std::string &name) throw ()
	Sets the current file name.
void	setSnapshots (GUISUMOAbstractView *view) const throw ()
	Makes a snapshot if it has been parsed.
void	setViewport (GUISUMOAbstractView *view) const throw ()
	Sets the viewport which has been parsed.
void	setViewport (SUMOReal &zoom, SUMOReal &xoff, SUMOReal &yoff) const throw ()
	Sets the viewport which has been parsed.
void	startElement (const XMLCh const uri, const XMLCh const localname, const XMLCh *const qname, const Attributes &attrs)
	The inherited method called when a new tag opens.
	~GUISettingsHandler () throw ()
	Destructor.
inherited from GenericSAXHandler
void	myStartElement (int element, const SUMOSAXAttributes &attrs) throw (ProcessError)
	Called on the opening of a tag.
SAX ErrorHandler callbacks
void	warning (const SAXParseException &exception) throw ()
	Handler for XML-warnings.
void	error (const SAXParseException &exception) throw (ProcessError)
	Handler for XML-errors.
void	fatalError (const SAXParseException &exception) throw (ProcessError)
	Handler for XML-errors.
Protected Member Functions
std::string	buildErrorMessage (const SAXParseException &exception) throw ()
	Builds an error message.
virtual void	myCharacters (int element, const std::string &chars)
	Callback method for characters to implement by derived classes.
virtual void	myEndElement (int element)
	Callback method for a closing tag to implement by derived classes.
Private Member Functions
GUIVisualizationTextSettings	parseTextSettings (const std::string &prefix, const SUMOSAXAttributes &attrs, GUIVisualizationTextSettings defaults)
	parse combined settings of bool, size and color
Private Attributes
int	myCurrentColorer
	The last color scheme category (edges or vehicles)
GUIColorScheme *	myCurrentScheme
	The current color scheme.
std::vector < GUISUMOAbstractView::Decal >	myDecals
	The decals list to fill.
SUMOReal	myDelay
	The delay loaded.
GUIVisualizationSettings	mySettings
	The settings to fill.
std::map< SUMOTime, std::string >	mySnapshots
	mappig of time steps to filenames for potential snapshots
SUMOReal	myXPos
SUMOReal	myYPos
SUMOReal	myZoom
	The viewport loaded.

Detailed Description

An XML-handler for visualisation schemes.

Definition at line 43 of file GUISettingsHandler.h.

Constructor & Destructor Documentation

GUISettingsHandler::GUISettingsHandler	(	const std::string &	content,
		bool	isFile = `true`
	)		throw ()

Constructor.

Parameters:

[in] file the file to parse

Definition at line 50 of file GUISettingsHandler.cpp.

References XMLSubSys::getSAXReader(), and XMLSubSys::runParser().

GUISettingsHandler::~GUISettingsHandler ( ) throw ()

Destructor.

Definition at line 64 of file GUISettingsHandler.cpp.

Member Function Documentation

std::string GUISettingsHandler::addSettings ( GUISUMOAbstractView * view = 0 ) const throw ()

Adds the parsed settings to the global list of settings.

Returns:: the name of the parsed settings

Definition at line 224 of file GUISettingsHandler.cpp.

References GUICompleteSchemeStorage::add(), and gSchemeStorage.

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded(), GUICompleteSchemeStorage::init(), and GUIDialog_ViewSettings::loadSettings().

std::string GenericSAXHandler::buildErrorMessage ( const SAXParseException & exception ) throw () [protected, inherited]

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 189 of file GenericSAXHandler.cpp.

void GenericSAXHandler::characters	(	const XMLCh *const	chars,
		const XERCES3_SIZE_t	length
	)		`[inherited]`

The inherited method called when characters occured.

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 172 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myCharactersVector.

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, and SUMO_TAG_NOTHING.

void GenericSAXHandler::error ( const SAXParseException & exception ) throw (ProcessError) [inherited]

Handler for XML-errors.

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

Parameters:

[in] exception The occured exception to process

Exceptions:

ProcessError On any call

Definition at line 208 of file GenericSAXHandler.cpp.

Referenced by NLHandler::getLanesFromIndices().

void GenericSAXHandler::fatalError ( const SAXParseException & exception ) throw (ProcessError) [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 occured exception to process

Definition at line 214 of file GenericSAXHandler.cpp.

const std::vector< GUISUMOAbstractView::Decal > & GUISettingsHandler::getDecals ( ) const throw ()

Returns the parsed decals.

Returns:: the parsed decals

Definition at line 268 of file GUISettingsHandler.cpp.

References myDecals.

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded(), and GUIDialog_ViewSettings::loadDecals().

SUMOReal GUISettingsHandler::getDelay ( ) const throw ()

Returns the parsed delay.

Returns:: the parsed delay

Definition at line 274 of file GUISettingsHandler.cpp.

References myDelay.

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded().

const std::string & GenericSAXHandler::getFileName ( ) const throw () [inherited]

returns the current file name

Returns:: The name of the currently processed file

Definition at line 82 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myFileName.

Referenced by NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), NLHandler::addInstantE1Detector(), NLHandler::addRouteProbeDetector(), NLHandler::addVTypeProbeDetector(), NLHandler::beginE3Detector(), MSRouteLoader::init(), PCNetProjectionLoader::loadIfSet(), NILoader::loadXMLType(), MSTriggeredXMLReader::myInit(), RORDGenerator_ODAmounts::RORDGenerator_ODAmounts(), and GenericSAXHandler::startElement().

bool GUISettingsHandler::hasDecals ( ) const throw ()

Returns whether any decals have been parsed.

Returns:: whether decals have been parsed

Definition at line 262 of file GUISettingsHandler.cpp.

References myDecals.

Referenced by GUIDialog_ViewSettings::loadDecals().

void GenericSAXHandler::myCharacters	(	int	element,
		const std::string &	chars
	)		`[protected, virtual, inherited]`

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 ProcessError These method may throw a ProcessError if something fails

Reimplemented in ROJTRTurnDefLoader, NIImporter_ITSUMO::Handler, NIImporter_OpenDrive, NIImporter_SUMO, PCLoaderXML, PCNetProjectionLoader, and RORDLoader_SUMOBase.

Definition at line 224 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

void GenericSAXHandler::myEndElement ( int element ) [protected, virtual, inherited]

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 ProcessError These method may throw a ProcessError if something fails

Reimplemented in MSRouteHandler, MSLaneSpeedTrigger, MSTriggeredRerouter, NIImporter_ITSUMO::Handler, NIImporter_OpenDrive, NIImporter_OpenStreetMap::NodesHandler, NIImporter_OpenStreetMap::EdgesHandler, NIImporter_SUMO, NIXMLEdgesHandler, NIXMLTrafficLightsHandler, NLHandler, ODDistrictHandler, PCLoaderOSM::NodesHandler, PCLoaderOSM::EdgesHandler, RORDGenerator_ODAmounts, RORDLoader_SUMOBase, RORDLoader_TripDefs, and SAXWeightsHandler.

Definition at line 228 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

void GUISettingsHandler::myStartElement	(	int	element,
		const SUMOSAXAttributes &	attrs
	)		throw (ProcessError) `[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:: GenericSAXHandler::myStartElement

Reimplemented from GenericSAXHandler.

Definition at line 69 of file GUISettingsHandler.cpp.

GUIVisualizationTextSettings GUISettingsHandler::parseTextSettings	(	const std::string &	prefix,
		const SUMOSAXAttributes &	attrs,
		GUIVisualizationTextSettings	defaults
	)		`[private]`

parse combined settings of bool, size and color

Definition at line 212 of file GUISettingsHandler.cpp.

References GUIVisualizationTextSettings::color, SUMOSAXAttributes::getStringSecure(), RGBColor::parseColorReporting(), GUIVisualizationTextSettings::show, GUIVisualizationTextSettings::size, and toString().

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 164 of file GenericSAXHandler.cpp.

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

Referenced by NLTriggerBuilder::parseAndBuildLaneSpeedTrigger().

void GenericSAXHandler::setFileName ( const std::string & name ) throw () [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 76 of file GenericSAXHandler.cpp.

Referenced by NIImporter_SUMO::_loadNetwork(), NIImporter_OpenStreetMap::_loadNetwork(), AGActivityGen::importInfoCity(), PCNetProjectionLoader::loadIfSet(), ROLoader::loadNet(), loadNet(), NIImporter_OpenDrive::loadNetwork(), NIImporter_MATSim::loadNetwork(), NIImporter_ITSUMO::loadNetwork(), and NILoader::loadXMLType().

void GUISettingsHandler::setSnapshots ( GUISUMOAbstractView * view ) const throw ()

Makes a snapshot if it has been parsed.

Parameters:

[in] parent the view which needs to be shot

Todo:: Please describe why the snapshots are only set if no other existed before (see code)

Definition at line 254 of file GUISettingsHandler.cpp.

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded().

void GUISettingsHandler::setViewport	(	SUMOReal &	zoom,
		SUMOReal &	xoff,
		SUMOReal &	yoff
	)		const throw ()

Sets the viewport which has been parsed.

Parameters:

[out]	zoom	Variable to store the loaded zoom into
[out]	xoff	Variable to store the loaded x-offset into
[out]	yoff	Variable to store the loaded y-offset into

Definition at line 246 of file GUISettingsHandler.cpp.

void GUISettingsHandler::setViewport ( GUISUMOAbstractView * view ) const throw ()

Sets the viewport which has been parsed.

Parameters:

[in] parent the view for which the viewport has to be set

Definition at line 238 of file GUISettingsHandler.cpp.

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded().

void GenericSAXHandler::startElement	(	const XMLCh *const	uri,
		const XMLCh *const	localname,
		const XMLCh *const	qname,
		const Attributes &	attrs
	)		`[inherited]`