Eclipse SUMO - Simulation of Urban MObility
SUMOVTypeParameter Class Reference

Structure representing possible vehicle parameter. More...

#include <SUMOVTypeParameter.h>

Inheritance diagram for SUMOVTypeParameter:
[legend]
Collaboration diagram for SUMOVTypeParameter:
[legend]

Data Structures

struct  VClassDefaultValues
 struct for default values that depend of VClass More...
 

Public Types

enum class  ParameterisedAttrType { STRING , DOUBLE }
 @brie enum for Parameterised type More...
 
typedef std::map< SumoXMLAttr, std::string > SubParams
 sub-model parameters More...
 

Public Member Functions

void cacheParamRestrictions (const std::vector< std::string > &restrictionKeys)
 
void clearParameter ()
 Clears the parameter map. More...
 
double getCFParam (const SumoXMLAttr attr, const double defaultValue) const
 Returns the named value from the map, or the default if it is not contained there. More...
 
std::string getCFParamString (const SumoXMLAttr attr, const std::string defaultValue) const
 Returns the named value from the map, or the default if it is not contained there. More...
 
double getDouble (const std::string &key, const double defaultValue) const
 Returns the value for a given key converted to a double. More...
 
SUMOTime getEntryManoeuvreTime (const int angle) const
 Returns the time that will be needed for the vehicle type to execute the (entry) manoeuvre (and be blocking the lane) More...
 
SUMOTime getExitManoeuvreTime (const int angle) const
 Returns the time that will be needed for the vehicle type to execute the (exit) manoeuvre (and be blocking the lane) More...
 
double getJMParam (const SumoXMLAttr attr, const double defaultValue) const
 Returns the named value from the map, or the default if it is not contained there. More...
 
std::string getJMParamString (const SumoXMLAttr attr, const std::string defaultValue) const
 Returns the named value from the map, or the default if it is not contained there. More...
 
double getLCParam (const SumoXMLAttr attr, const double defaultValue) const
 Returns the named value from the map, or the default if it is not contained there. More...
 
const SubParamsgetLCParams () const
 Returns the LC parameter. More...
 
std::string getLCParamString (const SumoXMLAttr attr, const std::string &defaultValue) const
 Returns the named value from the map, or the default if it is not contained there. More...
 
double getLength () const
 satisfy vType / router template requirements More...
 
std::string getManoeuverAngleTimesS () const
 Returns myManoeuverAngleTimes as a string for xml output. More...
 
const std::string getParameter (const std::string &key, const std::string defaultValue="") const
 Returns the value for a given key. More...
 
const std::map< std::string, std::string > & getParametersMap () const
 Returns the inner key/value map. More...
 
std::string getParametersStr (const std::string kvsep="=", const std::string sep="|") const
 Returns the inner key/value map in string format "key1=value1|key2=value2|...|keyN=valueN". More...
 
bool knowsParameter (const std::string &key) const
 Returns whether the parameter is known. More...
 
void setManoeuverAngleTimes (const SUMOVehicleClass vclass)
 Initialise the default mapping between manoeuver angle and times dependant on vehicle class. More...
 
virtual void setParameter (const std::string &key, const std::string &value)
 Sets a parameter. More...
 
void setParameters (const Parameterised &params)
 set the inner key/value map in map<string, string> format More...
 
void setParametersMap (const std::map< std::string, std::string > &paramsMap)
 set the inner key/value map in map<string, string> format More...
 
void setParametersStr (const std::string &paramsString, const std::string kvsep="=", const std::string sep="|")
 set the inner key/value map in string format "key1=value1|key2=value2|...|keyN=valueN" More...
 
 SUMOVTypeParameter (const std::string &vtid, const SUMOVehicleClass vc=SVC_IGNORING)
 Constructor. More...
 
void unsetParameter (const std::string &key)
 Removes a parameter. More...
 
void updateParameters (const std::map< std::string, std::string > &mapArg)
 Adds or updates all given parameters from the map. More...
 
bool wasSet (int what) const
 Returns whether the given parameter was set. More...
 
void write (OutputDevice &dev) const
 Writes the vtype. More...
 
void writeParams (OutputDevice &device) const
 write Params in the given outputdevice More...
 
virtual ~SUMOVTypeParameter ()
 virtual destructor More...
 

Static Public Member Functions

static bool areParametersValid (const std::string &value, bool report=false, ParameterisedAttrType attrType=ParameterisedAttrType::STRING, const std::string kvsep="=", const std::string sep="|")
 check if given string can be parsed to a parameters map "key1=value1|key2=value2|...|keyN=valueN" More...
 
static const SUMOVTypeParametergetDefault ()
 return the default parameters, this is a function due to the http://www.parashift.com/c++-faq/static-init-order.html More...
 
static double getDefaultAccel (const SUMOVehicleClass vc=SVC_IGNORING)
 Returns the default acceleration for the given vehicle class This needs to be a function because the actual value is stored in the car following model. More...
 
static double getDefaultDecel (const SUMOVehicleClass vc=SVC_IGNORING)
 Returns the default deceleration for the given vehicle class This needs to be a function because the actual value is stored in the car following model. More...
 
static double getDefaultEmergencyDecel (const SUMOVehicleClass vc, double decel, double defaultOption)
 Returns the default emergency deceleration for the given vehicle class This needs to be a function because the actual value is stored in the car following model. More...
 
static double getDefaultImperfection (const SUMOVehicleClass vc=SVC_IGNORING)
 Returns the default driver's imperfection (sigma or epsilon in Krauss' model) for the given vehicle class This needs to be a function because the actual value is stored in the car following model. More...
 

Data Fields

SUMOTime actionStepLength
 The vehicle type's default actionStepLength [ms], i.e. the interval between two control actions. The default value of 0ms. induces the value to be traced from MSGlobals::gActionStepLength. More...
 
