SUMOVTypeParameter Class Reference

Structure representing possible vehicle parameter. More...

#include <SUMOVTypeParameter.h>

Public Types
typedef std::map< SumoXMLAttr, SUMOReal >	CFParams
	Car-following parameter.
Public Member Functions
	SUMOVTypeParameter ()
	Constructor.
void	validateCFParameter () const
	Validates stored car-following parameter.
bool	wasSet (int what) const
	Returns whether the given parameter was set.
void	write (OutputDevice &dev) const
	Writes the vtype.
Data Fields
SumoXMLTag	cfModel
	The enum-representation of the car-following model to use.
CFParams	cfParameter
RGBColor	color
	The color.
SUMOReal	defaultProbability
	The probability when being added to a distribution without an explicit probability.
SUMOEmissionClass	emissionClass
	The emission class of this vehicle.
std::string	id
	The vehicle type's id.
std::string	lcModel
	The name of the lane-change model to use.
SUMOReal	length
	The physical vehicle length + the standing gap in m.
SUMOReal	maxSpeed
	The vehicle type's maximum speed [m/s].
SUMOReal	minGap
	This class' free space in front of the vehicle itself.
bool	onlyReferenced
	Information whether this is a type-stub, being only referenced but not defined (needed by routers)
bool	saved
	Information whether this type was already saved (needed by routers)
int	setParameter
	Information for the router which parameter were set.
SUMOReal	speedDev
	The standard deviation for speed variations.
SUMOReal	speedFactor
	The factor by which the maximum speed may deviate from the allowed max speed on the street.
SUMOVehicleClass	vehicleClass
	The vehicle's class.
Values for drawing this class' vehicles
SUMOReal	width
	This class' width.
SUMOVehicleShape	shape
	This class' shape.

---

Detailed Description

Structure representing possible vehicle parameter.

Definition at line 72 of file SUMOVTypeParameter.h.

---

Member Typedef Documentation

typedef std::map<SumoXMLAttr, SUMOReal> SUMOVTypeParameter::CFParams

Car-following parameter.

Definition at line 140 of file SUMOVTypeParameter.h.

---

Constructor & Destructor Documentation

SUMOVTypeParameter::SUMOVTypeParameter

(

)

Constructor.

Initialises the structure with default values

Definition at line 50 of file SUMOVTypeParameter.cpp.

References DEFAULT_VEH_FOLLOW_MODEL, DEFAULT_VEH_GUIWIDTH, DEFAULT_VEH_LANE_CHANGE_MODEL, DEFAULT_VEH_LENGTH, DEFAULT_VEH_MAXSPEED, DEFAULT_VEH_MINGAP, DEFAULT_VEH_PROB, DEFAULT_VEH_SHAPE, DEFAULT_VEH_SPEEDDEV, DEFAULT_VEH_SPEEDFACTOR, and DEFAULT_VTYPE_ID.

---

Member Function Documentation

void SUMOVTypeParameter::validateCFParameter

(

)

const

Validates stored car-following parameter.

bool SUMOVTypeParameter::wasSet

(

int

what

)

const [inline]

Returns whether the given parameter was set.

Parameters:

[in]

what

The parameter which one asks for

Returns:

Whether the given parameter was set

Definition at line 85 of file SUMOVTypeParameter.h.

References setParameter.

Referenced by write().

void SUMOVTypeParameter::write

(

OutputDevice &

dev

)

const

Writes the vtype.

Parameters:

[in,out]

dev

The device to write into

Exceptions:

IOError

not yet implemented

Definition at line 64 of file SUMOVTypeParameter.cpp.

References cfModel, cfParameter, OutputDevice::closeTag(), color, defaultProbability, emissionClass, getVehicleEmissionTypeName(), getVehicleShapeName(), length, maxSpeed, minGap, onlyReferenced, OutputDevice::openTag(), shape, speedDev, speedFactor, SUMO_ATTR_COLOR, SUMO_ATTR_EMISSIONCLASS, SUMO_ATTR_GUISHAPE, SUMO_ATTR_GUIWIDTH, SUMO_ATTR_ID, SUMO_ATTR_LENGTH, SUMO_ATTR_MAXSPEED, SUMO_ATTR_MINGAP, SUMO_ATTR_PROB, SUMO_ATTR_SPEEDDEV, SUMO_ATTR_SPEEDFACTOR, SUMO_ATTR_VCLASS, SUMO_TAG_VTYPE, toString(), vehicleClass, VTYPEPARS_COLOR_SET, VTYPEPARS_EMISSIONCLASS_SET, VTYPEPARS_LENGTH_SET, VTYPEPARS_MAXSPEED_SET, VTYPEPARS_MINGAP_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().

---

Field Documentation

SumoXMLTag SUMOVTypeParameter::cfModel

The enum-representation of the car-following model to use.

Definition at line 137 of file SUMOVTypeParameter.h.

Referenced by MSVehicleType::build(), SUMOVehicleParserHelper::parseVTypeEmbedded(), and write().

CFParams SUMOVTypeParameter::cfParameter

Definition at line 141 of file SUMOVTypeParameter.h.

Referenced by MSVehicleType::build(), SUMOVehicleParserHelper::parseVTypeEmbedded(), and write().

RGBColor SUMOVTypeParameter::color

The color.

Definition at line 120 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), and write().

SUMOReal SUMOVTypeParameter::defaultProbability

The probability when being added to a distribution without an explicit probability.

Definition at line 112 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), and write().

SUMOEmissionClass SUMOVTypeParameter::emissionClass

The emission class of this vehicle.

Definition at line 118 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), ROEdge::getCO2Effort(), ROEdge::getCOEffort(), ROEdge::getFuelEffort(), ROEdge::getHCEffort(), ROEdge::getNoiseEffort(), ROEdge::getNOxEffort(), ROEdge::getPMxEffort(), and write().

std::string SUMOVTypeParameter::id

The vehicle type's id.

Definition at line 103 of file SUMOVTypeParameter.h.

Referenced by RONet::addVehicleType(), SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), RONet::getVehicleTypeSecure(), and SUMOVehicleParserHelper::parseVTypeEmbedded().

std::string SUMOVTypeParameter::lcModel

The name of the lane-change model to use.

Definition at line 144 of file SUMOVTypeParameter.h.

Referenced by MSVehicleType::build().

SUMOReal SUMOVTypeParameter::length

The physical vehicle length + the standing gap in m.

Definition at line 106 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), and write().

SUMOReal SUMOVTypeParameter::maxSpeed

The vehicle type's maximum speed [m/s].

Definition at line 110 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), ROEdge::getCO2Effort(), ROEdge::getCOEffort(), ROEdge::getFuelEffort(), ROEdge::getHCEffort(), ROEdge::getNoiseEffort(), ROEdge::getNOxEffort(), ROEdge::getPMxEffort(), and write().

SUMOReal SUMOVTypeParameter::minGap

This class' free space in front of the vehicle itself.

Definition at line 108 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), and write().

bool SUMOVTypeParameter::onlyReferenced [mutable]

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

Definition at line 154 of file SUMOVTypeParameter.h.

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

bool SUMOVTypeParameter::saved [mutable]

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

Definition at line 151 of file SUMOVTypeParameter.h.

Referenced by ROVehicle::saveAllAsXML().

int SUMOVTypeParameter::setParameter

Information for the router which parameter were set.

Definition at line 147 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), and wasSet().

SUMOVehicleShape SUMOVTypeParameter::shape

This class' shape.

Definition at line 132 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), and write().

SUMOReal SUMOVTypeParameter::speedDev

The standard deviation for speed variations.

Definition at line 116 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), 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 114 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), and write().

SUMOVehicleClass SUMOVTypeParameter::vehicleClass

The vehicle's class.

Definition at line 122 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), ROEdge::prohibits(), and write().

SUMOReal SUMOVTypeParameter::width

This class' width.

Definition at line 129 of file SUMOVTypeParameter.h.

Referenced by SUMOVehicleParserHelper::beginVTypeParsing(), MSVehicleType::build(), and write().

---

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

• SUMOVTypeParameter.h
• SUMOVTypeParameter.cpp