SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GUISettingsHandler Class Reference

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

#include <GUISettingsHandler.h>

Inheritance diagram for GUISettingsHandler:
SUMOSAXHandler GenericSAXHandler DefaultHandler

Public Member Functions

std::string addSettings (GUISUMOAbstractView *view=0) const
 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< SUMOTime > & getBreakpoints () const
 Returns the parsed breakpoints.
const std::vector
< GUISUMOAbstractView::Decal > & 
getDecals () const
 Returns the parsed decals.
SUMOReal getDelay () const
 Returns the parsed delay.
const std::string & getFileName () const
 returns the current file name
const std::string & getViewType () const
 Returns the parsed view type.
 GUISettingsHandler (const std::string &content, bool isFile=true)
 Constructor.
bool hasDecals () const
 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)
 Sets the current file name.
void setSnapshots (GUISUMOAbstractView *view) const
 Makes a snapshot if it has been parsed.
void setViewport (GUISUMOAbstractView *view) const
 Sets the viewport which has been parsed.
void setViewport (Position &lookFrom, Position &lookAt) const
 Sets the viewport which has been parsed.
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.
 ~GUISettingsHandler ()
 Destructor.
inherited from GenericSAXHandler
void myStartElement (int element, const SUMOSAXAttributes &attrs)
 Called on the opening of a tag.
SAX ErrorHandler callbacks
void warning (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-warnings.
void error (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors.
void fatalError (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 Handler for XML-errors.

Static Public Member Functions

static std::vector< SUMOTimeloadBreakpoints (const std::string &file)
 loads breakpoints from the specified file

Protected Member Functions

std::string buildErrorMessage (const XERCES_CPP_NAMESPACE::SAXParseException &exception)
 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

std::vector< SUMOTimemyBreakpoints
 The parsed breakpoints.
int myCurrentColorer
 The last color scheme category (edges or vehicles)
GUIColorSchememyCurrentScheme
 The current color scheme.
std::vector
< GUISUMOAbstractView::Decal
myDecals
 The decals list to fill.
SUMOReal myDelay
 The delay loaded.
Position myLookAt
 The point to look at, only needed for osg view.
Position myLookFrom
 The viewport loaded, zoom is stored in z coordinate.
GUIVisualizationSettings mySettings
 The settings to fill.
std::map< SUMOTime, std::string > mySnapshots
 mappig of time steps to filenames for potential snapshots
std::string myViewType
 The view type (osg, opengl, default) loaded.

Detailed Description

An XML-handler for visualisation schemes.

Definition at line 51 of file GUISettingsHandler.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters
[in]filethe file to parse

Definition at line 55 of file GUISettingsHandler.cpp.

References XMLSubSys::getSAXReader(), SUMOSAXReader::parseString(), XMLSubSys::runParser(), and GenericSAXHandler::setFileName().

GUISettingsHandler::~GUISettingsHandler ( )

Destructor.

Definition at line 69 of file GUISettingsHandler.cpp.

Member Function Documentation

std::string GUISettingsHandler::addSettings ( GUISUMOAbstractView view = 0) const
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]exceptionThe name of the currently processed file
Returns
A string describing the given exception

Definition at line 193 of file GenericSAXHandler.cpp.

References GenericSAXHandler::getFileName().

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

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

References TplConvert::_2str(), and 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 126 of file GenericSAXHandler.cpp.

References TplConvert::_2str(), 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 XERCES_CPP_NAMESPACE::SAXParseException &  exception)
inherited

Handler for XML-errors.

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

Parameters
[in]exceptionThe occured exception to process
Exceptions
ProcessErrorOn any call

Definition at line 212 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

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
ProcessErrorOn any call
Parameters
[in]exceptionThe occured exception to process

Definition at line 218 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

const std::vector<SUMOTime>& GUISettingsHandler::getBreakpoints ( ) const
inline

Returns the parsed breakpoints.

Returns
the parsed breakpoints

Definition at line 126 of file GUISettingsHandler.h.

References myBreakpoints.

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded().

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

Returns the parsed decals.

Returns
the parsed decals

Definition at line 299 of file GUISettingsHandler.cpp.

References myDecals.

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

SUMOReal GUISettingsHandler::getDelay ( ) const

Returns the parsed delay.

Returns
the parsed delay

Definition at line 305 of file GUISettingsHandler.cpp.

References myDelay.

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded().

const std::string& GUISettingsHandler::getViewType ( ) const
inline

Returns the parsed view type.

Returns
the parsed view type

Definition at line 138 of file GUISettingsHandler.h.

References myViewType.

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded().

bool GUISettingsHandler::hasDecals ( ) const

Returns whether any decals have been parsed.

Returns
whether decals have been parsed

Definition at line 293 of file GUISettingsHandler.cpp.

References myDecals.

Referenced by GUIDialog_ViewSettings::loadDecals().

std::vector< SUMOTime > GUISettingsHandler::loadBreakpoints ( const std::string &  file)
static

loads breakpoints from the specified file

Definition at line 311 of file GUISettingsHandler.cpp.

References string2time(), and WRITE_ERROR.

Referenced by myStartElement(), and GUIDialog_Breakpoints::onCmdLoad().

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]elementThe opened element, given as a int
[in]charsThe complete embedded character string ProcessError These method may throw a ProcessError if something fails