SUMOTime boardingDuration
 The time a person needs to board the vehicle. More...
 
double carriageGap
 
double carriageLength
 the length of train carriages and locomotive More...
 
SumoXMLTag cfModel
 The enum-representation of the car-following model to use. More...
 
SubParams cfParameter
 Car-following parameter. More...
 
RGBColor color
 The color. More...
 
int containerCapacity
 The container capacity of the vehicle. More...
 
double defaultProbability
 The probability when being added to a distribution without an explicit probability. More...
 
SUMOEmissionClass emissionClass
 The emission class of this vehicle. More...
 
std::string id
 The vehicle type's id. More...
 
double impatience
 The vehicle's impatience (willingness to obstruct others) More...
 
SubParams jmParameter
 Junction-model parameter. More...
 
LateralAlignment latAlignment
 The vehicles desired lateral alignment. More...
 
LaneChangeModel lcModel
 The lane-change model to use. More...
 
SubParams lcParameter
 Lane-changing parameter. More...
 
double length
 The physical vehicle length. More...
 
SUMOTime loadingDuration
 The time a container needs to get loaded on the vehicle. More...
 
double locomotiveLength
 
double maxSpeed
 The vehicle type's maximum speed [m/s]. More...
 
double maxSpeedLat
 The vehicle type's maximum lateral speed [m/s]. More...
 
double minGap
 This class' free space in front of the vehicle itself. More...
 
double minGapLat
 The vehicle type's minimum lateral gap [m]. More...
 
std::map< int, std::pair< SUMOTime, SUMOTime > > myManoeuverAngleTimes
 Map of manoeuver angles versus the times (entry, exit) to execute the manoeuver. More...
 
bool onlyReferenced
 Information whether this is a type-stub, being only referenced but not defined (needed by routers) More...
 
int parametersSet
 Information for the router which parameter were set. More...
 
std::vector< double > paramRestrictions
 cached value of parameters which may restrict access to certain edges More...
 
int personCapacity
 The person capacity of the vehicle. More...
 
bool saved
 Information whether this type was already saved (needed by routers) More...
 
Distribution_Parameterized speedFactor
 The factor by which the maximum speed may deviate from the allowed max speed on the street. More...
 
SUMOVehicleClass vehicleClass
 The vehicle's class. More...
 
Values for drawing this class' vehicles
double width
 This class' width. More...
 
double height
 This class' height. More...
 
SUMOVehicleShape shape
 This class' shape. More...
 
std::string osgFile
 3D model file for this class More...
 
std::string imgFile
 Image file for this class. More...
 

Static Private Member Functions

static bool isParameterValid (const std::string &value, ParameterisedAttrType attrType, const std::string &kvsep, const std::string &sep)
 check if given string can be parsed to a parameter of type "key=value" More...
 

Private Attributes

ParameterisedAttrType myAttrType
 parameterised type More...
 
std::map< std::string, std::string > myMap
 The key->value map. More...
 

Detailed Description

Structure representing possible vehicle parameter.

Definition at line 84 of file SUMOVTypeParameter.h.

Member Typedef Documentation

◆ SubParams

typedef std::map<SumoXMLAttr, std::string> SUMOVTypeParameter::SubParams

sub-model parameters

Definition at line 188 of file SUMOVTypeParameter.h.

Member Enumeration Documentation

◆ ParameterisedAttrType

@brie enum for Parameterised type

Enumerator
STRING 

Parameterised accept strings.

DOUBLE 

Parameterised only accept doubles.

Definition at line 43 of file Parameterised.h.

Constructor & Destructor Documentation

◆ SUMOVTypeParameter()

◆ ~SUMOVTypeParameter()

virtual SUMOVTypeParameter::~SUMOVTypeParameter ( )
inlinevirtual

virtual destructor

Definition at line 142 of file SUMOVTypeParameter.h.

Member Function Documentation

◆ areParametersValid()

bool Parameterised::areParametersValid ( const std::string &  value,
bool  report = false,
ParameterisedAttrType  attrType = ParameterisedAttrType::STRING,
const std::string  kvsep = "=",
const std::string  sep = "|" 
)
staticinherited

check if given string can be parsed to a parameters map "key1=value1|key2=value2|...|keyN=valueN"

Definition at line 217 of file Parameterised.cpp.

References StringTokenizer::getVector(), Parameterised::isParameterValid(), and WRITE_WARNING.

Referenced by GNEAccess::isValid(), GNEBusStop::isValid(), GNECalibrator::isValid(), GNECalibratorFlow::isValid(), GNEChargingStation::isValid(), GNEClosingLaneReroute::isValid(), GNEClosingReroute::isValid(), GNEContainerStop::isValid(), GNEDestProbReroute::isValid(), GNEDetectorE1::isValid(), GNEDetectorE1Instant::isValid(), GNEDetectorE2::isValid(), GNEDetectorE3::isValid(), GNEDetectorEntryExit::isValid(), GNEParkingArea::isValid(), GNEParkingAreaReroute::isValid(), GNEParkingSpace::isValid(), GNEPOI::isValid(), GNEPoly::isValid(), GNERerouter::isValid(), GNERerouterInterval::isValid(), GNERouteProbe::isValid(), GNERouteProbReroute::isValid(), GNETAZ::isValid(), GNETAZSourceSink::isValid(), GNEVaporizer::isValid(), GNEVariableSpeedSign::isValid(), GNEVariableSpeedSignStep::isValid(), GNEEdgeData::isValid(), GNEEdgeRelData::isValid(), GNETAZRelData::isValid(), GNEPerson::isValid(), GNEPersonTrip::isValid(), GNERide::isValid(), GNERoute::isValid(), GNEVehicle::isValid(), GNEVehicleType::isValid(), GNEWalk::isValid(), GNEConnection::isValid(), GNECrossing::isValid(), GNEEdge::isValid(), GNEEdgeType::isValid(), GNEJunction::isValid(), GNELane::isValid(), GNELaneType::isValid(), GNEInspectorFrame::ParametersEditorInspector::onCmdSetParameters(), and GNEFrameAttributesModuls::ParametersEditorCreator::onCmdSetParameters().

Here is the caller graph for this function:

◆ cacheParamRestrictions()

void SUMOVTypeParameter::cacheParamRestrictions ( const std::vector< std::string > &  restrictionKeys)

Definition at line 554 of file SUMOVTypeParameter.cpp.

References Parameterised::getParameter(), paramRestrictions, and StringUtils::toDouble().

Referenced by RORouteHandler::closeVType().

Here is the caller graph for this function:

◆ clearParameter()

void Parameterised::clearParameter ( )
inherited

Clears the parameter map.

Definition at line 140 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by NLHandler::beginEdgeParsing(), and GNERouteHandler::closeRoute().

Here is the caller graph for this function:

◆ getCFParam()

double SUMOVTypeParameter::getCFParam ( const SumoXMLAttr  attr,
const double  defaultValue 
) const

Returns the named value from the map, or the default if it is not contained there.

Parameters
[in]attrThe corresponding xml attribute
[in]defaultValueThe value to return if the given map does not contain the named variable
Returns
The named value from the map or the default if it does not exist there

Definition at line 446 of file SUMOVTypeParameter.cpp.

References cfParameter, and StringUtils::toDouble().

Referenced by MSVehicleType::build(), ROEdge::getEmissionEffort(), MSCFModel_ACC::MSCFModel_ACC(), MSCFModel_CACC::MSCFModel_CACC(), MSCFModel_IDM::MSCFModel_IDM(), MSCFModel_Kerner::MSCFModel_Kerner(), MSCFModel_PWag2009::MSCFModel_PWag2009(), MSCFModel_Rail::MSCFModel_Rail(), MSCFModel_W99::MSCFModel_W99(), MSCFModel_Wiedemann::MSCFModel_Wiedemann(), and GNEVehicleType::overwriteVType().

Here is the caller graph for this function:

◆ getCFParamString()

std::string SUMOVTypeParameter::getCFParamString ( const SumoXMLAttr  attr,
const std::string  defaultValue 
) const

Returns the named value from the map, or the default if it is not contained there.

Parameters
[in]attrThe corresponding xml attribute
[in]defaultValueThe value to return if the given map does not contain the named variable
Returns
The named value from the map or the default if it does not exist there

Definition at line 456 of file SUMOVTypeParameter.cpp.

References cfParameter.

Referenced by GNEVehicleType::getAttribute(), MSCFModel_Rail::MSCFModel_Rail(), and GNEVehicleType::overwriteVType().

Here is the caller graph for this function:

◆ getDefault()

const SUMOVTypeParameter & SUMOVTypeParameter::getDefault ( )
static

return the default parameters, this is a function due to the http://www.parashift.com/c++-faq/static-init-order.html

Definition at line 689 of file SUMOVTypeParameter.cpp.

Referenced by LIBSUMO_NAMESPACE::Lane::getLinks().

Here is the caller graph for this function:

◆ getDefaultAccel()

double SUMOVTypeParameter::getDefaultAccel ( const SUMOVehicleClass  vc = SVC_IGNORING)
static

Returns the default acceleration for the given vehicle class This needs to be a function because the actual value is stored in the car following model.

Parameters
[in]vcthe vehicle class
Returns
the acceleration in m/s^2

Definition at line 562 of file SUMOVTypeParameter.cpp.

References SVC_BICYCLE, SVC_BUS, SVC_COACH, SVC_MOPED, SVC_MOTORCYCLE, SVC_PEDESTRIAN, SVC_RAIL, SVC_RAIL_ELECTRIC, SVC_RAIL_FAST, SVC_RAIL_URBAN, SVC_SHIP, SVC_TRAILER, SVC_TRAM, and SVC_TRUCK.

Referenced by ROEdge::getEmissionEffort().

Here is the caller graph for this function:

◆ getDefaultDecel()

double SUMOVTypeParameter::getDefaultDecel ( const SUMOVehicleClass  vc = SVC_IGNORING)
static

Returns the default deceleration for the given vehicle class This needs to be a function because the actual value is stored in the car following model.

Parameters
[in]vcthe vehicle class
Returns
the deceleration in m/s^2

Definition at line 598 of file SUMOVTypeParameter.cpp.

References SVC_BICYCLE, SVC_BUS, SVC_COACH, SVC_MOPED, SVC_MOTORCYCLE, SVC_PEDESTRIAN, SVC_RAIL, SVC_RAIL_ELECTRIC, SVC_RAIL_FAST, SVC_RAIL_URBAN, SVC_SHIP, SVC_TRAILER, SVC_TRAM, and SVC_TRUCK.

Referenced by MSVehicleType::build(), and LIBSUMO_NAMESPACE::Lane::getLinks().

Here is the caller graph for this function:

◆ getDefaultEmergencyDecel()

double SUMOVTypeParameter::getDefaultEmergencyDecel ( const SUMOVehicleClass  vc,
double  decel,
double  defaultOption 
)
static

Returns the default emergency deceleration for the given vehicle class This needs to be a function because the actual value is stored in the car following model.

Parameters
[in]vcthe vehicle class
[in]decelthe deceleration of the vehicle type
Returns
the emergency deceleration in m/s^2

Definition at line 629 of file SUMOVTypeParameter.cpp.

References MAX2(), SVC_BICYCLE, SVC_BUS, SVC_COACH, SVC_MOPED, SVC_MOTORCYCLE, SVC_PEDESTRIAN, SVC_RAIL, SVC_RAIL_ELECTRIC, SVC_RAIL_FAST, SVC_RAIL_URBAN, SVC_SHIP, SVC_TRAILER, SVC_TRAM, SVC_TRUCK, VTYPEPARS_DEFAULT_EMERGENCYDECEL_DECEL, and VTYPEPARS_DEFAULT_EMERGENCYDECEL_DEFAULT.

Referenced by MSVehicleType::build().

Here is the caller graph for this function:

◆ getDefaultImperfection()

double SUMOVTypeParameter::getDefaultImperfection ( const SUMOVehicleClass  vc = SVC_IGNORING)
static

Returns the default driver's imperfection (sigma or epsilon in Krauss' model) for the given vehicle class This needs to be a function because the actual value is stored in the car following model.

Parameters
[in]vcthe vehicle class
Returns
the imperfection as a value between 0 and 1

Definition at line 674 of file SUMOVTypeParameter.cpp.

References SVC_RAIL, SVC_RAIL_ELECTRIC, SVC_RAIL_FAST, SVC_RAIL_URBAN, SVC_SHIP, and SVC_TRAM.

Referenced by ROEdge::getEmissionEffort().

Here is the caller graph for this function:

◆ getDouble()

double Parameterised::getDouble ( const std::string &  key,
const double  defaultValue 
) const
inherited

◆ getEntryManoeuvreTime()

SUMOTime SUMOVTypeParameter::getEntryManoeuvreTime ( const int  angle) const

Returns the time that will be needed for the vehicle type to execute the (entry) manoeuvre (and be blocking the lane)

Parameters
[in]angleThe angle, in degrees through which the vehicle needs to manoeuver (0-180 degrees)
Returns
The SUMOTime value

Definition at line 511 of file SUMOVTypeParameter.cpp.

References myManoeuverAngleTimes.

◆ getExitManoeuvreTime()

SUMOTime SUMOVTypeParameter::getExitManoeuvreTime ( const int  angle) const

Returns the time that will be needed for the vehicle type to execute the (exit) manoeuvre (and be blocking the lane)

Parameters
[in]angleThe angle, in degrees through which the vehicle needs to manoeuver (0-180 degrees)
Returns
The SUMOTime value

Definition at line 524 of file SUMOVTypeParameter.cpp.

References myManoeuverAngleTimes.

◆ getJMParam()

double SUMOVTypeParameter::getJMParam ( const SumoXMLAttr  attr,
const double  defaultValue 
) const

Returns the named value from the map, or the default if it is not contained there.

Parameters
[in]attrThe corresponding xml attribute
[in]defaultValueThe value to return if the given map does not contain the named variable
Returns
The named value from the map or the default if it does not exist there

Definition at line 492 of file SUMOVTypeParameter.cpp.

References jmParameter, and StringUtils::toDouble().

Referenced by MSLink::blockedAtTime(), MSLink::blockedByFoe(), MSLink::getLeaderInfo(), MSVehicle::ignoreRed(), MSVehicle::keepClear(), and MSCFModel_Krauss::patchSpeedBeforeLC().

Here is the caller graph for this function:

◆ getJMParamString()

std::string SUMOVTypeParameter::getJMParamString ( const SumoXMLAttr  attr,
const std::string  defaultValue 
) const

Returns the named value from the map, or the default if it is not contained there.

Parameters
[in]attrThe corresponding xml attribute
[in]defaultValueThe value to return if the given map does not contain the named variable
Returns
The named value from the map or the default if it does not exist there

Definition at line 502 of file SUMOVTypeParameter.cpp.

References jmParameter.

Referenced by GNEVehicleType::getAttribute(), and GNEVehicleType::overwriteVType().

Here is the caller graph for this function:

◆ getLCParam()

double SUMOVTypeParameter::getLCParam ( const SumoXMLAttr  attr,
const double  defaultValue 
) const

Returns the named value from the map, or the default if it is not contained there.

Parameters
[in]attrThe corresponding xml attribute
[in]defaultValueThe value to return if the given map does not contain the named variable
Returns
The named value from the map or the default if it does not exist there

Definition at line 466 of file SUMOVTypeParameter.cpp.

References lcParameter, and StringUtils::toDouble().

◆ getLCParams()

const SUMOVTypeParameter::SubParams & SUMOVTypeParameter::getLCParams ( ) const

Returns the LC parameter.

Definition at line 486 of file SUMOVTypeParameter.cpp.

References lcParameter.

Referenced by MSAbstractLaneChangeModel::estimateLCDuration(), and MSAbstractLaneChangeModel::remainingTime().

Here is the caller graph for this function:

◆ getLCParamString()

std::string SUMOVTypeParameter::getLCParamString ( const SumoXMLAttr  attr,
const std::string &  defaultValue 
) const

Returns the named value from the map, or the default if it is not contained there.

Parameters
[in]attrThe corresponding xml attribute
[in]defaultValueThe value to return if the given map does not contain the named variable
Returns
The named value from the map or the default if it does not exist there

Definition at line 476 of file SUMOVTypeParameter.cpp.

References lcParameter.

Referenced by GNEVehicleType::getAttribute(), and MSDevice_Bluelight::notifyMove().

Here is the caller graph for this function:

◆ getLength()

double SUMOVTypeParameter::getLength ( ) const
inline

satisfy vType / router template requirements

Definition at line 317 of file SUMOVTypeParameter.h.

References length.

◆ getManoeuverAngleTimesS()

std::string SUMOVTypeParameter::getManoeuverAngleTimesS ( ) const

Returns myManoeuverAngleTimes as a string for xml output.

Returns
A string of , separated triplets (angle entry-time exit-time)

Definition at line 537 of file SUMOVTypeParameter.cpp.

References myManoeuverAngleTimes, STEPS2TIME, and toString().

Referenced by GUIVehicle::getTypeParameterWindow(), and write().

Here is the caller graph for this function:

◆ getParameter()

const std::string Parameterised::getParameter ( const std::string &  key,
const std::string  defaultValue = "" 
) const
inherited

Returns the value for a given key.

Parameters
[in]keyThe key to ask for
[in]defaultValueThe default value to return if no value is stored under the key
Returns
The value stored under the key

Definition at line 112 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by NBEdge::addRestrictedLane(), FareModul::addStop(), NBEdge::append(), MSDevice_Battery::buildVehicleDevices(), MSDevice_ElecHybrid::buildVehicleDevices(), MSDevice_Example::buildVehicleDevices(), ROEdge::cacheParamRestrictions(), cacheParamRestrictions(), MSRailSignal::constraintsAllow(), GNEEdge::drawEdgeName(), GNEGenericData::drawFilteredAttribute(), GUIEdge::drawGL(), GNEConnection::drawGL(), LIBSUMO_NAMESPACE::Simulation::findIntermodalRoute(), MSSwarmTrafficLightLogic::getBetaNo(), MSSwarmTrafficLightLogic::getBetaSp(), NBRailwayTopologyAnalyzer::getBrokenRailNodes(), MSSwarmTrafficLightLogic::getChangePlanProbability(), GNEEdgeData::getColor(), GNEEdgeRelData::getColor(), GUILane::getColorValue(), GUIVehicle::getColorValue(), GNELane::getColorValue(), MSSOTLTrafficLightLogic::getDecayConstant(), MSDevice_SSM::getDetectionRange(), MSDevice_SSM::getExtraTime(), MSSwarmTrafficLightLogic::getForgettingCox(), MSSwarmTrafficLightLogic::getGammaNo(), MSSwarmTrafficLightLogic::getGammaSp(), MSTLLogicControl::WAUTSwitchProcedure::getGSPTime(), MSSOTLTrafficLightLogic::getInputSensorsLength(), MSSwarmTrafficLightLogic::getLearningCox(), MSSwarmTrafficLightLogic::getMaxCongestionDuration(), MSDevice_SSM::getMeasuresAndThresholds(), MSSOTLRequestPolicy::getMinDecisionalPhaseDuration(), MSSOTLTrafficLightLogic::getMode(), GUIBaseVehicle::getOptionalName(), GUITrafficLightLogicWrapper::getOptionalName(), MSDevice_ToC::getOutputFilename(), MSDevice_SSM::getOutputFilename(), MSSOTLTrafficLightLogic::getOutputSensorsLength(), LIBSUMO_NAMESPACE::Simulation::getParameter(), MSSwarmTrafficLightLogic::getPheroMaxVal(), MSSwarmTrafficLightLogic::getPoliciesParam(), MSBaseVehicle::getPrefixedParameter(), MSSwarmTrafficLightLogic::getReinforcementMode(), MSSOTLTrafficLightLogic::getSpeedThreshold(), MSDevice::getStringParam(), MSSwarmTrafficLightLogic::getThetaInit(), MSSwarmTrafficLightLogic::getThetaMax(), MSSwarmTrafficLightLogic::getThetaMin(), MSSOTLTrafficLightLogic::getThreshold(), MSRailSignalConstraint::getVehID(), MSTriggeredRerouter::getWeight(), MSRailSignal::hasInsertionConstraint(), MSSOTLPhasePolicy::init(), MSActuatedTrafficLightLogic::init(), MSDelayBasedTrafficLightLogic::init(), MSSOTLTrafficLightLogic::init(), MSSwarmTrafficLightLogic::init(), PushButtonLogic::init(), SigmoidLogic::init(), MSVehicleType::initRailVisualizationParameters(), GNEVehicleType::initRailVisualizationParameters(), MSSOTLTrafficLightLogic::isDecayThresholdActivated(), MSSOTLTrafficLightLogic::isPushButtonPressed(), MSActuatedTrafficLightLogic::MSActuatedTrafficLightLogic(), MSDelayBasedTrafficLightLogic::MSDelayBasedTrafficLightLogic(), MSSOTLPolicy::MSSOTLPolicy(), MSSOTLPolicy5DFamilyStimulus::MSSOTLPolicy5DFamilyStimulus(), MSSwarmTrafficLightLogic::MSSwarmTrafficLightLogic(), MSRailSignalConstraint_Predecessor::PassedTracker::notifyEnter(), GNEVehicleType::overwriteVType(), MSDevice_SSM::requestsTrajectories(), NBTrafficLightLogicCont::setOpenDriveSignalParameters(), NBEdgeCont::splitAt(), MSDevice_SSM::useGeoCoords(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::WAUTSwitchProcedure_Stretch(), NWWriter_DlrNavteq::writeLinksUnsplitted(), and NWWriter_OpenDrive::writeRoadObjects().

◆ getParametersMap()

const std::map< std::string, std::string > & Parameterised::getParametersMap ( ) const
inherited

Returns the inner key/value map.

Definition at line 146 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by NIImporter_SUMO::_loadNetwork(), NBEdge::addLane(), GUIParameterTableWindow::closeBuilding(), NLHandler::closeEdge(), NBTrafficLightDefinition::compute(), GNEGenericData::drawAttribute(), GNEGenericData::drawFilteredAttribute(), GNEAdditional::getACParametersMap(), GNEPOI::getACParametersMap(), GNEPoly::getACParametersMap(), GNETAZElement::getACParametersMap(), GNEDataInterval::getACParametersMap(), GNEDataSet::getACParametersMap(), GNEGenericData::getACParametersMap(), GNEPerson::getACParametersMap(), GNEPersonStop::getACParametersMap(), GNEPersonTrip::getACParametersMap(), GNERide::getACParametersMap(), GNERoute::getACParametersMap(), GNEStop::getACParametersMap(), GNEVehicle::getACParametersMap(), GNEVehicleType::getACParametersMap(), GNEWalk::getACParametersMap(), GNEConnection::getACParametersMap(), GNECrossing::getACParametersMap(), GNEEdge::getACParametersMap(), GNEEdgeType::getACParametersMap(), GNEJunction::getACParametersMap(), GNELane::getACParametersMap(), GNELaneType::getACParametersMap(), GUILane::getParameterWindow(), MSActuatedTrafficLightLogic::init(), MSDevice_Taxi::initDispatch(), NIImporter_OpenStreetMap::insertEdge(), GNEEdgeData::isGenericDataVisible(), GNEEdgeRelData::isGenericDataVisible(), GNETAZRelData::isGenericDataVisible(), GNEGenericData::isVisibleInspectDeleteSelect(), NBEdge::NBEdge(), NBLoadedSUMOTLDef::NBLoadedSUMOTLDef(), GUIParameterTableWindow::numParams(), GNEVehicleType::overwriteVType(), TraCIServerAPI_TrafficLight::processGet(), Parameterised::setParameters(), GNEEdgeData::writeGenericData(), GNEEdgeRelData::writeGenericData(), and GNETAZRelData::writeGenericData().

Here is the caller graph for this function:

◆ getParametersStr()

std::string Parameterised::getParametersStr ( const std::string  kvsep = "=",
const std::string  sep = "|" 
) const
inherited

Returns the inner key/value map in string format "key1=value1|key2=value2|...|keyN=valueN".

Definition at line 152 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by GNEAccess::getAttribute(), GNEBusStop::getAttribute(), GNECalibrator::getAttribute(), GNECalibratorFlow::getAttribute(), GNEChargingStation::getAttribute(), GNEClosingLaneReroute::getAttribute(), GNEClosingReroute::getAttribute(), GNEContainerStop::getAttribute(), GNEDestProbReroute::getAttribute(), GNEDetectorE1::getAttribute(), GNEDetectorE1Instant::getAttribute(), GNEDetectorE2::getAttribute(), GNEDetectorE3::getAttribute(), GNEDetectorEntryExit::getAttribute(), GNEParkingArea::getAttribute(), GNEParkingAreaReroute::getAttribute(), GNEParkingSpace::getAttribute(), GNEPOI::getAttribute(), GNEPoly::getAttribute(), GNERerouter::getAttribute(), GNERerouterInterval::getAttribute(), GNERouteProbe::getAttribute(), GNERouteProbReroute::getAttribute(), GNETAZ::getAttribute(), GNETAZSourceSink::getAttribute(), GNEVaporizer::getAttribute(), GNEVariableSpeedSign::getAttribute(), GNEVariableSpeedSignStep::getAttribute(), GNEEdgeData::getAttribute(), GNEEdgeRelData::getAttribute(), GNETAZRelData::getAttribute(), GNEPerson::getAttribute(), GNEPersonTrip::getAttribute(), GNERide::getAttribute(), GNERoute::getAttribute(), GNEVehicle::getAttribute(), GNEVehicleType::getAttribute(), GNEWalk::getAttribute(), GNEConnection::getAttribute(), GNEEdge::getAttribute(), GNEEdgeType::getAttribute(), GNEJunction::getAttribute(), GNELane::getAttribute(), and GNELaneType::getAttribute().

Here is the caller graph for this function:

◆ isParameterValid()

bool Parameterised::isParameterValid ( const std::string &  value,
ParameterisedAttrType  attrType,
const std::string &  kvsep,
const std::string &  sep 
)
staticprivateinherited

check if given string can be parsed to a parameter of type "key=value"

Definition at line 240 of file Parameterised.cpp.

References Parameterised::DOUBLE, StringTokenizer::getVector(), SUMOXMLDefinitions::isValidParameterKey(), and StringUtils::toDouble().

Referenced by Parameterised::areParametersValid().

Here is the caller graph for this function:

◆ knowsParameter()

◆ setManoeuverAngleTimes()

void SUMOVTypeParameter::setManoeuverAngleTimes ( const SUMOVehicleClass  vclass)

Initialise the default mapping between manoeuver angle and times dependant on vehicle class.

Parameters
[in]vclassThe vehicle class
Note
These default values were 'informed' by a paper by Purnawan, and Yousif:
usir.salford.ac.uk/id/eprint/9729/3/Paper_Kassel_%28Seminar%29.pdf (no reverse park values in paper)
truck values were simply doubled - all are modifiable in the vehicle type definition and there is no limit to the no of triplets TODO: optionality for 90 degree bay entry (forwards or reverse) not implemented - probably should be a driver propensity the defaults assume reverse entry - a reverse manoeuvre has to happen and there will be a small difference in timings depending whether its reverse in or out

Defaults assume: approaching at angles between 0-10 and 171-180 (will never be > 180) are approaching a space roughly parallel to the road approaching at angles between 11-80 are approaching an acute angled space that is easiest to drive straight in approaching at angles between 81-110 are approaching a space at approximately right angles to the road so the driver has a choice approaching at angles between 111 and 170 are approaching an obtuse angled space that is easiest to drive past and reverse in More (or less) granular angle ranges can be used - configurable as a vType parameter

Definition at line 288 of file SUMOVTypeParameter.cpp.

References myManoeuverAngleTimes, SVC_BICYCLE, SVC_BUS, SVC_COACH, SVC_DELIVERY, SVC_E_VEHICLE, SVC_HOV, SVC_MOPED, SVC_PASSENGER, SVC_PEDESTRIAN, SVC_TAXI, SVC_TRAILER, and SVC_TRUCK.

Referenced by SUMOVTypeParameter().

Here is the caller graph for this function:

◆ setParameter()

◆ setParameters()

void Parameterised::setParameters ( const Parameterised params)
inherited

set the inner key/value map in map<string, string> format

Definition at line 168 of file Parameterised.cpp.

References Parameterised::getParametersMap(), Parameterised::myMap, and Parameterised::setParameter().

◆ setParametersMap()

void Parameterised::setParametersMap ( const std::map< std::string, std::string > &  paramsMap)
inherited

set the inner key/value map in map<string, string> format

Definition at line 179 of file Parameterised.cpp.

References Parameterised::myMap, and Parameterised::setParameter().

◆ setParametersStr()

void Parameterised::setParametersStr ( const std::string &  paramsString,
const std::string  kvsep = "=",
const std::string  sep = "|" 
)
inherited

set the inner key/value map in string format "key1=value1|key2=value2|...|keyN=valueN"

Parameters
[in]paramsStringA serialized key-value map
[in]kvsepThe separater between key and value
[in]sepThe separater between map entries

Definition at line 190 of file Parameterised.cpp.

References StringTokenizer::getVector(), Parameterised::myMap, and Parameterised::setParameter().

Referenced by MSDevice_Taxi::initDispatch(), GNEAccess::setAttribute(), GNEBusStop::setAttribute(), GNECalibrator::setAttribute(), GNECalibratorFlow::setAttribute(), GNEChargingStation::setAttribute(), GNEClosingLaneReroute::setAttribute(), GNEClosingReroute::setAttribute(), GNEContainerStop::setAttribute(), GNEDestProbReroute::setAttribute(), GNEDetectorE1::setAttribute(), GNEDetectorE1Instant::setAttribute(), GNEDetectorE2::setAttribute(), GNEDetectorE3::setAttribute(), GNEDetectorEntryExit::setAttribute(), GNEParkingArea::setAttribute(), GNEParkingAreaReroute::setAttribute(), GNEParkingSpace::setAttribute(), GNEPOI::setAttribute(), GNEPoly::setAttribute(), GNERerouter::setAttribute(), GNERerouterInterval::setAttribute(), GNERouteProbe::setAttribute(), GNERouteProbReroute::setAttribute(), GNETAZ::setAttribute(), GNETAZSourceSink::setAttribute(), GNEVaporizer::setAttribute(), GNEVariableSpeedSign::setAttribute(), GNEVariableSpeedSignStep::setAttribute(), GNEEdgeData::setAttribute(), GNEEdgeRelData::setAttribute(), GNETAZRelData::setAttribute(), GNEPerson::setAttribute(), GNEPersonTrip::setAttribute(), GNERide::setAttribute(), GNERoute::setAttribute(), GNEVehicle::setAttribute(), GNEVehicleType::setAttribute(), GNEWalk::setAttribute(), GNEConnection::setAttribute(), GNEEdge::setAttribute(), GNEEdgeType::setAttribute(), GNEJunction::setAttribute(), GNELane::setAttribute(), and GNELaneType::setAttribute().

Here is the caller graph for this function:

◆ unsetParameter()

void Parameterised::unsetParameter ( const std::string &  key)
inherited

Removes a parameter.

Parameters
[in]keyThe parameter's name

Definition at line 92 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by NIImporter_OpenStreetMap::insertEdge(), and GNEVehicleType::setAttribute().

Here is the caller graph for this function:

◆ updateParameters()

void Parameterised::updateParameters ( const std::map< std::string, std::string > &  mapArg)
inherited

Adds or updates all given parameters from the map.

Parameters
[in]mapArgThe keys/values to insert

Definition at line 98 of file Parameterised.cpp.

References Parameterised::setParameter().

Referenced by NIImporter_SUMO::_loadNetwork(), PCLoaderOSM::addPOI(), PCLoaderOSM::addPolygon(), NLHandler::closeEdge(), NLJunctionControlBuilder::closeJunction(), NBTrafficLightDefinition::compute(), NIImporter_OpenStreetMap::insertEdge(), NBEdge::NBEdge(), and NBLoadedSUMOTLDef::NBLoadedSUMOTLDef().

Here is the caller graph for this function:

◆ wasSet()

bool SUMOVTypeParameter::wasSet ( int  what) const
inline

Returns whether the given parameter was set.

Parameters
[in]whatThe parameter which one asks for
Returns
Whether the given parameter was set

Definition at line 148 of file SUMOVTypeParameter.h.

References parametersSet.

Referenced by GNEVehicleType::getAttribute(), GNEVehicleType::getAttributeDouble(), GUIVehicle::getTypeParameterWindow(), MSVehicleType::initRailVisualizationParameters(), GNEVehicleType::initRailVisualizationParameters(), GNEVehicleType::isAttributeEnabled(), MSVehicleType::MSVehicleType(), GNEVehicleType::overwriteVType(), GNEVehicleType::updateDefaultVClassAttributes(), and write().

Here is the caller graph for this function:

◆ write()

void SUMOVTypeParameter::write ( OutputDevice dev) const

Writes the vtype.

Parameters
[in,out]devThe device to write into
Exceptions
IOErrornot yet implemented

Definition at line 336 of file SUMOVTypeParameter.cpp.

References actionStepLength, boardingDuration, SUMOXMLDefinitions::CarFollowModels, cfModel, cfParameter, OutputDevice::closeTag(), color, containerCapacity, defaultProbability, emissionClass, getManoeuverAngleTimesS(), PollutantsInterface::getName(), getVehicleShapeName(), height, imgFile, impatience, jmParameter, latAlignment, lcModel, lcParameter, length, loadingDuration, maxSpeed, maxSpeedLat, minGap, minGapLat, onlyReferenced, OutputDevice::openTag(), osgFile, personCapacity, shape, speedFactor, STEPS2TIME, SUMO_ATTR_ACTIONSTEPLENGTH, SUMO_ATTR_BOARDING_DURATION, SUMO_ATTR_CAR_FOLLOW_MODEL, SUMO_ATTR_COLOR, SUMO_ATTR_CONTAINER_CAPACITY, SUMO_ATTR_EMISSIONCLASS, SUMO_ATTR_GUISHAPE, SUMO_ATTR_HEIGHT, SUMO_ATTR_ID, SUMO_ATTR_IMGFILE, SUMO_ATTR_IMPATIENCE, SUMO_ATTR_LANE_CHANGE_MODEL, SUMO_ATTR_LATALIGNMENT, SUMO_ATTR_LENGTH, SUMO_ATTR_LOADING_DURATION, SUMO_ATTR_MANEUVER_ANGLE_TIMES, SUMO_ATTR_MAXSPEED, SUMO_ATTR_MAXSPEED_LAT, SUMO_ATTR_MINGAP, SUMO_ATTR_MINGAP_LAT, SUMO_ATTR_OSGFILE, SUMO_ATTR_PERSON_CAPACITY, SUMO_ATTR_PROB, SUMO_ATTR_SPEEDFACTOR, SUMO_ATTR_VCLASS, SUMO_ATTR_WIDTH, SUMO_TAG_VTYPE, toString(), vehicleClass, VTYPEPARS_ACTIONSTEPLENGTH_SET, VTYPEPARS_BOARDING_DURATION, VTYPEPARS_CAR_FOLLOW_MODEL, VTYPEPARS_COLOR_SET, VTYPEPARS_CONTAINER_CAPACITY, VTYPEPARS_EMISSIONCLASS_SET, VTYPEPARS_HEIGHT_SET, VTYPEPARS_IMGFILE_SET, VTYPEPARS_IMPATIENCE_SET, VTYPEPARS_LANE_CHANGE_MODEL_SET, VTYPEPARS_LATALIGNMENT_SET, VTYPEPARS_LENGTH_SET, VTYPEPARS_LOADING_DURATION, VTYPEPARS_MANEUVER_ANGLE_TIMES_SET, VTYPEPARS_MAXSPEED_LAT_SET, VTYPEPARS_MAXSPEED_SET, VTYPEPARS_MINGAP_LAT_SET, VTYPEPARS_MINGAP_SET, VTYPEPARS_OSGFILE_SET, VTYPEPARS_PERSON_CAPACITY, VTYPEPARS_PROBABILITY_SET, VTYPEPARS_SHAPE_SET, VTYPEPARS_SPEEDFACTOR_SET, VTYPEPARS_VEHICLECLASS_SET, VTYPEPARS_WIDTH_SET, wasSet(), width, OutputDevice::writeAttr(), and Parameterised::writeParams().

Referenced by ROPerson::saveAsXML(), ROVehicle::saveAsXML(), GNEVehicleType::writeDemandElement(), and RODFDetectorCon::writeEmitters().

Here is the caller graph for this function:

◆ writeParams()

Field Documentation

◆ actionStepLength

SUMOTime SUMOVTypeParameter::actionStepLength

The vehicle type's default actionStepLength [ms], i.e. the interval between two control actions. The default value of 0ms. induces the value to be traced from MSGlobals::gActionStepLength.

Definition at line 223 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::check(), MSVehicleType::getActionStepLength(), GNEVehicleType::getAttribute(), MSVehicleType::MSVehicleType(), GNEVehicleType::overwriteVType(), MSVehicleType::setActionStepLength(), GNEVehicleType::setAttribute(), and write().

◆ boardingDuration

SUMOTime SUMOVTypeParameter::boardingDuration

◆ carriageGap

◆ carriageLength

◆ cfModel

◆ cfParameter

◆ color

◆ containerCapacity

◆ defaultProbability

double SUMOVTypeParameter::defaultProbability

◆ emissionClass

◆ height

◆ id

◆ imgFile

◆ impatience

double SUMOVTypeParameter::impatience

◆ jmParameter

SubParams SUMOVTypeParameter::jmParameter

◆ latAlignment

◆ lcModel

◆ lcParameter

◆ length

◆ loadingDuration

SUMOTime SUMOVTypeParameter::loadingDuration

◆ locomotiveLength

◆ maxSpeed

◆ maxSpeedLat

◆ minGap

◆ minGapLat

◆ myAttrType

ParameterisedAttrType Parameterised::myAttrType
privateinherited

parameterised type

Definition at line 143 of file Parameterised.h.

Referenced by Parameterised::Parameterised(), and Parameterised::setParameter().

◆ myManoeuverAngleTimes

std::map<int, std::pair<SUMOTime, SUMOTime> > SUMOVTypeParameter::myManoeuverAngleTimes

Map of manoeuver angles versus the times (entry, exit) to execute the manoeuver.

Definition at line 354 of file SUMOVTypeParameter.h.

Referenced by getEntryManoeuvreTime(), getExitManoeuvreTime(), getManoeuverAngleTimesS(), SUMOVehicleParserHelper::parseAngleTimesMap(), and setManoeuverAngleTimes().

◆ myMap

◆ onlyReferenced

bool SUMOVTypeParameter::onlyReferenced

Information whether this is a type-stub, being only referenced but not defined (needed by routers)

Definition at line 311 of file SUMOVTypeParameter.h.

Referenced by RONet::RONet(), and write().

◆ osgFile

◆ parametersSet

◆ paramRestrictions

std::vector<double> SUMOVTypeParameter::paramRestrictions

cached value of parameters which may restrict access to certain edges

Definition at line 314 of file SUMOVTypeParameter.h.

Referenced by cacheParamRestrictions(), and ROEdge::restricts().

◆ personCapacity

◆ saved

bool SUMOVTypeParameter::saved
mutable

Information whether this type was already saved (needed by routers)

Definition at line 308 of file SUMOVTypeParameter.h.

Referenced by ROPerson::saveAsXML(), and ROVehicle::saveAsXML().

◆ shape

◆ speedFactor

◆ vehicleClass

◆ width


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