Changes the speed allowed on a set of lanes. More...

#include <MSLaneSpeedTrigger.h>

Inheritance diagram for MSLaneSpeedTrigger:

Public Member Functions
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.
SUMOTime	execute (SUMOTime currentTime)
	Executes a switch command.
SUMOReal	getCurrentSpeed () const
	Returns the current speed.
SUMOReal	getDefaultSpeed () const
const std::string &	getFileName () const
	returns the current file name
const std::string &	getID () const
	Returns the id.
SUMOReal	getLoadedSpeed ()
	MSLaneSpeedTrigger (const std::string &id, const std::vector< MSLane * > &destLanes, const std::string &file)
	Constructor.
SUMOTime	processCommand (bool move2next, SUMOTime currentTime)
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	setID (const std::string &newID)
	resets the id
void	setOverriding (bool val)
void	setOverridingValue (SUMOReal val)
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.
virtual	~MSLaneSpeedTrigger ()
	Destructor.
SAX ErrorHandler callbacks
void	warning (const SAXParseException &exception)
	Handler for XML-warnings.
void	error (const SAXParseException &exception)
	Handler for XML-errors.
void	fatalError (const SAXParseException &exception)
	Handler for XML-errors.
Protected Member Functions
std::string	buildErrorMessage (const SAXParseException &exception)
	Builds an error message.
virtual void	myCharacters (int element, const std::string &chars)
	Callback method for characters to implement by derived classes.
inherited from GenericSAXHandler
virtual void	myStartElement (int element, const SUMOSAXAttributes &attrs)
	Called on the opening of a tag;.
virtual void	myEndElement (int element)
	Called on the closing of a tag;.
Protected Attributes
bool	myAmOverriding
	The information whether the read speed shall be overridden.
std::vector< std::pair < SUMOTime, SUMOReal > >::iterator	myCurrentEntry
SUMOReal	myCurrentSpeed
SUMOReal	myDefaultSpeed
	The original speed allowed on the lanes.
std::vector< MSLane * >	myDestLanes
std::string	myID
	The name of the object.
std::vector< std::pair < SUMOTime, SUMOReal > >	myLoadedSpeeds
SUMOReal	mySpeedOverrideValue
	The speed to use if overriding the read speed.
Private Member Functions
void	init ()
	MSLaneSpeedTrigger (const MSLaneSpeedTrigger &)
	Invalidated copy constructor.
MSLaneSpeedTrigger &	operator= (const MSLaneSpeedTrigger &)
	Invalidated assignment operator.
Private Attributes
bool	myDidInit
	The information whether init was called.

Detailed Description

Changes the speed allowed on a set of lanes.

This trigger reads the next maximum velocity of the lane he is responsible for from a file and sets it. Lanes with variable speeds are so possible.

Definition at line 61 of file MSLaneSpeedTrigger.h.

Constructor & Destructor Documentation

MSLaneSpeedTrigger::MSLaneSpeedTrigger	(	const std::string &	id,
		const std::vector< MSLane * > &	destLanes,
		const std::string &	file
	)

Constructor.

Parameters:

[in]	id	The id of the lane speed trigger
[in]	net	The net the lane speed trigger belongs to
[in]	destLanes	List of lanes affected by this speed trigger
[in]	file	Name of the file to read the speeds to set from

Definition at line 62 of file MSLaneSpeedTrigger.cpp.

References init(), myCurrentSpeed, myDidInit, and XMLSubSys::runParser().

MSLaneSpeedTrigger::~MSLaneSpeedTrigger ( ) [virtual]

Destructor.

Definition at line 100 of file MSLaneSpeedTrigger.cpp.

MSLaneSpeedTrigger::MSLaneSpeedTrigger ( const MSLaneSpeedTrigger & ) [private]

Invalidated copy constructor.

Member Function Documentation

std::string GenericSAXHandler::buildErrorMessage ( const SAXParseException & exception ) [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 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 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 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 ) [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 212 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

Referenced by NLHandler::getLanesFromIndices().

SUMOTime MSLaneSpeedTrigger::execute ( SUMOTime currentTime ) [virtual]

Executes a switch command.

Calls processCommand()

Parameters:

[in] currentTime The current simulation time

See also:: Command; MSEventControl

Implements Command.

Definition at line 104 of file MSLaneSpeedTrigger.cpp.

References processCommand().

Referenced by init().

void GenericSAXHandler::fatalError ( const 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 occured exception to process

Definition at line 218 of file GenericSAXHandler.cpp.

References GenericSAXHandler::buildErrorMessage().

SUMOReal MSLaneSpeedTrigger::getCurrentSpeed ( ) const

Returns the current speed.

Definition at line 211 of file MSLaneSpeedTrigger.cpp.

References MSNet::getCurrentTimeStep(), MSNet::getInstance(), myAmOverriding, myCurrentEntry, myDefaultSpeed, myLoadedSpeeds, and mySpeedOverrideValue.

Referenced by GUILaneSpeedTrigger::drawGL(), GUILaneSpeedTrigger::getParameterWindow(), and processCommand().

SUMOReal MSLaneSpeedTrigger::getDefaultSpeed ( ) const

Definition at line 181 of file MSLaneSpeedTrigger.cpp.

References myDefaultSpeed.

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

returns the current file name

Returns:: The name of the currently processed file

Definition at line 86 of file GenericSAXHandler.cpp.

References GenericSAXHandler::myFileName.

Referenced by NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), NLHandler::addInstantE1Detector(), NLHandler::addRouteProbeDetector(), NLHandler::addVTypeProbeDetector(), NLHandler::beginE3Detector(), GenericSAXHandler::buildErrorMessage(), MSRouteLoader::init(), PCNetProjectionLoader::loadIfSet(), NILoader::loadXMLType(), MSTriggeredXMLReader::myInit(), RODFDetectorHandler::myStartElement(), NLHandler::myStartElement(), NIImporter_OpenDrive::myStartElement(), GUISettingsHandler::myStartElement(), RORDGenerator_ODAmounts::RORDGenerator_ODAmounts(), ROTypedXMLRoutesLoader::ROTypedXMLRoutesLoader(), XMLSubSys::runParser(), and GenericSAXHandler::startElement().

const std::string& Named::getID ( ) const [inline, inherited]

Returns the id.

Returns:: The stored id

Reimplemented in MS_E2_ZS_CollectorOverLanes.

Definition at line 61 of file Named.h.

References Named::myID.

Referenced by ShapeContainer::add(), MSDetectorControl::add(), RORouteDef_Alternatives::addAlternative(), MSNet::addBusStop(), NLHandler::addConnection(), NBLoadedSUMOTLDef::addConnection(), NIImporter_OpenDrive::addE2EConnectionsSecure(), RONet::addNode(), NIImporter_SUMO::addPhase(), RONet::addRouteDef(), NBDistrict::addSink(), NBDistrict::addSource(), MSRouteHandler::addStop(), NIXMLTrafficLightsHandler::addTlConnection(), NIVissimDisturbance::addToNode(), MSVehicle::addTraciStop(), NIVisumTL::build(), MS_E2_ZS_CollectorOverLanes::buildCollector(), NIImporter_VISUM::buildDistrictNode(), NIVissimConnection::buildEdgeConnections(), NBEdge::buildInnerEdges(), NIVissimEdge::buildNBEdge(), NBNodeCont::buildOffRamp(), NBNodeCont::buildOnRamp(), ODDistrictHandler::closeDistrict(), NBTrafficLightDefinition::collectEdges(), NBOwnTLDef::collectLinks(), NBTrafficLightDefinition::compute(), NBNode::computeInternalLaneShape(), NBEdge::computeLaneShapes(), NBNode::computeLogic(), NBNode::computeNodeShape(), NBTrafficLightLogicCont::computeSingleLogic(), NBTurningDirectionsComputer::computeTurnDirectionsForNode(), NBEdge::connections_sorter(), MSLane::detectCollisions(), NIVissimDistrictConnection::dict_BuildDistricts(), MSE3Collector::enter(), MSVTypeProbe::execute(), Command_SaveTLSSwitches::execute(), NBTrafficLightLogicCont::extract(), NBNodeCont::extract(), NBEdgeCont::extract(), MSNet::getBusStopID(), NIImporter_VISUM::getNamedEdgeContinuating(), NLTriggerBuilder::getPosition(), NBNode::getPossiblySplittedIncoming(), NBNode::getPossiblySplittedOutgoing(), NIImporter_VISUM::getReversedContinuating(), NBEdgeCont::ignoreFilterMatch(), MSUnboundActuatedTrafficLightLogic::init(), MSAgentbasedTrafficLightLogic::init(), MSActuatedTrafficLightLogic::init(), NIXMLTrafficLightsHandler::initTrafficLightLogic(), NIImporter_SUMO::initTrafficLightLogic(), NBTrafficLightLogicCont::insert(), NBNodeCont::insert(), NBEdgeCont::insert(), NBDistrictCont::insert(), NBEdgeCont::joinSameNodeConnectingEdges(), MSE3Collector::leave(), NIImporter_OpenDrive::loadNetwork(), MSLane::moveCritical(), MSVehicle::MSVehicle(), RORDLoader_SUMOBase::myCharacters(), NBOwnTLDef::myCompute(), NBLoadedTLDef::myCompute(), NIXMLTrafficLightsHandler::myEndElement(), NIXMLEdgesHandler::myEndElement(), NIImporter_SUMO::myEndElement(), NIXMLConnectionsHandler::myStartElement(), MSTriggeredRerouter::myStartElement(), myStartElement(), NBConnection::NBConnection(), NBRequest::NBRequest(), MSDevice_Tripinfo::notifyEnter(), MSDevice_Tripinfo::notifyLeave(), NBOwnTLDef::edge_by_incoming_priority_sorter::operator()(), NBNode::nodes_by_id_sorter::operator()(), NBNetBuilder::by_id_sorter::operator()(), NBContHelper::same_connection_edge_sorter::operator()(), NBTurningDirectionsComputer::combination_by_angle_sorter::operator()(), Named::ComparatorIdLess::operator()(), NIImporter_VISUM::parse_EdgePolys(), NIImporter_VISUM::parse_Lanes(), NIImporter_VISUM::parse_LanesConnections(), NIImporter_VISUM::parse_Turns(), NIImporter_VISUM::parse_TurnsToSignalGroups(), NIXMLConnectionsHandler::parseDeprecatedLaneDefinition(), NIXMLConnectionsHandler::parseLaneBound(), NBLoadedTLDef::SignalGroup::patchTYellow(), RORouteDef_Complete::preComputeCurrentRoute(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_TLS::processGet(), TraCIServerAPI_Lane::processGet(), TraCIServerAPI_InductionLoop::processGet(), NWWriter_SUMO::prohibitionConnection(), NBLoadedTLDef::SignalGroup::remapIncoming(), NBLoadedTLDef::SignalGroup::remapOutgoing(), NBLoadedSUMOTLDef::removeConnection(), NBNode::removeSelfLoops(), NBEdgeCont::removeUnwishedEdges(), NBNodeCont::removeUnwishedNodes(), NBNodeCont::rename(), NBEdgeCont::rename(), NBConnection::replaceFrom(), MSBaseVehicle::replaceRouteEdges(), NBConnection::replaceTo(), NIXMLTrafficLightsHandler::retrieveLaneIndex(), NBNodeCont::setAsTLControlled(), NBEdge::setControllingTLInformation(), MSLane::setCritical(), NIXMLEdgesHandler::setNodes(), NBOwnTLDef::setTLControllingInformation(), NBLoadedTLDef::setTLControllingInformation(), NBLoadedSUMOTLDef::setTLControllingInformation(), NBEdgeCont::splitAt(), RORDLoader_SUMOBase::startRoute(), NBEdge::startShapeAt(), NIXMLConnectionsHandler::validateLaneInfo(), MSInstantInductLoop::write(), NWWriter_SUMO::writeConnection(), NWWriter_SUMO::writeDistrict(), NWWriter_SUMO::writeEdge(), MSMeanData::writeEdge(), NWWriter_XML::writeEdgesAndConnections(), NWWriter_SUMO::writeInternalConnections(), NWWriter_SUMO::writeJunction(), NWWriter_OpenDrive::writeNetwork(), NWWriter_XML::writeNodes(), MSInductLoop::writeTypedXMLOutput(), MSRouteProbe::writeXMLOutput(), and MSE2Collector::writeXMLOutput().

SUMOReal MSLaneSpeedTrigger::getLoadedSpeed ( )

Definition at line 201 of file MSLaneSpeedTrigger.cpp.

References myCurrentEntry, and myLoadedSpeeds.

void MSLaneSpeedTrigger::init ( ) [private]

Definition at line 79 of file MSLaneSpeedTrigger.cpp.

References MSEventControl::addEvent(), execute(), MSNet::getBeginOfTimestepEvents(), MSNet::getCurrentTimeStep(), MSNet::getInstance(), myCurrentEntry, myCurrentSpeed, myDidInit, myLoadedSpeeds, MSEventControl::NO_CHANGE, and processCommand().

Referenced by MSLaneSpeedTrigger(), and myEndElement().

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

Referenced by GenericSAXHandler::endElement().

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

Called on the closing of a tag;.

Parameters:

[in] element ID of the currently closed element

Exceptions:

ProcessError If something fails

See also:: GenericSAXHandler::myEndElement

Reimplemented from GenericSAXHandler.

Definition at line 173 of file MSLaneSpeedTrigger.cpp.

References init(), myDidInit, and SUMO_TAG_VSS.

void MSLaneSpeedTrigger::myStartElement	(	int	element,
		const SUMOSAXAttributes &	attrs
	)		`[protected, 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 143 of file MSLaneSpeedTrigger.cpp.

References Named::getID(), SUMOSAXAttributes::getOptSUMORealReporting(), SUMOSAXAttributes::getSUMOTimeReporting(), myLoadedSpeeds, SUMO_ATTR_SPEED, SUMO_ATTR_TIME, SUMO_TAG_STEP, SUMOReal, time2string(), WRITE_ERROR, and WRITE_WARNING.

MSLaneSpeedTrigger& MSLaneSpeedTrigger::operator= ( const MSLaneSpeedTrigger & ) [private]

Invalidated assignment operator.

SUMOTime MSLaneSpeedTrigger::processCommand	(	bool	move2next,
		SUMOTime	currentTime
	)

Definition at line 110 of file MSLaneSpeedTrigger.cpp.

References getCurrentSpeed(), MSGlobals::gUseMesoSim, myCurrentEntry, myDestLanes, myLoadedSpeeds, SUMOReal, and UNUSED_PARAMETER.

Referenced by execute(), init(), setOverriding(), and setOverridingValue().

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

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

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

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

References GenericSAXHandler::myFileName.

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

void Named::setID ( const std::string & newID ) [inline, inherited]

resets the id

Definition at line 67 of file Named.h.

References Named::myID.

Referenced by NBNodeCont::rename(), and NBEdgeCont::rename().

void MSLaneSpeedTrigger::setOverriding ( bool val )

Definition at line 187 of file MSLaneSpeedTrigger.cpp.

References MSNet::getInstance(), myAmOverriding, and processCommand().

Referenced by GUILaneSpeedTrigger::GUIManip_LaneSpeedTrigger::onCmdChangeOption().

void MSLaneSpeedTrigger::setOverridingValue ( SUMOReal val )

Definition at line 194 of file MSLaneSpeedTrigger.cpp.

References MSNet::getInstance(), mySpeedOverrideValue, and processCommand().

Referenced by GUILaneSpeedTrigger::GUIManip_LaneSpeedTrigger::onCmdChangeOption(), GUILaneSpeedTrigger::GUIManip_LaneSpeedTrigger::onCmdPreDef(), and GUILaneSpeedTrigger::GUIManip_LaneSpeedTrigger::onCmdUserDef().

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