Reimplemented in NIImporter_ITSUMO::Handler.

Definition at line 228 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

void GenericSAXHandler::myEndElement ( int  element)
protectedvirtualinherited
void GUISettingsHandler::myStartElement ( int  element,
const SUMOSAXAttributes attrs 
)
virtual

Called on the opening of a tag.

Parameters
[in]elementID of the currently opened element
[in]attrsAttributes within the currently opened element
Exceptions
ProcessErrorIf something fails
See Also
GenericSAXHandler::myStartElement

Reimplemented from GenericSAXHandler.

Definition at line 74 of file GUISettingsHandler.cpp.

References TplConvert::_2bool(), TplConvert::_2int(), TplConvert::_2SUMOReal(), GUIColorScheme::addColor(), GUIVisualizationSettings::addExaggeration, GUIVisualizationSettings::addMode, GUIVisualizationSettings::addName, GUISUMOAbstractView::Decal::altitude, GUIVisualizationSettings::antialiase, GUIVisualizationSettings::backgroundColor, GUISUMOAbstractView::Decal::centerX, GUISUMOAbstractView::Decal::centerY, GUISUMOAbstractView::Decal::centerZ, GUIColorScheme::clear(), GUICompleteSchemeStorage::contains(), GUIVisualizationSettings::dither, GUIVisualizationSettings::drawLinkJunctionIndex, GUIVisualizationSettings::drawLinkTLIndex, GUIVisualizationSettings::edgeName, GUISUMOAbstractView::Decal::filename, GUICompleteSchemeStorage::get(), SUMOSAXAttributes::get(), FileHelpers::getConfigurationRelative(), GenericSAXHandler::getFileName(), SUMOSAXAttributes::getOpt(), SUMOSAXAttributes::getOptSUMOTimeReporting(), GUIColorer::getSchemeByName(), SUMOSAXAttributes::getStringSecure(), GUIVisualizationSettings::gridXSize, GUIVisualizationSettings::gridYSize, gSchemeStorage, GUISUMOAbstractView::Decal::height, GUIVisualizationSettings::hideConnectors, GUISUMOAbstractView::Decal::initialised, GUIVisualizationSettings::internalEdgeName, GUIVisualizationSettings::internalJunctionName, FileHelpers::isAbsolute(), GUIColorScheme::isFixed(), GUIVisualizationSettings::junctionColorer, GUIVisualizationSettings::junctionName, GUIVisualizationSettings::laneColorer, GUIVisualizationSettings::laneShowBorders, GUISUMOAbstractView::Decal::layer, loadBreakpoints(), GUIVisualizationSettings::minAddSize, GUIVisualizationSettings::minPOISize, GUIVisualizationSettings::minPolySize, GUIVisualizationSettings::minVehicleSize, myBreakpoints, myCurrentColorer, myCurrentScheme, myDecals, myDelay, myLookAt, myLookFrom, mySettings, mySnapshots, myViewType, GUIVisualizationSettings::name, RGBColor::parseColorReporting(), parseTextSettings(), GUIVisualizationSettings::poiExaggeration, GUIVisualizationSettings::poiName, GUIVisualizationSettings::polyExaggeration, GUIVisualizationSettings::polyName, GUISUMOAbstractView::Decal::roll, GUISUMOAbstractView::Decal::rot, Position::set(), GUIColorer::setActive(), GUIColorScheme::setColor(), GUIColorScheme::setInterpolated(), GUIVisualizationSettings::showBlinker, GUIVisualizationSettings::showGrid, GUIVisualizationSettings::showLane2Lane, GUIVisualizationSettings::showLinkDecals, GUIVisualizationSettings::showRails, GUIVisualizationSettings::showSizeLegend, GUIVisualizationSettings::streetName, SUMO_ATTR_CENTER_X, SUMO_ATTR_CENTER_Y, SUMO_ATTR_CENTER_Z, SUMO_ATTR_COLOR, SUMO_ATTR_FILE, SUMO_ATTR_HEIGHT, SUMO_ATTR_INTERPOLATED, SUMO_ATTR_LAYER, SUMO_ATTR_NAME, SUMO_ATTR_THRESHOLD, SUMO_ATTR_TIME, SUMO_ATTR_TYPE, SUMO_ATTR_VALUE, SUMO_ATTR_WIDTH, SUMO_ATTR_X, SUMO_ATTR_Y, SUMO_ATTR_ZOOM, SUMO_TAG_BREAKPOINTS_FILE, SUMO_TAG_COLORSCHEME, SUMO_TAG_DELAY, SUMO_TAG_ENTRY, SUMO_TAG_SNAPSHOT, SUMO_TAG_VIEWPORT, SUMO_TAG_VIEWSETTINGS, SUMO_TAG_VIEWSETTINGS_ADDITIONALS, SUMO_TAG_VIEWSETTINGS_BACKGROUND, SUMO_TAG_VIEWSETTINGS_DECAL, SUMO_TAG_VIEWSETTINGS_EDGES, SUMO_TAG_VIEWSETTINGS_JUNCTIONS, SUMO_TAG_VIEWSETTINGS_LEGEND, SUMO_TAG_VIEWSETTINGS_OPENGL, SUMO_TAG_VIEWSETTINGS_POIS, SUMO_TAG_VIEWSETTINGS_POLYS, SUMO_TAG_VIEWSETTINGS_SCHEME, SUMO_TAG_VIEWSETTINGS_VEHICLES, SUMOReal, GUISUMOAbstractView::Decal::tilt, toString(), GUIVisualizationSettings::vehicleColorer, GUIVisualizationSettings::vehicleExaggeration, GUIVisualizationSettings::vehicleName, GUIVisualizationSettings::vehicleQuality, GUISUMOAbstractView::Decal::width, Position::x(), Position::y(), and Position::z().

GUIVisualizationTextSettings GUISettingsHandler::parseTextSettings ( const std::string &  prefix,
const SUMOSAXAttributes attrs,
GUIVisualizationTextSettings  defaults 
)
private
void GenericSAXHandler::registerParent ( const int  tag,
GenericSAXHandler handler 
)
inherited
void GenericSAXHandler::setFileName ( const std::string &  name)
inherited

Sets the current file name.

Parameters
[in]nameThe name of the currently processed file
Todo:
Hmmm - this is as unsafe as having a direct access to the variable; recheck

Definition at line 80 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myFileName.

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

void GUISettingsHandler::setSnapshots ( GUISUMOAbstractView view) const

Makes a snapshot if it has been parsed.

Parameters
[in]parentthe 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 285 of file GUISettingsHandler.cpp.

References mySnapshots, and GUISUMOAbstractView::setSnapshots().

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded().

void GUISettingsHandler::setViewport ( GUISUMOAbstractView view) const

Sets the viewport which has been parsed.

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

Definition at line 270 of file GUISettingsHandler.cpp.

References myLookAt, myLookFrom, GUISUMOAbstractView::setViewport(), and Position::z().

Referenced by GUIApplicationWindow::handleEvent_SimulationLoaded().

void GUISettingsHandler::setViewport ( Position lookFrom,
Position lookAt 
) const

