Structure representing possible vehicle parameter. More...

#include <SUMOVehicleParameter.h>

Data Structures
struct	Stop
	Definition of vehicle stop (position and duration) More...
Public Member Functions
bool	defaultOptionOverrides (const OptionsCont &oc, const std::string &optionName) const throw ()
	Returns whether the defaults shall be used.
	SUMOVehicleParameter () throw ()
	Constructor.
bool	wasSet (int what) const throw ()
	Returns whether the given parameter was set.
void	writeAs (const std::string &xmlElem, OutputDevice &dev, const OptionsCont &oc) const throw (IOError)
	Writes the parameters as a beginning element.
Static Public Member Functions
Depart/arrival-attributes verification
static bool	departlaneValidate (const std::string &val) throw ()
	Validates a given departlane value.
static bool	departposValidate (const std::string &val) throw ()
	Validates a given departpos value.
static bool	departspeedValidate (const std::string &val) throw ()
	Validates a given departspeed value.
static bool	arrivallaneValidate (const std::string &val) throw ()
	Validates a given arrivallane value.
static bool	arrivalposValidate (const std::string &val) throw ()
	Validates a given arrivalpos value.
static bool	arrivalspeedValidate (const std::string &val) throw ()
	Validates a given arrivalspeed value.
Data Fields
RGBColor	color
	The vehicle's color.
std::string	fromTaz
	The vehicle's origin zone (district)
std::string	id
	The vehicle's id.
std::string	line
	The vehicle's line (mainly for public transport)
std::string	routeid
	The vehicle's route id.
int	setParameter
	Information for the router which parameter were set.
std::vector< Stop >	stops
	List of the stops the vehicle will make.
std::string	toTaz
	The vehicle's destination zone (district)
std::string	vtypeid
	The vehicle's type id.
Departure definition
SUMOTime	depart
	The vehicle's departure time.
DepartDefinition	departProcedure
	Information how the vehicle shall choose the depart time.
int	departLane
	(optional) The lane the vehicle shall depart from (index in edge)
DepartLaneDefinition	departLaneProcedure
	Information how the vehicle shall choose the lane to depart from.
SUMOReal	departPos
	(optional) The position the vehicle shall depart from
DepartPosDefinition	departPosProcedure
	Information how the vehicle shall choose the departure position.
SUMOReal	departSpeed
	(optional) The initial speed of the vehicle
DepartSpeedDefinition	departSpeedProcedure
	Information how the vehicle's initial speed shall be chosen.
Arrival definition
int	arrivalLane
	(optional) The lane the vehicle shall arrive on (not used yet)
ArrivalLaneDefinition	arrivalLaneProcedure
	Information how the vehicle shall choose the lane to arrive on.
SUMOReal	arrivalPos
	(optional) The position the vehicle shall arrive on
ArrivalPosDefinition	arrivalPosProcedure
	Information how the vehicle shall choose the arrival position.
SUMOReal	arrivalSpeed
	(optional) The final speed of the vehicle (not used yet)
ArrivalSpeedDefinition	arrivalSpeedProcedure
	Information how the vehicle's end speed shall be chosen.
Repetition definition
int	repetitionNumber
	The number of times the vehicle shall be repeatedly inserted.
int	repetitionsDone
	The number of times the vehicle was already inserted.
SUMOReal	repetitionOffset
	The time offset between vehicle reinsertions.

Detailed Description

Structure representing possible vehicle parameter.

The fields yielding with "Procedure" describe whether the according value shall be used or another procedure is used to choose the value.

See also:: DepartLaneDefinition; DepartPosDefinition; DepartSpeedDefinition

Definition at line 208 of file SUMOVehicleParameter.h.

Constructor & Destructor Documentation

SUMOVehicleParameter::SUMOVehicleParameter ( ) throw ()

Constructor.

Initialises the structure with default values

Definition at line 45 of file SUMOVehicleParameter.cpp.

Member Function Documentation

bool SUMOVehicleParameter::arrivallaneValidate ( const std::string & val ) throw () [static]

Validates a given arrivallane value.

Parameters:

[in] val The arrivallane value to validate

Returns:: Whether the given value is a valid arrivallane definition

Definition at line 292 of file SUMOVehicleParameter.cpp.

References TplConvert< E >::_2int(), and WRITE_ERROR.

Referenced by ROJTRFrame::checkOptions(), RODUAFrame::checkOptions(), and checkOptions().

bool SUMOVehicleParameter::arrivalposValidate ( const std::string & val ) throw () [static]

Validates a given arrivalpos value.

Parameters:

[in] val The arrivalpos value to validate

Returns:: Whether the given value is a valid arrivalpos definition

Definition at line 308 of file SUMOVehicleParameter.cpp.

