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

Builds trigger objects for microsim. More...

#include <NLTriggerBuilder.h>

Inheritance diagram for NLTriggerBuilder:
GUITriggerBuilder

Public Member Functions

void buildVaporizer (const SUMOSAXAttributes &attrs)
 Builds a vaporization.
 NLTriggerBuilder ()
 Constructor.
void setHandler (NLHandler *handler)
 Sets the parent handler to use for nested parsing.
virtual ~NLTriggerBuilder ()
 Destructor.
parsing methods

These methods parse the attributes for each of the described trigger and call the according methods to build the trigger

void parseAndBuildLaneSpeedTrigger (MSNet &net, const SUMOSAXAttributes &attrs, const std::string &base)
 Parses his values and builds a lane speed trigger.
void parseAndBuildRerouter (MSNet &net, const SUMOSAXAttributes &attrs, const std::string &base)
 Parses his values and builds a rerouter.
void parseAndBuildBusStop (MSNet &net, const SUMOSAXAttributes &attrs)
 Parses his values and builds a bus stop.
void parseAndBuildCalibrator (MSNet &net, const SUMOSAXAttributes &attrs, const std::string &base)
 Parses his values and builds a mesoscopic or microscopic calibrator.

Protected Member Functions

building methods

Called with parsed values, these methods build the trigger.

These methods should be overriden for the gui loader in order to build visualizable versions of the triggers.

In most cases, these methods only call the constructor.

virtual MSLaneSpeedTriggerbuildLaneSpeedTrigger (MSNet &net, const std::string &id, const std::vector< MSLane * > &destLanes, const std::string &file)
 Builds a lane speed trigger.
virtual void buildBusStop (MSNet &net, const std::string &id, const std::vector< std::string > &lines, MSLane *lane, SUMOReal frompos, SUMOReal topos)
 Builds a bus stop.
MSCalibratorbuildCalibrator (MSNet &net, const std::string &id, MSEdge *edge, SUMOReal pos, const std::string &file, const std::string &outfile, const SUMOTime freq)
 builds a microscopic calibrator
virtual MSTriggeredRerouterbuildRerouter (MSNet &net, const std::string &id, std::vector< MSEdge * > &edges, SUMOReal prob, const std::string &file, bool off)
 builds an rerouter
helper method for obtaining and checking values
std::string getFileName (const SUMOSAXAttributes &attrs, const std::string &base, const bool allowEmpty=false)
 Helper method to obtain the filename.
MSLanegetLane (const SUMOSAXAttributes &attrs, const std::string &tt, const std::string &tid)
 Returns the lane defined by attribute "lane".
SUMOReal getPosition (const SUMOSAXAttributes &attrs, MSLane *lane, const std::string &tt, const std::string &tid)
 returns the position on the lane checking it

Protected Attributes

NLHandlermyHandler
 The parent handler to set for subhandlers.

Detailed Description

Builds trigger objects for microsim.

The building methods may be overridden, to build guisim-instances of the triggers, for example.

Definition at line 69 of file NLTriggerBuilder.h.

Constructor & Destructor Documentation

NLTriggerBuilder::NLTriggerBuilder ( )

Constructor.

Definition at line 66 of file NLTriggerBuilder.cpp.

NLTriggerBuilder::~NLTriggerBuilder ( )
virtual

Destructor.

Definition at line 70 of file NLTriggerBuilder.cpp.

Member Function Documentation

void NLTriggerBuilder::buildBusStop ( MSNet net,
const std::string &  id,
const std::vector< std::string > &  lines,
MSLane lane,
SUMOReal  frompos,
SUMOReal  topos 
)
protectedvirtual

Builds a bus stop.

Simply calls the MSBusStop constructor.

Parameters
[in]netThe net the bus stop belongs to
[in]idThe id of the bus stop
[in]linesNames of the bus lines that halt on this bus stop
[in]laneThe lane the bus stop is placed on
[in]fromposBegin position of the bus stop on the lane
[in]toposEnd position of the bus stop on the lane
Exceptions
InvalidArgumentIf the bus stop can not be added to the net (is duplicate)

Reimplemented in GUITriggerBuilder.

Definition at line 292 of file NLTriggerBuilder.cpp.

References MSNet::addBusStop().

Referenced by parseAndBuildBusStop().

MSCalibrator * NLTriggerBuilder::buildCalibrator ( MSNet net,
const std::string &  id,
MSEdge edge,
SUMOReal  pos,
const std::string &  file,
const std::string &  outfile,
const SUMOTime  freq 
)
protected

builds a microscopic calibrator

Simply calls the MSCalibrator constructor.

Parameters
[in]netThe net the calibrator belongs to
[in]idThe id of the calibrator
[in]edgeThe edge the calibrator is placed at
[in]posThe position on the edge the calibrator lies at
[in]fileThe file to read the flows from
Todo:
Is the position correct/needed

Definition at line 274 of file NLTriggerBuilder.cpp.

Referenced by parseAndBuildCalibrator().

MSLaneSpeedTrigger * NLTriggerBuilder::buildLaneSpeedTrigger ( MSNet net,
const std::string &  id,
const std::vector< MSLane * > &  destLanes,
const std::string &  file 
)
protectedvirtual

Builds a lane speed trigger.

Simply calls the MSLaneSpeedTrigger constructor.

Parameters
[in]netThe net the lane speed trigger belongs to
[in]idThe id of the lane speed trigger
[in]destLanesList of lanes affected by this speed trigger
[in]fileName of the file to read the speeds to set from
See Also
MSLaneSpeedTrigger
Exceptions
ProcessErrorIf the XML definition file is errornous

Reimplemented in GUITriggerBuilder.

Definition at line 254 of file NLTriggerBuilder.cpp.

Referenced by parseAndBuildLaneSpeedTrigger().

MSTriggeredRerouter * NLTriggerBuilder::buildRerouter ( MSNet net,
const std::string &  id,
std::vector< MSEdge * > &  edges,
SUMOReal  prob,
const std::string &  file,
bool  off 
)
protectedvirtual

builds an rerouter

Simply calls the MSTriggeredRerouter constructor.

Parameters
[in]netThe net the rerouter belongs to
[in]idThe id of the rerouter
[in]edgesThe edges the rerouter is placed at
[in]probThe probability the rerouter reoutes vehicles with
[in]fileThe file to read the reroute definitions from

Reimplemented in GUITriggerBuilder.

Definition at line 284 of file NLTriggerBuilder.cpp.

Referenced by parseAndBuildRerouter().

void NLTriggerBuilder::buildVaporizer ( const SUMOSAXAttributes attrs)

Builds a vaporization.

Parses the attributes, reporting errors if the time values are false or the edge is not known. Instatiates events for enabling and disabling the vaporization otherwise.

Parameters
[in]attrsSAX-attributes which define the vaporizer
Note
recheck throwing the exception

Definition at line 79 of file NLTriggerBuilder.cpp.

References MSEventControl::ADAPT_AFTER_EXECUTION, MSEventControl::addEvent(), MSEdge::decVaporization(), MSEdge::dictionary(), SUMOSAXAttributes::get(), MSNet::getBeginOfTimestepEvents(), MSNet::getInstance(), OptionsCont::getOptions(), SUMOSAXAttributes::getSUMOTimeReporting(), MSEdge::incVaporization(), string2time(), SUMO_ATTR_BEGIN, SUMO_ATTR_END, SUMO_ATTR_ID, and WRITE_ERROR.

Referenced by NLHandler::myStartElement().

std::string NLTriggerBuilder::getFileName ( const SUMOSAXAttributes attrs,
const std::string &  base,
const bool  allowEmpty = false 
)
protected

Helper method to obtain the filename.

Retrieves "file" from attributes, checks whether it is absolute and extends it by the given base path if not. Returns this information.

Parameters
[in]attrsThe attributes to obtain the file name from
[in]baseThe base path (the path the loaded additional file lies in)
Returns
The (expanded) path to the named file
Todo:
Recheck usage of the helper class

Definition at line 306 of file NLTriggerBuilder.cpp.

References FileHelpers::getConfigurationRelative(), SUMOSAXAttributes::getOpt(), FileHelpers::isAbsolute(), and SUMO_ATTR_FILE.

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

MSLane * NLTriggerBuilder::getLane ( const SUMOSAXAttributes attrs,
const std::string &  tt,
const std::string &  tid 
)
protected

Returns the lane defined by attribute "lane".

Retrieves the lane id from the given attrs. Tries to retrieve the lane, throws an InvalidArgument if it does not exist.

Parameters
[in]attrsThe attributes to obtain the lane id from
[in]ttThe trigger type (for user output)
[in]tidThe trigger id (for user output)
Returns
The named lane if it is known
Exceptions
InvalidArgumentIf the named lane does not exist or a lane is not named

Definition at line 327 of file NLTriggerBuilder.cpp.

References MSLane::dictionary(), SUMOSAXAttributes::get(), and SUMO_ATTR_LANE.

Referenced by parseAndBuildBusStop(), and parseAndBuildCalibrator().

SUMOReal NLTriggerBuilder::getPosition ( const SUMOSAXAttributes attrs,
MSLane lane,
const std::string &  tt,
const std::string &  tid 
)
protected

returns the position on the lane checking it

This method extracts the position, checks whether it shall be mirrored and checks whether it is within the lane. If not, an error is reported and a InvalidArgument is thrown.

Parameters
[in]attrsThe attributes to obtain the position from
[in]laneThe lane the position shall be valid for
[in]ttThe trigger type (for user output)
[in]tidThe trigger id (for user output)
Returns
The position on the lane
Exceptions
InvalidArgumentIf the position is beyond the lane

Definition at line 341 of file NLTriggerBuilder.cpp.

References SUMOSAXAttributes::get(), Named::getID(), MSLane::getLength(), SUMOSAXAttributes::getOpt(), SUMO_ATTR_FRIENDLY_POS, SUMO_ATTR_POSITION, and SUMOReal.

