SUMO - Simulation of Urban MObility
|
Structure representing possible vehicle parameter. More...
#include <SUMOVTypeParameter.h>
Public Types | |
typedef std::map< SumoXMLAttr, SUMOReal > | CFParams |
Car-following parameter. More... | |
Public Member Functions | |
void | addParameter (const std::string &key, const std::string &value) |
Adds a parameter. More... | |
void | addParameter (const std::map< std::string, std::string > &mapArg) |
Adds all given parameter. More... | |
void | addParameter (const Parameterised &p) |
Adds all given parameter. More... | |
void | clearParameter () |
Clears the parameter map. More... | |
SUMOReal | get (const SumoXMLAttr attr, const SUMOReal defaultValue) const |
Returns the named value from the map, or the default if it is ot contained there. More... | |
const std::map< std::string, std::string > & | getMap () const |
Returns the inner key/value map. More... | |
const std::string & | getParameter (const std::string &key, const std::string &defaultValue) const |
Returns the value for a given key. More... | |
bool | knowsParameter (const std::string &key) const |
Returns whether the parameter is known. More... | |
SUMOVTypeParameter () | |
Constructor. More... | |
void | validateCFParameter () const |
Validates stored car-following parameter. More... | |
bool | wasSet (int what) const |
Returns whether the given parameter was set. More... | |
void | write (OutputDevice &dev) const |
Writes the vtype. More... | |
Data Fields | |
SumoXMLTag | cfModel |
The enum-representation of the car-following model to use. More... | |
CFParams | cfParameter |
RGBColor | color |
The color. More... | |
SUMOReal | 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... | |
SUMOReal | impatience |
The vehicle's impatience (willingness to obstruct others) More... | |
std::string | lcModel |
The name of the lane-change model to use. More... | |
SUMOReal | length |
The physical vehicle length. More... | |
SUMOReal | maxSpeed |
The vehicle type's maximum speed [m/s]. More... | |
SUMOReal | minGap |
This class' free space in front of the vehicle itself. More... | |
bool | onlyReferenced |
Information whether this is a type-stub, being only referenced but not defined (needed by routers) More... | |
bool | saved |
Information whether this type was already saved (needed by routers) More... | |
int | setParameter |
Information for the router which parameter were set. More... | |
SUMOReal | speedDev |
The standard deviation for speed variations. More... | |
SUMOReal | 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 | |
SUMOReal | width |
This class' width. More... | |
SUMOReal | 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... | |
Structure representing possible vehicle parameter.
Definition at line 77 of file SUMOVTypeParameter.h.
typedef std::map<SumoXMLAttr, SUMOReal> SUMOVTypeParameter::CFParams |
Car-following parameter.
Definition at line 164 of file SUMOVTypeParameter.h.
SUMOVTypeParameter::SUMOVTypeParameter | ( | ) |
Constructor.
Initialises the structure with default values
Definition at line 50 of file SUMOVTypeParameter.cpp.
|
inherited |
Adds a parameter.
[in] | key | The parameter's name |
[in] | value | The parameter's value |
Definition at line 53 of file Parameterised.cpp.
References Parameterised::myMap.
Referenced by NLHandler::addParam(), SUMORouteHandler::addParam(), PCLoaderOSM::addPOI(), PCLoaderOSM::addPolygon(), and NIImporter_MATSim::EdgesHandler::myStartElement().
|
inherited |
Adds all given parameter.
[in] | mapArg | The keys/values to insert |
Definition at line 59 of file Parameterised.cpp.
References Parameterised::myMap.
|
inherited |
Adds all given parameter.
[in] | p | The keys/values to insert |
Definition at line 67 of file Parameterised.cpp.
References Parameterised::myMap.
|
inherited |
Clears the parameter map.
Definition at line 91 of file Parameterised.cpp.
References Parameterised::myMap.
SUMOReal SUMOVTypeParameter::get | ( | const SumoXMLAttr | attr, |
const SUMOReal | defaultValue | ||
) | const |
Returns the named value from the map, or the default if it is ot contained there.
[in] | attr | The corresponding xml attribute |
[in] | defaultValue | The value to return if the given map does not contain the named variable |
Definition at line 141 of file SUMOVTypeParameter.cpp.
References cfParameter.
Referenced by MSVehicleType::build(), ROEdge::getCO2Effort(), ROEdge::getCOEffort(), ROEdge::getFuelEffort(), ROEdge::getHCEffort(), ROEdge::getNOxEffort(), and ROEdge::getPMxEffort().
|
inlineinherited |
Returns the inner key/value map.
Definition at line 106 of file Parameterised.h.
References Parameterised::myMap.
Referenced by PCPolyContainer::save().
|
inherited |
Returns the value for a given key.
[in] | key | The key to ask for |
[in] | defaultValue | The default value to return if no value is stored under the key |
Definition at line 81 of file Parameterised.cpp.
References Parameterised::myMap.
Referenced by MSDevice_Example::buildVehicleDevices(), MSTLLogicControl::WAUTSwitchProcedure::getGSPValue(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::getStretchAreaNo(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::getStretchBereichDef(), MSAgentbasedTrafficLightLogic::init(), MSActuatedTrafficLightLogic::MSActuatedTrafficLightLogic(), MSAgentbasedTrafficLightLogic::MSAgentbasedTrafficLightLogic(), and TraCIServerAPI_Vehicle::vtdMap_matchingNearest().
|
inherited |
Returns whether the parameter is known.
[in] | key | The key to ask for |
Definition at line 75 of file Parameterised.cpp.
References Parameterised::myMap.
Referenced by MSDevice_Example::buildVehicleDevices(), and TraCIServerAPI_Vehicle::vtdMap_matchingNearest().
void SUMOVTypeParameter::validateCFParameter | ( | ) | const |
Validates stored car-following parameter.
Returns whether the given parameter was set.
[in] | what | The parameter which one asks for |
Definition at line 90 of file SUMOVTypeParameter.h.
References setParameter.
Referenced by write().
void SUMOVTypeParameter::write | ( | OutputDevice & | dev | ) | const |
Writes the vtype.
[in,out] | dev | The device to write into |
IOError | not yet implemented |
Definition at line 66 of file SUMOVTypeParameter.cpp.
References cfModel, cfParameter, OutputDevice::closeTag(), color, defaultProbability, emissionClass, getVehicleEmissionTypeName(), getVehicleShapeName(), height, imgFile, impatience, length, max, maxSpeed, minGap, onlyReferenced, OutputDevice::openTag(), osgFile, shape, speedDev, speedFactor, SUMO_ATTR_COLOR, SUMO_ATTR_EMISSIONCLASS, SUMO_ATTR_GUISHAPE, SUMO_ATTR_HEIGHT, SUMO_ATTR_ID, SUMO_ATTR_IMGFILE, SUMO_ATTR_IMPATIENCE, SUMO_ATTR_LENGTH, SUMO_ATTR_MAXSPEED, SUMO_ATTR_MINGAP, SUMO_ATTR_OSGFILE, SUMO_ATTR_PROB, SUMO_ATTR_SPEEDDEV, SUMO_ATTR_SPEEDFACTOR, SUMO_ATTR_VCLASS, SUMO_ATTR_WIDTH, SUMO_TAG_VTYPE, toString(), vehicleClass, VTYPEPARS_COLOR_SET, VTYPEPARS_EMISSIONCLASS_SET, VTYPEPARS_HEIGHT_SET, VTYPEPARS_IMGFILE_SET, VTYPEPARS_IMPATIENCE_SET, VTYPEPARS_LENGTH_SET, VTYPEPARS_MAXSPEED_SET, VTYPEPARS_MINGAP_SET, VTYPEPARS_OSGFILE_SET, VTYPEPARS_PROBABILITY_SET, VTYPEPARS_SHAPE_SET, VTYPEPARS_SPEEDDEVIATION_SET, VTYPEPARS_SPEEDFACTOR_SET, VTYPEPARS_VEHICLECLASS_SET, VTYPEPARS_WIDTH_SET, wasSet(), width, and OutputDevice::writeAttr().
Referenced by ROVehicle::saveAllAsXML().
SumoXMLTag SUMOVTypeParameter::cfModel |
The enum-representation of the car-following model to use.
Definition at line 161 of file SUMOVTypeParameter.h.
Referenced by MSVehicleType::build(), SUMOVehicleParserHelper::parseVTypeEmbedded(), and write().
CFParams SUMOVTypeParameter::cfParameter |
Definition at line 165 of file SUMOVTypeParameter.h.
Referenced by get(), SUMOVehicleParserHelper::parseVTypeEmbedded(), and write().
RGBColor SUMOVTypeParameter::color |
The color.
Definition at line 133 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::getColor(), MSVehicleType::setColor(), and write().
SUMOReal SUMOVTypeParameter::defaultProbability |
The probability when being added to a distribution without an explicit probability.
Definition at line 125 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::getDefaultProbability(), RORouteHandler::myEndElement(), MSVehicleType::setDefaultProbability(), and write().
SUMOEmissionClass SUMOVTypeParameter::emissionClass |
The emission class of this vehicle.
Definition at line 131 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), ROEdge::getCO2Effort(), ROEdge::getCOEffort(), MSVehicleType::getEmissionClass(), ROEdge::getFuelEffort(), ROEdge::getHCEffort(), ROEdge::getNoiseEffort(), ROEdge::getNOxEffort(), ROEdge::getPMxEffort(), MSVehicleType::setEmissionClass(), and write().
SUMOReal SUMOVTypeParameter::height |
This class' height.
Definition at line 147 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::getHeight(), and write().
std::string SUMOVTypeParameter::id |
The vehicle type's id.
Definition at line 116 of file SUMOVTypeParameter.h.
Referenced by RONet::addVehicleType(), SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), MSVehicleType::getID(), RONet::getVehicleTypeSecure(), SUMOVehicleParserHelper::parseVTypeEmbedded(), and RONet::RONet().
std::string SUMOVTypeParameter::imgFile |
Image file for this class.
Definition at line 156 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::getImgFile(), and write().
SUMOReal SUMOVTypeParameter::impatience |
The vehicle's impatience (willingness to obstruct others)
Definition at line 137 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::getImpatience(), MSVehicleType::setImpatience(), and write().
std::string SUMOVTypeParameter::lcModel |
The name of the lane-change model to use.
Definition at line 168 of file SUMOVTypeParameter.h.
SUMOReal SUMOVTypeParameter::length |
The physical vehicle length.
Definition at line 119 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::getLength(), MSVehicleType::getLengthWithGap(), MSVehicleType::setLength(), and write().
SUMOReal SUMOVTypeParameter::maxSpeed |
The vehicle type's maximum speed [m/s].
Definition at line 123 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), ROEdge::getCO2Effort(), ROEdge::getCOEffort(), ROEdge::getEffort(), ROEdge::getFuelEffort(), ROEdge::getHCEffort(), ROVehicle::getMaxSpeed(), MSVehicleType::getMaxSpeed(), ROEdge::getMinimumTravelTime(), ROEdge::getNoiseEffort(), ROEdge::getNOxEffort(), ROEdge::getPMxEffort(), ROEdge::getTravelTime(), MSVehicleType::setMaxSpeed(), and write().
SUMOReal SUMOVTypeParameter::minGap |
This class' free space in front of the vehicle itself.
Definition at line 121 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::getLengthWithGap(), MSVehicleType::getMinGap(), MSVehicleType::setMinGap(), and write().
|
mutable |
Information whether this is a type-stub, being only referenced but not defined (needed by routers)
Definition at line 178 of file SUMOVTypeParameter.h.
Referenced by RONet::getVehicleTypeSecure(), RONet::RONet(), and write().
std::string SUMOVTypeParameter::osgFile |
3D model file for this class
Definition at line 153 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::getOSGFile(), and write().
|
mutable |
Information whether this type was already saved (needed by routers)
Definition at line 175 of file SUMOVTypeParameter.h.
Referenced by ROVehicle::saveAllAsXML().
int SUMOVTypeParameter::setParameter |
Information for the router which parameter were set.
Definition at line 171 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), wasSet(), and MSVehicleType::wasSet().
SUMOVehicleShape SUMOVTypeParameter::shape |
This class' shape.
Definition at line 150 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::getGuiShape(), MSVehicleType::setShape(), and write().
SUMOReal SUMOVTypeParameter::speedDev |
The standard deviation for speed variations.
Definition at line 129 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::computeChosenSpeedDeviation(), MSVehicleType::getSpeedDeviation(), MSVehicleType::setSpeedDeviation(), and write().
SUMOReal SUMOVTypeParameter::speedFactor |
The factor by which the maximum speed may deviate from the allowed max speed on the street.
Definition at line 127 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::computeChosenSpeedDeviation(), MSVehicleType::getSpeedFactor(), MSVehicleType::setSpeedFactor(), and write().
SUMOVehicleClass SUMOVTypeParameter::vehicleClass |
The vehicle's class.
Definition at line 135 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), ROVehicle::getVClass(), MSVehicleType::getVehicleClass(), MSVehicleType::setVClass(), and write().
SUMOReal SUMOVTypeParameter::width |
This class' width.
Definition at line 144 of file SUMOVTypeParameter.h.
Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::getWidth(), MSVehicleType::setWidth(), and write().