References TplConvert< E >::_2SUMOReal(), and WRITE_ERROR.

Referenced by ROJTRFrame::checkOptions(), RODUAFrame::checkOptions(), and checkOptions().

bool SUMOVehicleParameter::arrivalspeedValidate ( const std::string & val ) throw () [static]

Validates a given arrivalspeed value.

Parameters:

[in] val The arrivalspeed value to validate

Returns:: Whether the given value is a valid arrivalspeed definition

Definition at line 324 of file SUMOVehicleParameter.cpp.

References TplConvert< E >::_2SUMOReal(), and WRITE_ERROR.

Referenced by ROJTRFrame::checkOptions(), RODUAFrame::checkOptions(), and checkOptions().

bool SUMOVehicleParameter::defaultOptionOverrides	(	const OptionsCont &	oc,
		const std::string &	optionName
	)		const throw ()

Returns whether the defaults shall be used.

Parameters:

[in]	oc	The options to get the options from
[in]	optionName	The name of the option to determine whether its value shall be used

Returns:: Whether the option is set and --defaults-override was set

Definition at line 60 of file SUMOVehicleParameter.cpp.

bool SUMOVehicleParameter::departlaneValidate ( const std::string & val ) throw () [static]

Validates a given departlane value.

Parameters:

[in] val The departlane value to validate

Returns:: Whether the given value is a valid departlane definition

Definition at line 244 of file SUMOVehicleParameter.cpp.

References TplConvert< E >::_2int(), and WRITE_ERROR.

Referenced by ROJTRFrame::checkOptions(), RODUAFrame::checkOptions(), and checkOptions().

bool SUMOVehicleParameter::departposValidate ( const std::string & val ) throw () [static]

Validates a given departpos value.

Parameters:

[in] val The departpos value to validate

Returns:: Whether the given value is a valid departpos definition

Definition at line 260 of file SUMOVehicleParameter.cpp.

References TplConvert< E >::_2SUMOReal(), and WRITE_ERROR.

Referenced by ROJTRFrame::checkOptions(), RODUAFrame::checkOptions(), and checkOptions().

bool SUMOVehicleParameter::departspeedValidate ( const std::string & val ) throw () [static]

Validates a given departspeed value.

Parameters:

[in] val The departspeed value to validate

Returns:: Whether the given value is a valid departspeed definition

Definition at line 276 of file SUMOVehicleParameter.cpp.

References TplConvert< E >::_2SUMOReal(), and WRITE_ERROR.

Referenced by ROJTRFrame::checkOptions(), RODUAFrame::checkOptions(), and checkOptions().