Referenced by parseAndBuildCalibrator().

void NLTriggerBuilder::parseAndBuildBusStop ( MSNet net,
const SUMOSAXAttributes attrs 
)

Parses his values and builds a bus stop.

Parameters
[in]netThe network the bus stop belongs to
[in]attrsSAX-attributes which define the trigger
Exceptions
InvalidArgumentIf a parameter (lane/position) is not valid

Definition at line 155 of file NLTriggerBuilder.cpp.

References buildBusStop(), SUMORouteHandler::checkStopPos(), SUMOSAXAttributes::get(), getLane(), MSLane::getLength(), SUMOSAXAttributes::getOpt(), myHandler, SUMOSAXAttributes::parseStringVector(), POSITION_EPS, SUMO_ATTR_ENDPOS, SUMO_ATTR_FRIENDLY_POS, SUMO_ATTR_ID, SUMO_ATTR_LINES, SUMO_ATTR_STARTPOS, and SUMOReal.

Referenced by NLHandler::myStartElement().

void NLTriggerBuilder::parseAndBuildCalibrator ( MSNet net,
const SUMOSAXAttributes attrs,
const std::string &  base 
)

Parses his values and builds a mesoscopic or microscopic calibrator.

Parameters
[in]netThe network the calibrator belongs to
[in]attrsSAX-attributes which define the trigger
[in]baseThe base path
Exceptions
InvalidArgumentIf a parameter (edge/position) is not valid

Definition at line 180 of file NLTriggerBuilder.cpp.

References buildCalibrator(), DELTA_T, SUMOSAXAttributes::get(), MSLane::getEdge(), getFileName(), getLane(), SUMOSAXAttributes::getOpt(), SUMOSAXAttributes::getOptSUMOTimeReporting(), getPosition(), MSGlobals::gUseMesoSim, myHandler, GenericSAXHandler::registerParent(), SUMO_ATTR_FREQUENCY, SUMO_ATTR_ID, SUMO_ATTR_OUTPUT, SUMO_TAG_CALIBRATOR, and SUMOReal.

Referenced by NLHandler::myStartElement().

void NLTriggerBuilder::parseAndBuildLaneSpeedTrigger ( MSNet net,
const SUMOSAXAttributes attrs,
const std::string &  base 
)

Parses his values and builds a lane speed trigger.

If one of the declaration values is errornous, an InvalidArgument is thrown.

If the XML-file parsed during initialisation is errornous, and the MSLaneSpeedTrigger-constructor throws a ProcessError due to this, this exception is catched and an InvalidArgument with the message given in the ProcessError is thrown.

Parameters
[in]netThe network the lane speed trigger belongs to
[in]attrsSAX-attributes which define the trigger
[in]baseThe base path
Exceptions
InvalidArgumentIf a parameter (lane/position) is not valid or the read definition is errornous
See Also
buildLaneSpeedTrigger

Definition at line 115 of file NLTriggerBuilder.cpp.

References buildLaneSpeedTrigger(), MSLane::dictionary(), SUMOSAXAttributes::get(), getFileName(), myHandler, SUMOSAXAttributes::parseStringVector(), GenericSAXHandler::registerParent(), SUMO_ATTR_ID, SUMO_ATTR_LANES, and SUMO_TAG_VSS.

Referenced by NLHandler::myStartElement().

void NLTriggerBuilder::parseAndBuildRerouter ( MSNet net,
const SUMOSAXAttributes attrs,
const std::string &  base 
)

Parses his values and builds a rerouter.

Parameters
[in]netThe network the rerouter belongs to
[in]attrsSAX-attributes which define the trigger
[in]baseThe base path
Exceptions
InvalidArgumentIf a parameter (edge) is not valid

Definition at line 211 of file NLTriggerBuilder.cpp.

References buildRerouter(), MSEdge::dictionary(), SUMOSAXAttributes::get(), getFileName(), SUMOSAXAttributes::getOpt(), myHandler, SUMOSAXAttributes::parseStringVector(), GenericSAXHandler::registerParent(), SUMO_ATTR_EDGES, SUMO_ATTR_ID, SUMO_ATTR_OFF, SUMO_ATTR_PROB, SUMO_TAG_REROUTER, and SUMOReal.

Referenced by NLHandler::myStartElement().

void NLTriggerBuilder::setHandler ( NLHandler handler)

Sets the parent handler to use for nested parsing.

Parameters
[in]handlerThe netload handler to set

Definition at line 73 of file NLTriggerBuilder.cpp.

References myHandler.

Referenced by load(), and GUILoadThread::run().

Field Documentation

NLHandler* NLTriggerBuilder::myHandler
protected

The parent handler to set for subhandlers.

Definition at line 303 of file NLTriggerBuilder.h.

Referenced by parseAndBuildBusStop(), parseAndBuildCalibrator(), parseAndBuildLaneSpeedTrigger(), parseAndBuildRerouter(), and setHandler().


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