#include <GNETLSEditorFrame.h>

Inheritance diagram for GNETLSEditorFrame::TLSFile:

Collaboration diagram for GNETLSEditorFrame::TLSFile:

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

bool	checkTLSValids ()
	check if loaded TrafficLights corresponds to a TL controled junction in net More...

void	clearLoadedTLS ()
	clear loaded phases More...

void	disableTLSFile ()
	disable all elements TLSFile More...

void	enableTLSFile ()
	enable all elements TLSFile 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...

const std::vector< NBLoadedSUMOTLDef * > &	getLoadedTLS () const
	get loaded phases 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...

	TLSFile (GNETLSEditorFrame *TLSEditorParent)
	FOX-declaration. More...

	~TLSFile ()
	destructor More...

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

FOX-callbacks
load TLS Program from an additional file
long	onCmdLoadTLSProgram (FXObject , FXSelector, void )

long	onCmdSaveTLSProgram (FXObject , FXSelector, void )
	save TLS Programm to an additional file More...

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...

Protected Member Functions
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...

void	setSchemaSeen (const bool schemaSeen=true)

	TLSFile ()
	FOX needs this. More...

Private Member Functions
std::string	writeSUMOTime (SUMOTime steps)
	convert SUMOTime into string More...

Private Attributes
std::vector< NBLoadedSUMOTLDef * >	myLoadedTLS
	container used to save loaded TLSs More...

FXButton *	myLoadTLSProgramButton
	button for load TLS Programs More...

FXButton *	mySaveTLSProgramButton
	button for save TLS Programs More...

GNETLSEditorFrame *	myTLSEditorParent
	pointer to TLSEditor Parent More...

Detailed Description

Definition at line 267 of file GNETLSEditorFrame.h.

Constructor & Destructor Documentation

◆ TLSFile() [1/2]

GNETLSEditorFrame::TLSFile::TLSFile ( GNETLSEditorFrame * TLSEditorParent )

FOX-declaration.

constructor

Definition at line 1047 of file GNETLSEditorFrame.cpp.

References disableTLSFile(), GUIDesignButton, MID_GNE_TLSFRAME_LOAD_PROGRAM, MID_GNE_TLSFRAME_SAVE_PROGRAM, myLoadTLSProgramButton, mySaveTLSProgramButton, and GNEFrame::show().

◆ ~TLSFile()

GNETLSEditorFrame::TLSFile::~TLSFile ( )

destructor

Definition at line 1062 of file GNETLSEditorFrame.cpp.

◆ TLSFile() [2/2]

GNETLSEditorFrame::TLSFile::TLSFile ( )

inlineprotected

FOX needs this.

Definition at line 316 of file GNETLSEditorFrame.h.

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

References GenericSAXHandler::getFileName().

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

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

References TplConvert::_2str(), and GenericSAXHandler::myCharactersVector.

◆ checkTLSValids()

bool GNETLSEditorFrame::TLSFile::checkTLSValids ( )

check if loaded TrafficLights corresponds to a TL controled junction in net

Definition at line 1134 of file GNETLSEditorFrame.cpp.

References GNEViewNet::getNet(), GNEViewNet::getUndoList(), GNEFrame::getViewNet(), myLoadedTLS, myTLSEditorParent, GNENet::retrieveJunction(), GNEJunction::setAttribute(), SUMO_ATTR_TYPE, toString(), and WRITE_DEBUG.

Referenced by GNETLSEditorFrame::parseTLSPrograms().

◆ clearLoadedTLS()

void GNETLSEditorFrame::TLSFile::clearLoadedTLS ( )

clear loaded phases

Definition at line 1119 of file GNETLSEditorFrame.cpp.

References myLoadedTLS.

Referenced by onCmdLoadTLSProgram().

◆ disableTLSFile()

void GNETLSEditorFrame::TLSFile::disableTLSFile ( )

disable all elements TLSFile

Definition at line 1111 of file GNETLSEditorFrame.cpp.

References myLoadTLSProgramButton, and mySaveTLSProgramButton.

Referenced by GNETLSEditorFrame::onCmdCancel(), and TLSFile().

◆ enableTLSFile()

void GNETLSEditorFrame::TLSFile::enableTLSFile ( )

enable all elements TLSFile

Definition at line 1103 of file GNETLSEditorFrame.cpp.

References myLoadTLSProgramButton, and mySaveTLSProgramButton.

Referenced by GNETLSEditorFrame::TLSAttributes::initTLSAttributes().

◆ 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 121 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.

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

References GenericSAXHandler::buildErrorMessage().

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

◆ 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 212 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 75 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(), NILoader::loadXMLType(), NLHandler::myEndElement(), RODFDetectorHandler::myStartElement(), GUISettingsHandler::myStartElement(), SUMORouteHandler::myStartElement(), NLHandler::myStartElement(), NIImporter_OpenDrive::myStartElement(), XMLSubSys::runParser(), GenericSAXHandler::startElement(), and SUMORouteLoader::SUMORouteLoader().

◆ getLoadedTLS()

const std::vector< NBLoadedSUMOTLDef * > & GNETLSEditorFrame::TLSFile::getLoadedTLS ( ) const

get loaded phases

Definition at line 1128 of file GNETLSEditorFrame.cpp.

References myLoadedTLS.

Referenced by GNETLSEditorFrame::parseTLSPrograms().

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

Reimplemented in NIImporter_OpenDrive, and NIImporter_ITSUMO::Handler.

Definition at line 222 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement().

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

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

Definition at line 226 of file GenericSAXHandler.cpp.

Referenced by GenericSAXHandler::endElement(), and SUMOSAXReader::parseNext().

◆ myStartElement()

void GNETLSEditorFrame::TLSFile::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: GenericSAXHandler::myStartElement

Reimplemented from GenericSAXHandler.

Definition at line 1066 of file GNETLSEditorFrame.cpp.

References SUMOSAXAttributes::get(), StringBijection< T >::get(), GNEViewNet::getNet(), SUMOSAXAttributes::getOpt(), SUMOSAXAttributes::getOptSUMOTimeReporting(), GNEFrame::getViewNet(), myLoadedTLS, myTLSEditorParent, GNENet::retrieveJunction(), SUMO_ATTR_DURATION, SUMO_ATTR_ID, SUMO_ATTR_OFFSET, SUMO_ATTR_PROGRAMID, SUMO_ATTR_STATE, SUMO_ATTR_TYPE, SUMO_TAG_PHASE, SUMO_TAG_TLLOGIC, TIME2STEPS, TLTYPE_STATIC, SUMOXMLDefinitions::TrafficLightTypes, and WRITE_ERROR.

◆ onCmdLoadTLSProgram()

long GNETLSEditorFrame::TLSFile::onCmdLoadTLSProgram	(	FXObject *	,
		FXSelector	,
		void *
	)

Definition at line 1179 of file GNETLSEditorFrame.cpp.

References NBLoadedSUMOTLDef::cleanupStates(), clearLoadedTLS(), gCurrentFolder, GUIIconSubSys::getIcon(), ICON_MODETLS, GNETLSEditorFrame::TLSPhases::initPhaseTable(), GNETLSEditorFrame::myEditedDef, myTLSEditorParent, GNETLSEditorFrame::myTLSModifications, GNETLSEditorFrame::myTLSPhases, XMLSubSys::runParser(), and GNETLSEditorFrame::TLSModifications::setHaveModifications().

◆ onCmdSaveTLSProgram()

long GNETLSEditorFrame::TLSFile::onCmdSaveTLSProgram	(	FXObject *	,
		FXSelector	,
		void *
	)

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

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

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

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

References GenericSAXHandler::myFileName.

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

◆ setSchemaSeen()

void GenericSAXHandler::setSchemaSeen ( const bool schemaSeen = true )

inlineprotectedinherited

Definition at line 255 of file GenericSAXHandler.h.

References GenericSAXHandler::convert(), GenericSAXHandler::convertTag(), and GenericSAXHandler::mySchemaSeen.

Referenced by SUMOSAXReader::LocalSchemaResolver::resolveEntity().

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

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

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

References GenericSAXHandler::buildErrorMessage(), and WRITE_WARNING.

◆ writeSUMOTime()

std::string GNETLSEditorFrame::TLSFile::writeSUMOTime ( SUMOTime steps )

private

convert SUMOTime into string

Definition at line 1254 of file GNETLSEditorFrame.cpp.

References STEPS2TIME, and toString().

Referenced by onCmdSaveTLSProgram().

Field Documentation

◆ myLoadedTLS

std::vector<NBLoadedSUMOTLDef*> GNETLSEditorFrame::TLSFile::myLoadedTLS

private

container used to save loaded TLSs

Definition at line 329 of file GNETLSEditorFrame.h.

Referenced by checkTLSValids(), clearLoadedTLS(), getLoadedTLS(), and myStartElement().

◆ myLoadTLSProgramButton

FXButton* GNETLSEditorFrame::TLSFile::myLoadTLSProgramButton

private

button for load TLS Programs

Definition at line 323 of file GNETLSEditorFrame.h.

Referenced by disableTLSFile(), enableTLSFile(), and TLSFile().

◆ mySaveTLSProgramButton

FXButton* GNETLSEditorFrame::TLSFile::mySaveTLSProgramButton

private

button for save TLS Programs

Definition at line 326 of file GNETLSEditorFrame.h.

Referenced by disableTLSFile(), enableTLSFile(), and TLSFile().

◆ myTLSEditorParent

GNETLSEditorFrame* GNETLSEditorFrame::TLSFile::myTLSEditorParent

private

pointer to TLSEditor Parent

Definition at line 320 of file GNETLSEditorFrame.h.

Referenced by checkTLSValids(), myStartElement(), onCmdLoadTLSProgram(), and onCmdSaveTLSProgram().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TLSFile() [1/2]

◆ ~TLSFile()

◆ TLSFile() [2/2]

Member Function Documentation

◆ buildErrorMessage()

◆ characters()

◆ checkTLSValids()

◆ clearLoadedTLS()

◆ disableTLSFile()

◆ enableTLSFile()

◆ endElement()

◆ error()

◆ fatalError()

◆ getFileName()

◆ getLoadedTLS()

◆ myCharacters()

◆ myEndElement()

◆ myStartElement()

◆ onCmdLoadTLSProgram()

◆ onCmdSaveTLSProgram()

◆ registerParent()

◆ setFileName()

◆ setSchemaSeen()

◆ startElement()

◆ warning()

◆ writeSUMOTime()

Field Documentation

◆ myLoadedTLS

◆ myLoadTLSProgramButton

◆ mySaveTLSProgramButton

◆ myTLSEditorParent