Sets the viewport which has been parsed.

Parameters
[out]zoomVariable to store the loaded zoom into
[out]xoffVariable to store the loaded x-offset into
[out]yoffVariable to store the loaded y-offset into

Definition at line 278 of file GUISettingsHandler.cpp.

References myLookAt, and myLookFrom.

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

References TplConvert::_2str(), GenericSAXHandler::convertTag(), FileHelpers::getConfigurationRelative(), GenericSAXHandler::getFileName(), SUMOSAXAttributesImpl_Xerces::getString(), FileHelpers::isAbsolute(), GenericSAXHandler::myCharactersVector, GenericSAXHandler::myPredefinedTags, GenericSAXHandler::myPredefinedTagsMML, GenericSAXHandler::myStartElement(), XMLSubSys::runParser(), SUMO_ATTR_HREF, and SUMO_TAG_INCLUDE.

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]exceptionThe occured exception to process

Definition at line 206 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

Field Documentation

std::vector<SUMOTime> GUISettingsHandler::myBreakpoints
private

The parsed breakpoints.

Definition at line 172 of file GUISettingsHandler.h.

Referenced by getBreakpoints(), and myStartElement().

int GUISettingsHandler::myCurrentColorer
private

The last color scheme category (edges or vehicles)

Definition at line 166 of file GUISettingsHandler.h.

Referenced by myStartElement().

GUIColorScheme* GUISettingsHandler::myCurrentScheme
private

The current color scheme.

Definition at line 169 of file GUISettingsHandler.h.

Referenced by myStartElement().

std::vector<GUISUMOAbstractView::Decal> GUISettingsHandler::myDecals
private

The decals list to fill.

Definition at line 163 of file GUISettingsHandler.h.

Referenced by getDecals(), hasDecals(), and myStartElement().

SUMOReal GUISettingsHandler::myDelay
private

The delay loaded.

Definition at line 151 of file GUISettingsHandler.h.

Referenced by getDelay(), and myStartElement().

Position GUISettingsHandler::myLookAt
private

The point to look at, only needed for osg view.

Definition at line 157 of file GUISettingsHandler.h.

Referenced by myStartElement(), and setViewport().

Position GUISettingsHandler::myLookFrom
private

The viewport loaded, zoom is stored in z coordinate.

Definition at line 154 of file GUISettingsHandler.h.

Referenced by myStartElement(), and setViewport().

GUIVisualizationSettings GUISettingsHandler::mySettings
private

The settings to fill.

Definition at line 145 of file GUISettingsHandler.h.

Referenced by addSettings(), and myStartElement().

std::map<SUMOTime, std::string> GUISettingsHandler::mySnapshots
private

mappig of time steps to filenames for potential snapshots

Definition at line 160 of file GUISettingsHandler.h.

Referenced by myStartElement(), and setSnapshots().

std::string GUISettingsHandler::myViewType
private

The view type (osg, opengl, default) loaded.

Definition at line 148 of file GUISettingsHandler.h.

Referenced by getViewType(), and myStartElement().


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