bool SUMOVehicleParameter::wasSet ( int what ) const throw () [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 221 of file SUMOVehicleParameter.h.

References setParameter.

Referenced by RORDGenerator_ODAmounts::myEndFlowAmountDef().

void SUMOVehicleParameter::writeAs	(	const std::string &	xmlElem,
		OutputDevice &	dev,
		const OptionsCont &	oc
	)		const throw (IOError)

Writes the parameters as a beginning element.

Parameters:

[in]	xmlElem	The name of the element to write
[in,out]	dev	The device to write into
[in]	oc	The options to get defaults from

Exceptions:

IOError not yet implemented

Definition at line 66 of file SUMOVehicleParameter.cpp.

References ARRIVAL_LANE_CURRENT, ARRIVAL_LANE_DEFAULT, ARRIVAL_LANE_GIVEN, ARRIVAL_POS_DEFAULT, ARRIVAL_POS_GIVEN, ARRIVAL_POS_MAX, ARRIVAL_POS_RANDOM, ARRIVAL_SPEED_CURRENT, ARRIVAL_SPEED_DEFAULT, ARRIVAL_SPEED_GIVEN, DEPART_LANE_ALLOWED_FREE, DEPART_LANE_BEST_FREE, DEPART_LANE_DEFAULT, DEPART_LANE_FREE, DEPART_LANE_GIVEN, DEPART_LANE_RANDOM, DEPART_POS_BASE, DEPART_POS_DEFAULT, DEPART_POS_FREE, DEPART_POS_GIVEN, DEPART_POS_MAX_SPEED_GAP, DEPART_POS_PWAG_GENERIC, DEPART_POS_PWAG_SIMPLE, DEPART_POS_RANDOM, DEPART_POS_RANDOM_FREE, DEPART_SPEED_DEFAULT, DEPART_SPEED_GIVEN, DEPART_SPEED_MAX, DEPART_SPEED_RANDOM, time2string(), toString(), VEHPARS_ARRIVALLANE_SET, VEHPARS_ARRIVALPOS_SET, VEHPARS_ARRIVALSPEED_SET, VEHPARS_COLOR_SET, VEHPARS_DEPARTLANE_SET, VEHPARS_DEPARTPOS_SET, VEHPARS_DEPARTSPEED_SET, VEHPARS_LINE_SET, VEHPARS_PERIODFREQ_SET, VEHPARS_PERIODNUM_SET, VEHPARS_TAZ_SET, and VEHPARS_VTYPE_SET.

Field Documentation

int SUMOVehicleParameter::arrivalLane

(optional) The lane the vehicle shall arrive on (not used yet)

Definition at line 330 of file SUMOVehicleParameter.h.

Referenced by MSVehicle::getBestLanes().

ArrivalLaneDefinition SUMOVehicleParameter::arrivalLaneProcedure

Information how the vehicle shall choose the lane to arrive on.

Definition at line 332 of file SUMOVehicleParameter.h.

Referenced by MSVehicle::getBestLanes().

SUMOReal SUMOVehicleParameter::arrivalPos

(optional) The position the vehicle shall arrive on

Definition at line 334 of file SUMOVehicleParameter.h.

Referenced by MSBaseVehicle::calculateArrivalPos().

ArrivalPosDefinition SUMOVehicleParameter::arrivalPosProcedure

Information how the vehicle shall choose the arrival position.

Definition at line 336 of file SUMOVehicleParameter.h.

Referenced by MSBaseVehicle::calculateArrivalPos().

SUMOReal SUMOVehicleParameter::arrivalSpeed

(optional) The final speed of the vehicle (not used yet)

Definition at line 338 of file SUMOVehicleParameter.h.

Referenced by MSVehicle::moveRegardingCritical(), and MSVehicle::vsafeCriticalCont().

ArrivalSpeedDefinition SUMOVehicleParameter::arrivalSpeedProcedure

Information how the vehicle's end speed shall be chosen.

Definition at line 340 of file SUMOVehicleParameter.h.

Referenced by MSVehicle::moveRegardingCritical(), and MSVehicle::vsafeCriticalCont().

RGBColor SUMOVehicleParameter::color [mutable]

The vehicle's color.

Definition at line 301 of file SUMOVehicleParameter.h.

Referenced by RORDGenerator_ODAmounts::myEndFlowAmountDef(), TraCIServerAPI_Vehicle::processGet(), and TraCIServerAPI_Vehicle::processSet().

SUMOTime SUMOVehicleParameter::depart

The vehicle's departure time.

Definition at line 308 of file SUMOVehicleParameter.h.

Referenced by MSVehicleContainer::add(), MSInsertionControl::checkFlows(), MSRouteHandler::checkLastDepart(), MSRouteHandler::closeFlow(), MSRouteHandler::closePerson(), RORDLoader_SUMOBase::closeVehicle(), MSRouteHandler::closeVehicle(), ROVehicle::copy(), MSDevice_Tripinfo::generateOutput(), ROVehicle::getDepartureTime(), MSPerson::getDesiredDepart(), SUMOVehicleParserHelper::parseFlowAttributes(), SUMOVehicleParserHelper::parseVehicleAttributes(), and TraCIServerAPI_Vehicle::processSet().

int SUMOVehicleParameter::departLane

(optional) The lane the vehicle shall depart from (index in edge)

Definition at line 312 of file SUMOVehicleParameter.h.

Referenced by TraCIServerAPI_Vehicle::processSet().

DepartLaneDefinition SUMOVehicleParameter::departLaneProcedure

Information how the vehicle shall choose the lane to depart from.

Definition at line 314 of file SUMOVehicleParameter.h.

Referenced by TraCIServerAPI_Vehicle::processSet().

SUMOReal SUMOVehicleParameter::departPos

(optional) The position the vehicle shall depart from

Definition at line 316 of file SUMOVehicleParameter.h.

Referenced by MSLane::insertVehicle(), MSEdge::insertVehicle(), and TraCIServerAPI_Vehicle::processSet().

DepartPosDefinition SUMOVehicleParameter::departPosProcedure

Information how the vehicle shall choose the departure position.

Definition at line 318 of file SUMOVehicleParameter.h.

Referenced by MSLane::insertVehicle(), MSEdge::insertVehicle(), and TraCIServerAPI_Vehicle::processSet().

DepartDefinition SUMOVehicleParameter::departProcedure

Information how the vehicle shall choose the depart time.

Definition at line 310 of file SUMOVehicleParameter.h.

Referenced by MSRouteHandler::checkLastDepart(), MSRouteHandler::closeVehicle(), SUMOVehicleParserHelper::parseVehicleAttributes(), MSPerson::MSPersonStage_Driving::proceed(), and TraCIServerAPI_Vehicle::processSet().

SUMOReal SUMOVehicleParameter::departSpeed

(optional) The initial speed of the vehicle

Definition at line 320 of file SUMOVehicleParameter.h.

Referenced by MSLane::insertVehicle(), and TraCIServerAPI_Vehicle::processSet().

DepartSpeedDefinition SUMOVehicleParameter::departSpeedProcedure

Information how the vehicle's initial speed shall be chosen.

Definition at line 322 of file SUMOVehicleParameter.h.

Referenced by MSLane::insertVehicle(), and TraCIServerAPI_Vehicle::processSet().

std::string SUMOVehicleParameter::fromTaz

The vehicle's origin zone (district)

Definition at line 364 of file SUMOVehicleParameter.h.

Referenced by MSDevice_Vehroutes::generateOutput().

std::string SUMOVehicleParameter::id

The vehicle's id.

Definition at line 294 of file SUMOVehicleParameter.h.

Referenced by MSInsertionControl::checkFlows(), MSRouteHandler::checkLastDepart(), MSRouteHandler::closeFlow(), MSRouteHandler::closePerson(), MSRouteHandler::closeRoute(), RORDLoader_SUMOBase::closeVehicle(), MSRouteHandler::closeVehicle(), ROVehicle::copy(), MSVehicle::enterLaneAtLaneChange(), ROVehicle::getID(), MSPerson::getID(), MSBaseVehicle::getID(), MSVehicle::moveChecked(), MSVehicle::moveRegardingCritical(), RORDGenerator_ODAmounts::myEndFlowAmountDef(), MSRouteHandler::openRoute(), MSRouteHandler::openRouteDistribution(), RORDGenerator_ODAmounts::parseFlowAmountDef(), SUMOVehicleParserHelper::parseFlowAttributes(), SUMOVehicleParserHelper::parseVehicleAttributes(), TraCIServerAPI_Vehicle::processSet(), RORDLoader_SUMOBase::startAlternative(), and RORDLoader_SUMOBase::startRoute().

std::string SUMOVehicleParameter::line

The vehicle's line (mainly for public transport)

Definition at line 361 of file SUMOVehicleParameter.h.

Referenced by MSVehicleControl::getWaitingVehicle().

int SUMOVehicleParameter::repetitionNumber

The number of times the vehicle shall be repeatedly inserted.

Definition at line 348 of file SUMOVehicleParameter.h.

Referenced by MSInsertionControl::checkFlows(), MSRouteHandler::closeFlow(), MSRouteHandler::closeRoute(), GUIVehicle::getParameterWindow(), SUMOVehicleParserHelper::parseFlowAttributes(), and SUMOVehicleParserHelper::parseVehicleAttributes().

SUMOReal SUMOVehicleParameter::repetitionOffset

The time offset between vehicle reinsertions.

Definition at line 355 of file SUMOVehicleParameter.h.

Referenced by MSInsertionControl::checkFlows(), MSRouteHandler::closeFlow(), SUMOVehicleParserHelper::parseFlowAttributes(), and SUMOVehicleParserHelper::parseVehicleAttributes().

int SUMOVehicleParameter::repetitionsDone

The number of times the vehicle was already inserted.

Definition at line 350 of file SUMOVehicleParameter.h.

Referenced by MSInsertionControl::checkFlows(), and MSRouteHandler::closeFlow().

std::string SUMOVehicleParameter::routeid

The vehicle's route id.

Definition at line 297 of file SUMOVehicleParameter.h.

Referenced by MSInsertionControl::checkFlows(), MSRouteHandler::closeFlow(), RORDLoader_SUMOBase::closeVehicle(), and MSRouteHandler::closeVehicle().

int SUMOVehicleParameter::setParameter

Information for the router which parameter were set.

Definition at line 397 of file SUMOVehicleParameter.h.

Referenced by SUMOVehicleParserHelper::parseFlowAttributes(), SUMOVehicleParserHelper::parseVehicleAttributes(), and wasSet().

std::vector<Stop> SUMOVehicleParameter::stops

List of the stops the vehicle will make.

Definition at line 394 of file SUMOVehicleParameter.h.

std::string SUMOVehicleParameter::toTaz

The vehicle's destination zone (district)

Definition at line 367 of file SUMOVehicleParameter.h.

Referenced by MSDevice_Vehroutes::generateOutput().

std::string SUMOVehicleParameter::vtypeid

The vehicle's type id.

Definition at line 299 of file SUMOVehicleParameter.h.

Referenced by MSInsertionControl::checkFlows(), MSRouteHandler::closeFlow(), RORDLoader_SUMOBase::closeVehicle(), MSRouteHandler::closeVehicle(), and RORDGenerator_ODAmounts::myEndFlowAmountDef().

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

SUMOVehicleParameter Class Reference

Data Structures

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation