Battery device for electric vehicles. More...

#include <MSDevice_Battery.h>

Inheritance diagram for MSDevice_Battery:

Collaboration diagram for MSDevice_Battery:

Public Member Functions
void	addTo (const StoringVisitor &cont) const
	Adds this object to the given container. More...

const std::string	deviceName () const
	return the name for this type of device More...

virtual void	generateOutput (OutputDevice *) const
	Called on vehicle deletion to extend tripinfo and other outputs. More...

double	getActualBatteryCapacity () const
	Get the actual vehicle's Battery Capacity in Wh. More...

SUMOTime	getChargingStartTime () const
	Get charging start time. More...

std::string	getChargingStationID () const
	Get current Charging Station ID. More...

double	getConsum () const
	Get consum. More...

const std::string &	getDescription () const

double	getEnergyCharged () const
	Get charged energy. More...

SUMOVehicle &	getHolder () const
	Returns the vehicle that holds this device. More...

const std::string &	getID () const
	Returns the id. More...

const MSLane *	getLane () const
	Returns the lane the reminder works on. More...

double	getMaximumBatteryCapacity () const
	Get the total vehicle's Battery Capacity in Wh. More...

double	getMaximumPower () const
	Get the maximum power when accelerating. More...

SUMOVehicle::NumericalID	getNumericalID () const

std::string	getParameter (const std::string &key) const
	try to retrieve the given parameter from this device. Throw exception for unsupported key More...

double	getStoppingThreshold () const
	Get stopping threshold. More...

double	getTotalConsumption () const
	Get total consumption. More...

double	getTotalRegenerated () const
	Get total regenerated. More...

int	getVehicleStopped () const
	Get number of timestep that vehicle is stopped. More...

void	increaseChargingStartTime ()
	Increase Charging Start time. More...

void	increaseVehicleStoppedTimer ()
	Increase myVehicleStopped. More...

bool	isChargingInTransit () const
	Get true if Vehicle it's charging, false if not. More...

bool	isChargingStopped () const
	Get true if Vehicle is charging, false if not. More...

virtual bool	isParkingRerouter () const

void	loadState (const SUMOSAXAttributes &attrs)
	Loads the state of the device from the given description. More...

virtual void	notifyMoveInternal (const SUMOTrafficObject &veh, const double frontOnLane, const double timeOnLane, const double meanSpeedFrontOnLane, const double meanSpeedVehicleOnLane, const double travelledDistanceFrontOnLane, const double travelledDistanceVehicleOnLane, const double meanLengthOnLane)
	Internal notification about the vehicle moves. More...

void	notifyParking ()
	called to update state for parking vehicles More...

void	resetChargingStartTime ()
	Reset charging start time. More...

void	resetVehicleStoppedTimer ()
	Reset myVehicleStopped. More...

void	saveState (OutputDevice &out) const
	Saves the state of the device. More...

void	setActualBatteryCapacity (const double actualBatteryCapacity)
	Set actual vehicle's Battery Capacity in kWh. More...

void	setDescription (const std::string &description)

virtual void	setID (const std::string &newID)
	resets the id More...

void	setMaximumBatteryCapacity (const double maximumBatteryCapacity)
	Set total vehicle's Battery Capacity in kWh. More...

void	setParameter (const std::string &key, const std::string &value)
	try to set the given parameter for this device. Throw exception for unsupported key More...

void	setStoppingThreshold (const double stoppingThreshold)
	Set vehicle's stopping threshold. More...

	~MSDevice_Battery ()
	Destructor. More...

Methods called on vehicle movement / state change, overwriting MSDevice
bool	notifyMove (SUMOTrafficObject &veh, double oldPos, double newPos, double newSpeed)
	Checks for waiting steps when the vehicle moves. More...

Interface methods, to be derived by subclasses
virtual bool	notifyEnter (SUMOTrafficObject &veh, Notification reason, const MSLane *enteredLane)
	Checks whether the reminder is activated by a vehicle entering the lane. More...

virtual bool	notifyIdle (SUMOTrafficObject &veh)
	Computes idling emission values and adds them to the emission sums. More...

virtual void	notifyStopEnded ()
	called to update state for stopped vehicles More...

virtual bool	notifyLeave (SUMOTrafficObject &veh, double lastPos, Notification reason, const MSLane *enteredLane=0)
	Called if the vehicle leaves the reminder's lane. More...

void	updateDetector (SUMOTrafficObject &veh, double entryPos, double leavePos, SUMOTime entryTime, SUMOTime currentTime, SUMOTime leaveTime, bool cleanUp)

Static Public Member Functions
static void	buildTransportableDevices (MSTransportable &p, std::vector< MSTransportableDevice * > &into)
	Build devices for the given person, if needed. More...

static void	buildVehicleDevices (SUMOVehicle &v, std::vector< MSVehicleDevice * > &into)
	Build devices for the given vehicle, if needed. More...

static void	buildVehicleDevices (SUMOVehicle &v, std::vector< MSVehicleDevice * > &into, MSDevice_StationFinder *sf)
	Build devices for the given vehicle, if needed. More...

static bool	checkOptions (OptionsCont &oc)
	check device-specific options More...

static void	cleanupAll ()
	perform cleanup for all devices More...

static SumoRNG *	getEquipmentRNG ()

template<class T >
static std::string	getIDSecure (const T *obj, const std::string &fallBack="NULL")
	get an identifier for Named-like object which may be Null More...

static void	insertOptions (OptionsCont &oc)
	Inserts MSDevice_Example-options. More...

Helper methods for parsing parameters
static std::string	getStringParam (const SUMOVehicle &v, const OptionsCont &oc, const std::string &paramName, const std::string &deflt, bool required=false)

static double	getFloatParam (const SUMOVehicle &v, const OptionsCont &oc, const std::string &paramName, const double deflt, bool required=false)

static bool	getBoolParam (const SUMOVehicle &v, const OptionsCont &oc, const std::string &paramName, const bool deflt, bool required=false)

static SUMOTime	getTimeParam (const SUMOVehicle &v, const OptionsCont &oc, const std::string &paramName, const SUMOTime deflt, bool required=false)

Protected Member Functions
void	removeFromVehicleUpdateValues (SUMOTrafficObject &veh)

Static Protected Member Functions
static double	readParameterValue (SUMOVehicle &v, const SumoXMLAttr &attr, const std::string &paramName, double defaultVal)
	Read device parameters from input. More...

Helper methods for device assignment
static void	insertDefaultAssignmentOptions (const std::string &deviceName, const std::string &optionsTopic, OptionsCont &oc, const bool isPerson=false)
	Adds common command options that allow to assign devices to vehicles. More...

template<class DEVICEHOLDER >
static bool	equippedByDefaultAssignmentOptions (const OptionsCont &oc, const std::string &deviceName, DEVICEHOLDER &v, bool outputOptionSet, const bool isPerson=false)
	Determines whether a vehicle should get a certain device. More...

Protected Attributes
MSChargingStation *	myActChargingStation
	Parameter, Pointer to current charging station in which vehicle is placed (by default is NULL) More...

double	myActualBatteryCapacity
	Parameter, The actual vehicles's Battery Capacity in Wh, [myActualBatteryCapacity <= myMaximumBatteryCapacity]. More...

bool	myChargingInTransit
	Parameter, Flag: Vehicles it's charging in transit (by default is false) More...

SUMOTime	myChargingStartTime
	Parameter, Moment, wich the vehicle has beging to charging. More...

bool	myChargingStopped
	Parameter, Flag: Vehicles it's charging stopped (by default is false) More...

double	myConsum
	Parameter, Vehicle consum during a time step (by default is 0.) More...

std::string	myDescription
	a description of this moveReminder More...

double	myEnergyCharged
	Parameter, Energy charged in each timestep. More...

SUMOVehicle &	myHolder
	The vehicle that stores the device. More...

std::string	myID
	The name of the object. More...

MSLane *const	myLane
	Lane on which the reminder works. More...

double	myLastAngle
	Parameter, Vehicle's last angle. More...

double	myMaximumBatteryCapacity
	Parameter, The total vehicles's Battery Capacity in Wh, [myMaximumBatteryCapacity >= 0]. More...

MSChargingStation *	myPreviousNeighbouringChargingStation
	Parameter, Pointer to charging station neighbouring with myActChargingStation in which vehicle was placed previously (by default is NULL), i.e. auxiliar pointer for disabling charging vehicle from previous (not current) ChargingStation (if there is no gap between two different chargingStations) More...

double	myStoppingThreshold
	Parameter, stopping vehicle threshold [myStoppingThreshold >= 0]. More...

double	myTotalConsumption
	Parameter, total vehicle energy consumption. More...

double	myTotalRegenerated
	Parameter, total vehicle energy regeneration. More...

bool	myTrackFuel
	whether to track fuel consumption instead of electricity More...

int	myVehicleStopped
	Parameter, How many timestep the vehicle is stopped. More...

Private Member Functions
	MSDevice_Battery (const MSDevice_Battery &)
	Invalidated copy constructor. More...

	MSDevice_Battery (SUMOVehicle &holder, const std::string &id, const double actualBatteryCapacity, const double maximumBatteryCapacity, const double stoppingThreshold)
	Constructor. More...

MSDevice_Battery &	operator= (const MSDevice_Battery &)
	Invalidated assignment operator. More...

Private Attributes
std::map< SUMOTrafficObject *, std::pair< SUMOTime, double > >	myLastVehicleUpdateValues

Static Private Attributes
static SumoRNG	myEquipmentRNG
	A random number generator used to choose from vtype/route distributions and computing the speed factors. More...

static std::map< std::string, std::set< std::string > >	myExplicitIDs
	vehicles which explicitly carry a device, sorted by device, first More...

Detailed Description

Battery device for electric vehicles.

Definition at line 46 of file MSDevice_Battery.h.

Member Enumeration Documentation

◆ Notification

enum MSMoveReminder::Notification

inherited

Definition of a vehicle state.

Enumerator
NOTIFICATION_DEPARTED	The vehicle has departed (was inserted into the network)
NOTIFICATION_JUNCTION	The vehicle arrived at a junction.
NOTIFICATION_SEGMENT	The vehicle changes the segment (meso only)
NOTIFICATION_LANE_CHANGE	The vehicle changes lanes (micro only)
NOTIFICATION_LOAD_STATE	The vehicle has been loaded from a state file.
NOTIFICATION_TELEPORT	The vehicle is being teleported.
NOTIFICATION_TELEPORT_CONTINUATION	The vehicle continues being teleported past an edge.
NOTIFICATION_PARKING	The vehicle starts or ends parking.
NOTIFICATION_PARKING_REROUTE	The vehicle needs another parking area.
NOTIFICATION_ARRIVED	The vehicle arrived at its destination (is deleted)
NOTIFICATION_TELEPORT_ARRIVED	The vehicle was teleported out of the net.
NOTIFICATION_VAPORIZED_CALIBRATOR	The vehicle got removed by a calibrator.
NOTIFICATION_VAPORIZED_COLLISION	The vehicle got removed by a collision.
NOTIFICATION_VAPORIZED_TRACI	The vehicle got removed via TraCI.
NOTIFICATION_VAPORIZED_GUI	The vehicle got removed via the GUI.
NOTIFICATION_VAPORIZED_VAPORIZER	The vehicle got vaporized with a vaporizer.
NOTIFICATION_VAPORIZED_BREAKDOWN	The vehicle got removed via stationfinder device.

Definition at line 89 of file MSMoveReminder.h.

Constructor & Destructor Documentation

◆ ~MSDevice_Battery()

MSDevice_Battery::~MSDevice_Battery ( )

Destructor.

Definition at line 146 of file MSDevice_Battery.cpp.

◆ MSDevice_Battery() [1/2]

MSDevice_Battery::MSDevice_Battery	(	SUMOVehicle &	holder,
		const std::string &	id,
		const double	actualBatteryCapacity,
		const double	maximumBatteryCapacity,
		const double	stoppingThreshold
	)

private

Constructor.

Parameters

[in]	holder	The vehicle that holds this device
[in]	id	The ID of the device
[in]	period	The period with which a new route shall be searched
[in]	preInsertionPeriod	The route search period before insertion

Definition at line 99 of file MSDevice_Battery.cpp.

References OptionsCont::getBool(), MSVehicleType::getEmissionClass(), PollutantsInterface::getFuel(), Named::getID(), OptionsCont::getOptions(), MSVehicleType::getParameter(), SUMOTrafficObject::getVehicleType(), myActualBatteryCapacity, myMaximumBatteryCapacity, myStoppingThreshold, myTrackFuel, SUMO_ATTR_ACTUALBATTERYCAPACITY, SUMO_ATTR_MAXIMUMBATTERYCAPACITY, SUMO_ATTR_STOPPINGTHRESHOLD, TL, toString(), VTYPEPARS_EMISSIONCLASS_SET, SUMOVTypeParameter::wasSet(), and WRITE_WARNINGF.

Referenced by buildVehicleDevices().

Here is the caller graph for this function:

◆ MSDevice_Battery() [2/2]

MSDevice_Battery::MSDevice_Battery ( const MSDevice_Battery & )

private

Invalidated copy constructor.

Member Function Documentation

◆ addTo()

void Named::addTo ( const StoringVisitor & cont ) const

inlineinherited

Adds this object to the given container.

Parameters

[in,filled] cont The container to add this item to

Definition at line 118 of file Named.h.

References Named::StoringVisitor::add().

◆ buildTransportableDevices()

void MSDevice::buildTransportableDevices	(	MSTransportable &	p,
		std::vector< MSTransportableDevice * > &	into
	)

staticinherited

Build devices for the given person, if needed.

Parameters

[in]	p	The person for which a device may be built
	[filled]	into The vector to store the built device in

Definition at line 137 of file MSDevice.cpp.

References MSTransportableDevice_Routing::buildDevices(), MSTransportableDevice_BTreceiver::buildDevices(), MSTransportableDevice_BTsender::buildDevices(), MSTransportableDevice_FCD::buildDevices(), and MSTransportableDevice_FCDReplay::buildDevices().

Referenced by MSTransportable::MSTransportable().

Here is the caller graph for this function:

◆ buildVehicleDevices() [1/2]

void MSDevice::buildVehicleDevices	(	SUMOVehicle &	v,
		std::vector< MSVehicleDevice * > &	into
	)

staticinherited

Build devices for the given vehicle, if needed.

Parameters

[in]	v	The vehicle for which a device may be built
	[filled]	into The vector to store the built device in

Definition at line 112 of file MSDevice.cpp.

Referenced by MSBaseVehicle::initDevices().

Here is the caller graph for this function:

◆ buildVehicleDevices() [2/2]

void MSDevice_Battery::buildVehicleDevices	(	SUMOVehicle &	v,
		std::vector< MSVehicleDevice * > &	into,
		MSDevice_StationFinder *	sf
	)

static

Build devices for the given vehicle, if needed.

The options are read and evaluated whether a example-device shall be built for the given vehicle.

The built device is stored in the given vector.

Parameters

[in]	v	The vehicle for which a device may be built
	[filled]	into The vector to store the built device in

Definition at line 59 of file MSDevice_Battery.cpp.

References DEFAULT_CHARGE_RATIO, DEFAULT_MAX_CAPACITY, MSDevice::equippedByDefaultAssignmentOptions(), Named::getID(), OptionsCont::getOptions(), MSDevice_Battery(), readParameterValue(), MSDevice_StationFinder::setBattery(), SUMO_ATTR_ACTUALBATTERYCAPACITY, SUMO_ATTR_MAXIMUMBATTERYCAPACITY, and SUMO_ATTR_STOPPINGTHRESHOLD.

Referenced by MSDevice::buildVehicleDevices().

Here is the caller graph for this function:

◆ checkOptions()

bool MSDevice::checkOptions ( OptionsCont & oc )

staticinherited

check device-specific options

Parameters

[filled] oc The options container with the user-defined options

Definition at line 104 of file MSDevice.cpp.

References MSDevice_Routing::checkOptions().

Referenced by MSFrame::checkOptions().

Here is the caller graph for this function:

◆ cleanupAll()

void MSDevice::cleanupAll ( )

staticinherited

perform cleanup for all devices

Definition at line 147 of file MSDevice.cpp.

References MSDevice_FCD::cleanup(), MSDevice_Taxi::cleanup(), MSDevice_Tripinfo::cleanup(), and MSRoutingEngine::cleanup().

Referenced by MSNet::clearAll().

Here is the caller graph for this function:

◆ deviceName()

const std::string MSDevice_Battery::deviceName ( ) const

inlinevirtual

return the name for this type of device

Implements MSDevice.

Definition at line 84 of file MSDevice_Battery.h.

Referenced by getParameter(), and setParameter().

Here is the caller graph for this function:

◆ equippedByDefaultAssignmentOptions()

template<class DEVICEHOLDER >

bool MSDevice::equippedByDefaultAssignmentOptions	(	const OptionsCont &	oc,
		const std::string &	deviceName,
		DEVICEHOLDER &	v,
		bool	outputOptionSet,
		const bool	isPerson = `false`
	)

staticprotectedinherited

Determines whether a vehicle should get a certain device.

Parameters

[in]	oc	The options container to get the information about assignment from
[in]	deviceName	The name of the device type
[in]	v	The vehicle to determine whether it shall be equipped or not

Definition at line 203 of file MSDevice.h.

References MSDevice::deviceName(), OptionsCont::exists(), OptionsCont::getBool(), OptionsCont::getFloat(), MSNet::getInstance(), OptionsCont::getOptions(), MSVehicleControl::getQuota(), OptionsCont::getStringVector(), MSNet::getVehicleControl(), OptionsCont::isSet(), MSDevice::myEquipmentRNG, MSDevice::myExplicitIDs, RandHelper::rand(), StringUtils::toBool(), and StringUtils::toDouble().

Here is the caller graph for this function:

◆ generateOutput()

virtual void MSDevice::generateOutput ( OutputDevice * ) const

inlinevirtualinherited

Called on vehicle deletion to extend tripinfo and other outputs.

The device may write some statistics into the tripinfo output and may choose to finalize its own outputs. It is assumed that the information written to tripinfoOut is a valid xml-snipplet, which will be embedded within the vehicle's tripinfo information.

The device should use the openTag / closeTag methods of the OutputDevice for correct indentation.

Exceptions

IOError not yet implemented

Reimplemented in MSDevice_Vehroutes, MSDevice_Tripinfo, MSDevice_Taxi, MSDevice_StationFinder, MSDevice_SSM, MSDevice_GLOSA, MSDevice_Example, MSDevice_Emissions, MSDevice_ElecHybrid, and MSDevice_Bluelight.

Definition at line 124 of file MSDevice.h.

◆ getActualBatteryCapacity()

double MSDevice_Battery::getActualBatteryCapacity ( ) const

Get the actual vehicle's Battery Capacity in Wh.

Definition at line 393 of file MSDevice_Battery.cpp.

References myActualBatteryCapacity.

Referenced by MSChargingStation::addChargeValueForOutput(), MSDevice_StationFinder::alreadyPlannedCharging(), MSDevice_StationFinder::estimateConsumption(), getParameter(), MSBaseVehicle::getRelativeStateOfCharge(), MSBaseVehicle::getStateOfCharge(), notifyMove(), MSDevice_StationFinder::notifyMove(), MSDevice_StationFinder::rerouteToChargingStation(), and MSBatteryExport::write().

Here is the caller graph for this function:

◆ getBoolParam()

bool MSDevice::getBoolParam	(	const SUMOVehicle &	v,
		const OptionsCont &	oc,
		const std::string &	paramName,
		const bool	deflt,
		bool	required = `false`
	)

staticinherited

Definition at line 218 of file MSDevice.cpp.

References Named::getID(), MSDevice::getStringParam(), TL, StringUtils::toBool(), toString(), and WRITE_ERRORF.

Referenced by MSDevice_ToC::buildVehicleDevices().

Here is the caller graph for this function:

◆ getChargingStartTime()

SUMOTime MSDevice_Battery::getChargingStartTime ( ) const

Get charging start time.

Definition at line 434 of file MSDevice_Battery.cpp.

References myChargingStartTime.

Referenced by MSChargingStation::addChargeValueForOutput(), and notifyMove().

Here is the caller graph for this function:

◆ getChargingStationID()

std::string MSDevice_Battery::getChargingStationID ( ) const

Get current Charging Station ID.

Definition at line 440 of file MSDevice_Battery.cpp.

References Named::getID(), and myActChargingStation.

Referenced by getParameter(), MSDevice_StationFinder::notifyMove(), saveState(), and MSBatteryExport::write().

Here is the caller graph for this function:

◆ getConsum()

double MSDevice_Battery::getConsum ( ) const

Get consum.

Definition at line 405 of file MSDevice_Battery.cpp.

References myConsum.

Referenced by getParameter(), and MSBatteryExport::write().

Here is the caller graph for this function:

◆ getDescription()

const std::string& MSMoveReminder::getDescription ( ) const

inlineinherited

Definition at line 261 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

◆ getEnergyCharged()

double MSDevice_Battery::getEnergyCharged ( ) const

Get charged energy.

Definition at line 449 of file MSDevice_Battery.cpp.

References myEnergyCharged.

Referenced by MSBaseVehicle::getChargedEnergy(), getParameter(), MSDevice_StationFinder::notifyMove(), and MSBatteryExport::write().

Here is the caller graph for this function:

◆ getEquipmentRNG()

static SumoRNG* MSDevice::getEquipmentRNG ( )

inlinestaticinherited

Definition at line 89 of file MSDevice.h.

References MSDevice::myEquipmentRNG.

Referenced by NLBuilder::initRandomness(), MSStateHandler::myStartElement(), and MSStateHandler::saveRNGs().

Here is the caller graph for this function:

◆ getFloatParam()

double MSDevice::getFloatParam	(	const SUMOVehicle &	v,
		const OptionsCont &	oc,
		const std::string &	paramName,
		const double	deflt,
		bool	required = `false`
	)

staticinherited

Definition at line 206 of file MSDevice.cpp.

References Named::getID(), MSDevice::getStringParam(), Distribution_Parameterized::sample(), TL, toString(), and WRITE_ERRORF.

Here is the caller graph for this function:

◆ getHolder()

SUMOVehicle& MSVehicleDevice::getHolder ( ) const

inlineinherited

Returns the vehicle that holds this device.

Returns: The vehicle that holds this device

Definition at line 72 of file MSVehicleDevice.h.

References MSVehicleDevice::myHolder.

Referenced by MSChargingStation::addChargeValueForOutput(), MSOverheadWire::addChargeValueForOutput(), MSDispatch::computeDetourTime(), MSDispatch::computePickupTime(), MSDispatch_Greedy::dispatch(), MSDispatch_GreedyShared::dispatch(), MSDispatch_RouteExtension::dispatch(), MSIdling_Stop::idle(), MSIdling_RandomCircling::idle(), MSIdling_TaxiStand::idle(), and MSDispatch::remainingCapacity().

Here is the caller graph for this function:

◆ getID()

const std::string& Named::getID ( ) const

inlineinherited

Returns the id.

Returns: The stored id

Definition at line 74 of file Named.h.

References Named::myID.

◆ getIDSecure()

template<class T >

static std::string Named::getIDSecure	(	const T *	obj,
		const std::string &	fallBack = `"NULL"`
	)

inlinestaticinherited

get an identifier for Named-like object which may be Null

Definition at line 67 of file Named.h.

Referenced by MSLCM_LC2013::_wantsChange(), MSLCM_SL2015::_wantsChangeSublane(), MSLaneChanger::avoidDeadlock(), MSLaneChanger::changeOpposite(), MSLaneChanger::checkChangeOpposite(), MSRailSignal::DriveWay::checkFlanks(), MSVehicle::checkReversal(), MSVehicle::checkRewindLinkLanes(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), NBOwnTLDef::computeLogicAndConts(), MSRailSignal::DriveWay::conflictLaneOccupied(), NBPTLineCont::constructRoute(), MSLaneChanger::continueChange(), MSLane::detectCollisions(), MSVehicle::enterLaneAtLaneChange(), MSVehicle::executeMove(), NBRailwayTopologyAnalyzer::extendDirectionPriority(), MSRailSignal::DriveWay::findProtection(), NBPTLineCont::findWay(), MSCFModel_CACC::followSpeed(), MSCFModel_W99::followSpeed(), MSStopOut::generateOutputForUnfinished(), MSVehicle::getBackPositionOnLane(), NBOwnTLDef::getBestCombination(), NBOwnTLDef::getBestPair(), MSVehicle::getCenterOnEdge(), MSLaneChanger::getColumnleader(), NBEdge::Connection::getDescription(), MSLane::getFollowersOnConsecutive(), GUIVehicle::getLaneID(), LIBSUMO_NAMESPACE::Person::getLaneID(), MSVehicle::getLatOffset(), MSLane::getLeaderOnConsecutive(), MSLaneChanger::getOncomingOppositeVehicle(), MSLaneChanger::getRealLeader(), GUIVehicle::getShadowLaneID(), GUIVehicle::getTargetLaneID(), MSDevice_SSM::getVehiclesOnJunction(), NBEdgeCont::guessRoundabouts(), MSCFModel_IDM::insertionFollowSpeed(), MSLane::isInsertionSuccess(), MESegment::isOpen(), joinNamedToString(), joinNamedToStringSorting(), MSPModel_Striping::PState::moveToNextLane(), LIBSUMO_NAMESPACE::Person::moveToXY(), LIBSUMO_NAMESPACE::Vehicle::moveToXY(), MSPModel_Striping::PState::moveToXY(), libsumo::Helper::moveToXYMap(), libsumo::Helper::moveToXYMap_matchingRoutePosition(), MSDevice_Bluelight::notifyEnter(), MSDevice_Bluelight::notifyLeave(), MSVehicle::Influencer::postProcessRemoteControl(), MSVehicle::processNextStop(), MSBaseVehicle::replaceRoute(), MSBaseVehicle::reroute(), MSTriggeredRerouter::rerouteParkingArea(), MSRailSignal::DriveWay::reserve(), MSLaneChanger::resolveDeadlock(), MSLCM_LC2013::slowDownForBlocked(), MSLCM_SL2015::slowDownForBlocked(), MSLaneChangerSublane::startChangeSublane(), MSLeaderInfo::toString(), MSLeaderDistanceInfo::toString(), MSCriticalFollowerDistanceInfo::toString(), toString(), MSTriggeredRerouter::triggerRouting(), MSVehicle::updateBestLanes(), MSLCHelper::updateBlockerLength(), MSAbstractLaneChangeModel::updateShadowLane(), MSPModel_Striping::PState::walk(), and MSLaneChanger::yieldToDeadlockOncoming().

◆ getLane()

const MSLane* MSMoveReminder::getLane ( ) const

inlineinherited

Returns the lane the reminder works on.

Returns: The lane the reminder is anchored on.

Definition at line 83 of file MSMoveReminder.h.

References MSMoveReminder::myLane.

Referenced by LIBSUMO_NAMESPACE::InductionLoop::getTree(), GUIInductLoop::MyWrapper::MyWrapper(), GUIInstantInductLoop::MyWrapper::MyWrapper(), MSDevice_Tripinfo::notifyEnter(), MSDevice_Tripinfo::notifyLeave(), LIBSUMO_NAMESPACE::InductionLoop::storeShape(), and MSMeanData::writeEdge().

Here is the caller graph for this function:

◆ getMaximumBatteryCapacity()

double MSDevice_Battery::getMaximumBatteryCapacity ( ) const

Get the total vehicle's Battery Capacity in Wh.

Definition at line 399 of file MSDevice_Battery.cpp.

References myMaximumBatteryCapacity.

Referenced by MSChargingStation::addChargeValueForOutput(), MSDevice_StationFinder::estimateConsumption(), getParameter(), MSBaseVehicle::getRelativeStateOfCharge(), notifyMove(), MSDevice_StationFinder::notifyMove(), MSDevice_StationFinder::rerouteToChargingStation(), MSDevice_StationFinder::teleportToChargingStation(), and MSBatteryExport::write().

Here is the caller graph for this function:

◆ getMaximumPower()

double MSDevice_Battery::getMaximumPower ( ) const

Get the maximum power when accelerating.

◆ getNumericalID()

SUMOVehicle::NumericalID MSVehicleDevice::getNumericalID ( ) const

inlineinherited

Definition at line 76 of file MSVehicleDevice.h.

References SUMOTrafficObject::getNumericalID(), and MSVehicleDevice::myHolder.

◆ getParameter()

std::string MSDevice_Battery::getParameter ( const std::string & key ) const

virtual

try to retrieve the given parameter from this device. Throw exception for unsupported key

Reimplemented from MSDevice.

Definition at line 467 of file MSDevice_Battery.cpp.

References deviceName(), getActualBatteryCapacity(), getChargingStationID(), getConsum(), EnergyParams::getDouble(), SUMOVehicle::getEmissionParameters(), getEnergyCharged(), getMaximumBatteryCapacity(), getTotalConsumption(), getTotalRegenerated(), MSVehicleDevice::myHolder, SUMO_ATTR_ACTUALBATTERYCAPACITY, SUMO_ATTR_CHARGINGSTATIONID, SUMO_ATTR_ENERGYCHARGED, SUMO_ATTR_ENERGYCONSUMED, SUMO_ATTR_MASS, SUMO_ATTR_MAXIMUMBATTERYCAPACITY, SUMO_ATTR_TOTALENERGYCONSUMED, SUMO_ATTR_TOTALENERGYREGENERATED, SUMO_ATTR_VEHICLEMASS, TL, toString(), and WRITE_WARNING.

◆ getStoppingThreshold()

double MSDevice_Battery::getStoppingThreshold ( ) const

Get stopping threshold.

Definition at line 461 of file MSDevice_Battery.cpp.

References myStoppingThreshold.

Referenced by MSChargingStation::addChargeValueForOutput().

Here is the caller graph for this function:

◆ getStringParam()

std::string MSDevice::getStringParam	(	const SUMOVehicle &	v,
		const OptionsCont &	oc,
		const std::string &	paramName,
		const std::string &	deflt,
		bool	required = `false`
	)

staticinherited

Definition at line 182 of file MSDevice.cpp.

References OptionsCont::exists(), Named::getID(), MSVehicleType::getParameter(), SUMOTrafficObject::getParameter(), Parameterised::getParameter(), OptionsCont::getValueString(), SUMOTrafficObject::getVehicleType(), Parameterised::hasParameter(), and OptionsCont::isSet().

Referenced by MSDevice_ToC::buildVehicleDevices(), MSDevice::getBoolParam(), MSDevice::getFloatParam(), MSDevice_Taxi::getParameter(), MSDevice::getTimeParam(), MSDevice_StationFinder::initRescueAction(), MSBaseVehicle::initTransientModelParams(), MSDevice_Taxi::MSDevice_Taxi(), and MSDevice_Taxi::prepareStop().

Here is the caller graph for this function:

◆ getTimeParam()

SUMOTime MSDevice::getTimeParam	(	const SUMOVehicle &	v,
		const OptionsCont &	oc,
		const std::string &	paramName,
		const SUMOTime	deflt,
		bool	required = `false`
	)

staticinherited

Definition at line 230 of file MSDevice.cpp.

References Named::getID(), MSDevice::getStringParam(), string2time(), TL, toString(), and WRITE_ERRORF.

Referenced by MSDevice_Routing::buildVehicleDevices(), and MSDevice_StationFinder::MSDevice_StationFinder().

Here is the caller graph for this function:

◆ getTotalConsumption()

double MSDevice_Battery::getTotalConsumption ( ) const

Get total consumption.

Definition at line 410 of file MSDevice_Battery.cpp.

References myTotalConsumption.

Referenced by MSDevice_StationFinder::estimateConsumption(), getParameter(), and MSBatteryExport::write().

Here is the caller graph for this function:

◆ getTotalRegenerated()

double MSDevice_Battery::getTotalRegenerated ( ) const

Get total regenerated.

Definition at line 416 of file MSDevice_Battery.cpp.

References myTotalRegenerated.

Referenced by getParameter(), and MSBatteryExport::write().

Here is the caller graph for this function:

◆ getVehicleStopped()

int MSDevice_Battery::getVehicleStopped ( ) const

Get number of timestep that vehicle is stopped.

Definition at line 455 of file MSDevice_Battery.cpp.

References myVehicleStopped.

Referenced by MSBatteryExport::write().

Here is the caller graph for this function:

◆ increaseChargingStartTime()

void MSDevice_Battery::increaseChargingStartTime ( )

Increase Charging Start time.

Definition at line 375 of file MSDevice_Battery.cpp.

References DELTA_T, and myChargingStartTime.

Referenced by notifyMove().

Here is the caller graph for this function:

◆ increaseVehicleStoppedTimer()

void MSDevice_Battery::increaseVehicleStoppedTimer ( )

Increase myVehicleStopped.

Definition at line 387 of file MSDevice_Battery.cpp.

References myVehicleStopped.

Referenced by notifyMove().

Here is the caller graph for this function:

◆ insertDefaultAssignmentOptions()

void MSDevice::insertDefaultAssignmentOptions	(	const std::string &	deviceName,
		const std::string &	optionsTopic,
		OptionsCont &	oc,
		const bool	isPerson = `false`
	)

staticprotectedinherited

Adds common command options that allow to assign devices to vehicles.

Parameters

[in]	deviceName	The name of the device type
[in]	optionsTopic	The options topic into which the options shall be added
	[filled]	oc The options container to add the options to

Definition at line 155 of file MSDevice.cpp.

References OptionsCont::addDescription(), OptionsCont::addSynonyme(), MSDevice::deviceName(), and OptionsCont::doRegister().

Here is the caller graph for this function:

◆ insertOptions()

void MSDevice_Battery::insertOptions ( OptionsCont & oc )

static

Inserts MSDevice_Example-options.

Parameters

[filled] oc The options container to add the options to

Definition at line 50 of file MSDevice_Battery.cpp.

References OptionsCont::addDescription(), OptionsCont::doRegister(), MSDevice::insertDefaultAssignmentOptions(), and TL.

Referenced by MSDevice::insertOptions().

Here is the caller graph for this function:

◆ isChargingInTransit()

bool MSDevice_Battery::isChargingInTransit ( ) const

Get true if Vehicle it's charging, false if not.

Definition at line 428 of file MSDevice_Battery.cpp.

References myChargingInTransit.

Referenced by MSBatteryExport::write().

Here is the caller graph for this function:

◆ isChargingStopped()

bool MSDevice_Battery::isChargingStopped ( ) const

Get true if Vehicle is charging, false if not.

Definition at line 422 of file MSDevice_Battery.cpp.

References myChargingStopped.

Referenced by MSBatteryExport::write().

Here is the caller graph for this function:

◆ isParkingRerouter()

virtual bool MSMoveReminder::isParkingRerouter ( ) const

inlinevirtualinherited

Reimplemented in MSTriggeredRerouter.

Definition at line 266 of file MSMoveReminder.h.

◆ loadState()

void MSDevice_Battery::loadState ( const SUMOSAXAttributes & attrs )

virtual

Loads the state of the device from the given description.

Parameters

[in] attrs XML attributes describing the current state

Reimplemented from MSDevice.

Definition at line 312 of file MSDevice_Battery.cpp.

References MSNet::getInstance(), MSNet::getStoppingPlace(), SUMOSAXAttributes::getString(), myActChargingStation, myActualBatteryCapacity, myChargingInTransit, myChargingStartTime, myChargingStopped, myEnergyCharged, myLastAngle, myPreviousNeighbouringChargingStation, myTotalConsumption, myTotalRegenerated, myVehicleStopped, SUMO_ATTR_STATE, and SUMO_TAG_CHARGING_STATION.

◆ notifyEnter()

virtual bool MSMoveReminder::notifyEnter	(	SUMOTrafficObject &	veh,
		Notification	reason,
		const MSLane *	enteredLane
	)

inlinevirtualinherited

Checks whether the reminder is activated by a vehicle entering the lane.

Lane change means in this case that the vehicle changes to the lane the reminder is placed at.

Parameters

[in]	veh	The entering vehicle.
[in]	reason	how the vehicle enters the lane

Returns: True if vehicle enters the reminder.

See also: Notification

Reimplemented in MSInductLoop, MSVehicleDevice_BTsender, MSVehicleDevice_BTreceiver, MSE3Collector::MSE3LeaveReminder, MSE3Collector::MSE3EntryReminder, MSRouteProbe, MSTriggeredRerouter, MSCalibrator::VehicleRemover, MSRailSignalConstraint_Predecessor::PassedTracker, MSMeanData_Net::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, MSMeanData::MeanDataValueTracker, MSMeanData::MeanDataValues, MSDevice_Vehroutes, MSDevice_Tripinfo, MSDevice_Transportable, MSDevice_Taxi, MSDevice_SSM, MSDevice_Routing, MSDevice_GLOSA, MSDevice_Example, MSTransportableDevice_BTsender, MSTransportableDevice_BTreceiver, MSDevice_Bluelight, MSE2Collector, MSDevice_ElecHybrid, MSTransportableDevice_FCD, and MSDevice_FCD.

Definition at line 142 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyIdle()

virtual bool MSMoveReminder::notifyIdle ( SUMOTrafficObject & veh )

inlinevirtualinherited

Computes idling emission values and adds them to the emission sums.

Idling implied by zero velocity, acceleration and slope

Parameters

[in] veh The vehicle

See also: MSMoveReminder::notifyMove; PollutantsInterface

Reimplemented in MSMeanData_Emissions::MSLaneMeanDataValues, MSDevice_Tripinfo, MSDevice_StationFinder, and MSDevice_Emissions.

Definition at line 183 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyLeave()

virtual bool MSMoveReminder::notifyLeave	(	SUMOTrafficObject &	veh,
		double	lastPos,
		Notification	reason,
		const MSLane *	enteredLane = `0`
	)

inlinevirtualinherited

Called if the vehicle leaves the reminder's lane.

Informs if vehicle leaves reminder lane (due to lane change, removal from the network, or leaving to the next lane). The default is to do nothing.

Parameters

[in]	veh	The leaving vehicle.
[in]	lastPos	Position on the lane when leaving.
[in]	reason	how the vehicle leaves the lane

See also: Notification

Returns: True if the reminder wants to receive further info.

Reimplemented in MSDevice_Vehroutes, MSVehicleDevice_BTsender, MSVehicleDevice_BTreceiver, MSTriggeredRerouter, MSMeanData_Net::MSLaneMeanDataValues, MSMeanData::MeanDataValueTracker, MSMeanData::MeanDataValues, MSInstantInductLoop, MSInductLoop, MSE3Collector::MSE3LeaveReminder, MSE3Collector::MSE3EntryReminder, MSE2Collector, MSDevice_Tripinfo, MSDevice_Transportable, MSDevice_SSM, MSDevice_Example, MSTransportableDevice_BTsender, MSTransportableDevice_BTreceiver, MSDevice_Bluelight, and MSDevice_ElecHybrid.

Definition at line 207 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyMove()

bool MSDevice_Battery::notifyMove	(	SUMOTrafficObject &	veh,
		double	oldPos,
		double	newPos,
		double	newSpeed
	)

virtual

Checks for waiting steps when the vehicle moves.

Parameters

[in]	veh	Vehicle that asks this reminder.
[in]	oldPos	Position before move.
[in]	newPos	Position after move with newSpeed.
[in]	newSpeed	Moving speed.

Returns: True (always).

Reimplemented from MSMoveReminder.

Definition at line 150 of file MSDevice_Battery.cpp.

References MSChargingStation::addChargeValueForOutput(), GeomHelper::angleDiff(), PollutantsInterface::compute(), HelpersEnergy::compute(), PollutantsInterface::ELEC, PollutantsInterface::FUEL, SUMOTrafficObject::getAcceleration(), getActualBatteryCapacity(), SUMOVehicle::getAngle(), MSChargingStation::getChargeDelay(), MSChargingStation::getChargeInTransit(), MSChargingStation::getChargingPower(), getChargingStartTime(), MSChargingStation::getEfficency(), MSVehicleType::getEmissionClass(), SUMOVehicle::getEmissionParameters(), PollutantsInterface::getEnergyHelper(), Named::getID(), MSNet::getInstance(), SUMOTrafficObject::getLane(), getMaximumBatteryCapacity(), MSVehicleType::getParameter(), MSChargingStation::getParkingArea(), SUMOTrafficObject::getPositionOnLane(), SUMOTrafficObject::getSlope(), SUMOTrafficObject::getSpeed(), MSNet::getStoppingPlace(), MSNet::getStoppingPlaceID(), SUMOTrafficObject::getVehicleType(), increaseChargingStartTime(), increaseVehicleStoppedTimer(), SUMOVehicle::isParking(), SUMOTrafficObject::isVehicle(), MIN2(), myActChargingStation, myChargingInTransit, myChargingStopped, myConsum, myEnergyCharged, MSVehicleDevice::myHolder, myLastAngle, myPreviousNeighbouringChargingStation, myStoppingThreshold, myTotalConsumption, myTotalRegenerated, myTrackFuel, resetChargingStartTime(), resetVehicleStoppedTimer(), setActualBatteryCapacity(), MSChargingStation::setChargingVehicle(), EnergyParams::setDouble(), SUMO_ATTR_ANGLE, SUMO_TAG_CHARGING_STATION, TL, TS, VTYPEPARS_EMISSIONCLASS_SET, SUMOVTypeParameter::wasSet(), and WRITE_WARNINGF.

Referenced by notifyParking().

Here is the caller graph for this function:

◆ notifyMoveInternal()

virtual void MSMoveReminder::notifyMoveInternal	(	const SUMOTrafficObject &	veh,
		const double	frontOnLane,
		const double	timeOnLane,
		const double	meanSpeedFrontOnLane,
		const double	meanSpeedVehicleOnLane,
		const double	travelledDistanceFrontOnLane,
		const double	travelledDistanceVehicleOnLane,
		const double	meanLengthOnLane
	)

inlinevirtualinherited

Internal notification about the vehicle moves.

Note: meso uses this though it never calls notifyMove()

Indicator if the reminders is still active for the passed vehicle/parameters. If false, the vehicle will erase this reminder from its reminder-container.

Parameters

[in]	veh	Vehicle that asks this reminder.
[in]	frontOnLane	time the front of the vehicle spent on the lane.
[in]	timeOnLane	time some part of the vehicle spent on the lane.
[in]	meanSpeedFrontOnLane	Average speed for the time that the front is on the lane.
[in]	meanSpeedVehicleOnLane	Average speed for the time that the vehicle is on the lane (with front or back).
[in]	travelledDistanceFrontOnLane	distance travelled while overlapping with the lane.
[in]	travelledDistanceVehicleOnLane	distance travelled while front was on the lane.
[in]	meanLengthOnLane	the average length of the vehicle's part on the lane during the last step (==complete length in meso case)

Reimplemented in MSMeanData_Emissions::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, MSMeanData_Harmonoise::MSLaneMeanDataValues, MSMeanData_Net::MSLaneMeanDataValues, MSMeanData::MeanDataValueTracker, MSDevice_Tripinfo, MSDevice_Transportable, MSDevice_Taxi, MSDevice_StationFinder, MSDevice_Emissions, and MSDevice_ElecHybrid.

Definition at line 239 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

Referenced by MSMoveReminder::updateDetector().

Here is the caller graph for this function:

◆ notifyParking()

void MSDevice_Battery::notifyParking ( )

virtual

called to update state for parking vehicles

Reimplemented from MSMoveReminder.

Definition at line 512 of file MSDevice_Battery.cpp.

References SUMOTrafficObject::getPositionOnLane(), SUMOTrafficObject::getSpeed(), myConsum, MSVehicleDevice::myHolder, and notifyMove().

◆ notifyStopEnded()

virtual void MSMoveReminder::notifyStopEnded ( )

inlinevirtualinherited

called to update state for stopped vehicles

Reimplemented in MSDevice_Vehroutes, and MSDevice_Routing.

Definition at line 192 of file MSMoveReminder.h.

◆ operator=()

MSDevice_Battery& MSDevice_Battery::operator= ( const MSDevice_Battery & )

private

Invalidated assignment operator.

◆ readParameterValue()

double MSDevice_Battery::readParameterValue	(	SUMOVehicle &	v,
		const SumoXMLAttr &	attr,
		const std::string &	paramName,
		double	defaultVal
	)

staticprotected

Read device parameters from input.

Definition at line 82 of file MSDevice_Battery.cpp.

References Parameterised::getDouble(), MSDevice::getFloatParam(), Named::getID(), OptionsCont::getOptions(), MSVehicleType::getParameter(), SUMOTrafficObject::getParameter(), Parameterised::getParameter(), SUMOTrafficObject::getVehicleType(), Parameterised::hasParameter(), TL, StringUtils::toDouble(), toString(), and WRITE_WARNINGF.

Referenced by buildVehicleDevices().

Here is the caller graph for this function:

◆ removeFromVehicleUpdateValues()

void MSMoveReminder::removeFromVehicleUpdateValues ( SUMOTrafficObject & veh )

protectedinherited

Definition at line 89 of file MSMoveReminder.cpp.

References MSMoveReminder::myLastVehicleUpdateValues.

Referenced by MSMoveReminder::updateDetector().

Here is the caller graph for this function:

◆ resetChargingStartTime()

void MSDevice_Battery::resetChargingStartTime ( )

Reset charging start time.

Definition at line 369 of file MSDevice_Battery.cpp.

References myChargingStartTime.

Referenced by notifyMove().

Here is the caller graph for this function:

◆ resetVehicleStoppedTimer()

void MSDevice_Battery::resetVehicleStoppedTimer ( )

Reset myVehicleStopped.

Definition at line 381 of file MSDevice_Battery.cpp.

References myVehicleStopped.

Referenced by notifyMove().

Here is the caller graph for this function:

◆ saveState()

void MSDevice_Battery::saveState ( OutputDevice & out ) const

virtual

Saves the state of the device.

Parameters

[in] out The OutputDevice to write the information into

Reimplemented from MSDevice.

Definition at line 290 of file MSDevice_Battery.cpp.

References OutputDevice::closeTag(), getChargingStationID(), Named::getID(), myActualBatteryCapacity, myChargingInTransit, myChargingStartTime, myChargingStopped, myEnergyCharged, myLastAngle, myPreviousNeighbouringChargingStation, myTotalConsumption, myTotalRegenerated, myVehicleStopped, OutputDevice::openTag(), SUMO_ATTR_ID, SUMO_ATTR_STATE, SUMO_TAG_DEVICE, toString(), and OutputDevice::writeAttr().

◆ setActualBatteryCapacity()

void MSDevice_Battery::setActualBatteryCapacity ( const double actualBatteryCapacity )

Set actual vehicle's Battery Capacity in kWh.

Definition at line 337 of file MSDevice_Battery.cpp.

References myActualBatteryCapacity, and myMaximumBatteryCapacity.

Referenced by notifyMove(), and setParameter().

Here is the caller graph for this function:

◆ setDescription()

void MSMoveReminder::setDescription ( const std::string & description )

inlineinherited

Definition at line 257 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

Referenced by MSMeanData::init(), MEInductLoop::MEInductLoop(), METriggeredCalibrator::METriggeredCalibrator(), and MSCalibrator::MSCalibrator().

Here is the caller graph for this function:

◆ setID()

virtual void Named::setID ( const std::string & newID )

inlinevirtualinherited

resets the id

Parameters

[in] newID The new id of this object

Reimplemented in NBLoadedSUMOTLDef, MSTransportable, and MSBaseVehicle.

Definition at line 82 of file Named.h.

References Named::myID.

Referenced by Distribution_Parameterized::parse(), NBLoadedSUMOTLDef::reconstructLogic(), NBEdgeCont::rename(), NBNodeCont::rename(), GNEJunction::setAttribute(), NBLoadedSUMOTLDef::setID(), and IntermodalNetwork< E, L, N, V >::splitEdge().

Here is the caller graph for this function:

◆ setMaximumBatteryCapacity()

void MSDevice_Battery::setMaximumBatteryCapacity ( const double maximumBatteryCapacity )

Set total vehicle's Battery Capacity in kWh.

Definition at line 349 of file MSDevice_Battery.cpp.

References Named::getID(), myMaximumBatteryCapacity, SUMO_ATTR_MAXIMUMBATTERYCAPACITY, TL, toString(), and WRITE_WARNINGF.

Referenced by setParameter().

Here is the caller graph for this function:

◆ setParameter()

void MSDevice_Battery::setParameter	(	const std::string &	key,
		const std::string &	value
	)

virtual

try to set the given parameter for this device. Throw exception for unsupported key

Reimplemented from MSDevice.

Definition at line 491 of file MSDevice_Battery.cpp.

References deviceName(), SUMOVehicle::getEmissionParameters(), MSVehicleDevice::myHolder, setActualBatteryCapacity(), EnergyParams::setDouble(), setMaximumBatteryCapacity(), SUMO_ATTR_ACTUALBATTERYCAPACITY, SUMO_ATTR_MASS, SUMO_ATTR_MAXIMUMBATTERYCAPACITY, SUMO_ATTR_VEHICLEMASS, TL, StringUtils::toDouble(), toString(), and WRITE_WARNING.

◆ setStoppingThreshold()

void MSDevice_Battery::setStoppingThreshold ( const double stoppingThreshold )

Set vehicle's stopping threshold.

Definition at line 359 of file MSDevice_Battery.cpp.

References Named::getID(), myStoppingThreshold, SUMO_ATTR_STOPPINGTHRESHOLD, TL, toString(), and WRITE_WARNINGF.

◆ updateDetector()

void MSMoveReminder::updateDetector	(	SUMOTrafficObject &	veh,
		double	entryPos,
		double	leavePos,
		SUMOTime	entryTime,
		SUMOTime	currentTime,
		SUMOTime	leaveTime,
		bool	cleanUp
	)

inherited

Definition at line 47 of file MSMoveReminder.cpp.

References MSMoveReminder::myLastVehicleUpdateValues, MSMoveReminder::notifyMoveInternal(), MSMoveReminder::removeFromVehicleUpdateValues(), and STEPS2TIME.

Referenced by MEVehicle::updateDetectorForWriting().

Here is the caller graph for this function:

Field Documentation

◆ myActChargingStation

MSChargingStation* MSDevice_Battery::myActChargingStation

protected

Parameter, Pointer to current charging station in which vehicle is placed (by default is NULL)

Definition at line 216 of file MSDevice_Battery.h.

Referenced by getChargingStationID(), loadState(), and notifyMove().

◆ myActualBatteryCapacity

double MSDevice_Battery::myActualBatteryCapacity

protected

Parameter, The actual vehicles's Battery Capacity in Wh, [myActualBatteryCapacity <= myMaximumBatteryCapacity].

Definition at line 186 of file MSDevice_Battery.h.

Referenced by getActualBatteryCapacity(), loadState(), MSDevice_Battery(), saveState(), and setActualBatteryCapacity().

◆ myChargingInTransit

bool MSDevice_Battery::myChargingInTransit

protected

Parameter, Flag: Vehicles it's charging in transit (by default is false)

Definition at line 201 of file MSDevice_Battery.h.

Referenced by isChargingInTransit(), loadState(), notifyMove(), and saveState().

◆ myChargingStartTime

SUMOTime MSDevice_Battery::myChargingStartTime

protected

Parameter, Moment, wich the vehicle has beging to charging.

Definition at line 204 of file MSDevice_Battery.h.

Referenced by getChargingStartTime(), increaseChargingStartTime(), loadState(), resetChargingStartTime(), and saveState().

◆ myChargingStopped

bool MSDevice_Battery::myChargingStopped

protected

Parameter, Flag: Vehicles it's charging stopped (by default is false)

Definition at line 198 of file MSDevice_Battery.h.

Referenced by isChargingStopped(), loadState(), notifyMove(), and saveState().

◆ myConsum

double MSDevice_Battery::myConsum

protected

Parameter, Vehicle consum during a time step (by default is 0.)

Definition at line 207 of file MSDevice_Battery.h.

Referenced by getConsum(), notifyMove(), and notifyParking().

◆ myDescription

std::string MSMoveReminder::myDescription

protectedinherited

a description of this moveReminder

Definition at line 278 of file MSMoveReminder.h.

Referenced by MSMoveReminder::getDescription(), and MSMoveReminder::setDescription().

◆ myEnergyCharged

double MSDevice_Battery::myEnergyCharged

protected

Parameter, Energy charged in each timestep.

Definition at line 222 of file MSDevice_Battery.h.

Referenced by getEnergyCharged(), loadState(), notifyMove(), and saveState().

◆ myEquipmentRNG

SumoRNG MSDevice::myEquipmentRNG

staticprivateinherited

A random number generator used to choose from vtype/route distributions and computing the speed factors.

Definition at line 189 of file MSDevice.h.

Referenced by MSDevice::equippedByDefaultAssignmentOptions(), and MSDevice::getEquipmentRNG().

◆ myExplicitIDs

std::map< std::string, std::set< std::string > > MSDevice::myExplicitIDs

staticprivateinherited

vehicles which explicitly carry a device, sorted by device, first

Definition at line 186 of file MSDevice.h.

Referenced by MSDevice::equippedByDefaultAssignmentOptions().

◆ myHolder

SUMOVehicle& MSVehicleDevice::myHolder

protectedinherited

The vehicle that stores the device.

Definition at line 90 of file MSVehicleDevice.h.

Referenced by MSDevice_ElecHybrid::acceleration(), MSDevice_Vehroutes::addRoute(), MSDevice_Transportable::addTransportable(), MSDevice_StationFinder::alreadyPlannedCharging(), MSDevice_Transportable::anyLeavingAtStop(), MSDevice_ToC::awarenessRecoveryStep(), MSDevice_Taxi::cancelCurrentCustomers(), MSDevice_ToC::checkDynamicToC(), MSDevice_Taxi::compatibleLine(), MSDevice_ElecHybrid::computeChargedEnergy(), MSDevice_SSM::computeGlobalMeasures(), MSDevice_ElecHybrid::consumption(), MSDevice_Taxi::customerArrived(), MSDevice_ToC::deactivateDeliberateLCs(), MSDevice_Taxi::dispatchShared(), MSDevice_StationFinder::estimateConsumption(), MSDevice_StationFinder::findChargingStation(), MSDevice_SSM::findFoeConflictLane(), MSDevice_StationFinder::freeSpaceAtChargingStation(), MSDevice_Tripinfo::generateOutput(), MSDevice_Tripinfo::generateOutputForUnfinished(), MSVehicleDevice::getHolder(), MSVehicleDevice::getNumericalID(), getParameter(), MSDevice_ElecHybrid::getParameter(), MSDevice_Routing::getParameter(), MSDevice_Taxi::getParameter(), MSDevice_ToC::getParameter(), MSDevice_ElecHybrid::getParameterDouble(), MSDevice_Taxi::getStopLane(), MSDevice_Taxi::hasFuturePickup(), MSDevice_FCDReplay::move(), MSDevice_ToC::MRMExecutionStep(), MSDevice_ElecHybrid::MSDevice_ElecHybrid(), MSDevice_StationFinder::MSDevice_StationFinder(), MSDevice_Taxi::MSDevice_Taxi(), MSDevice_Routing::notifyEnter(), MSDevice_Vehroutes::notifyEnter(), MSDevice_Emissions::notifyIdle(), MSDevice_Tripinfo::notifyLeave(), notifyMove(), MSDevice_Bluelight::notifyMove(), MSDevice_Emissions::notifyMove(), MSDevice_Friction::notifyMove(), MSDevice_StationFinder::notifyMove(), MSDevice_Transportable::notifyMove(), MSDevice_ToC::notifyMove(), MSDevice_Emissions::notifyMoveInternal(), notifyParking(), MSDevice_Vehroutes::notifyStopEnded(), MSVehicleDevice::ComparatorNumericalVehicleIdLess::operator()(), MSDevice_Routing::preInsertionReroute(), MSDevice_Taxi::prepareStop(), MSDevice_Transportable::removeTransportable(), MSDevice_ToC::requestToC(), MSDevice_Routing::reroute(), MSDevice_StationFinder::rerouteToChargingStation(), MSDevice_ToC::resetDeliberateLCs(), MSDevice_Bluelight::resetVehicle(), MSDevice_Tripinfo::saveState(), setParameter(), MSDevice_ElecHybrid::setParameter(), MSDevice_Taxi::setParameter(), MSDevice_ToC::setVehicleColor(), MSDevice_ToC::switchHolderType(), MSDevice_StationFinder::teleportToChargingStation(), MSDevice_ToC::ToCPreparationStep(), MSDevice_Transportable::transferAtSplitOrJoin(), MSDevice_ToC::triggerDownwardToC(), MSDevice_ToC::triggerMRM(), MSDevice_ToC::triggerUpwardToC(), MSDevice_SSM::updateAndWriteOutput(), MSDevice_Taxi::updateMove(), MSDevice_Routing::wrappedRerouteCommandExecute(), MSDevice_ToC::writeOutput(), MSDevice_Vehroutes::writeOutput(), MSDevice_Vehroutes::writeXMLRoute(), MSDevice_Transportable::~MSDevice_Transportable(), and MSDevice_Vehroutes::~MSDevice_Vehroutes().

◆ myID

std::string Named::myID

protectedinherited

The name of the object.

Definition at line 125 of file Named.h.

Referenced by MSE2Collector::addDetectorToLanes(), RODFDetector::buildDestinationDistribution(), NGEdge::buildNBEdge(), NGNode::buildNBNode(), MSSOTLTrafficLightLogic::checkPhases(), NBNode::computeNodeShape(), NEMALogic::constructTimingAndPhaseDefs(), MSE2Collector::detectorUpdate(), GNEPOI::getAttribute(), GNEPoly::getAttribute(), MSLane::getCanonicalPredecessorLane(), MSLane::getCanonicalSuccessorLane(), Named::getID(), NBEdge::getLaneID(), ROEdge::getStoredEffort(), GNEPOI::getSumoBaseObject(), MSLane::getSurroundingVehicles(), ROEdge::getTravelTime(), NBEdge::init(), MSDelayBasedTrafficLightLogic::init(), MSSOTLTrafficLightLogic::init(), NEMALogic::init(), MSLane::isInsertionSuccess(), NBNode::NBNode(), MSE2Collector::notifyEnter(), MSE2Collector::notifyLeave(), MSE2Collector::notifyMove(), MSMeanData::openInterval(), NEMALogic::parseControllerType(), RORouteDef::preComputeCurrentRoute(), NBEdge::reinitNodes(), GNEPOI::setAttribute(), GNEPoly::setAttribute(), NBEdge::setGeometry(), Named::setID(), MSSOTLTrafficLightLogic::setToATargetPhase(), Distribution_Parameterized::toStr(), MSChargingStation::writeChargingStationOutput(), RODFDetector::writeEmitterDefinition(), MSOverheadWire::writeOverheadWireSegmentOutput(), RODFDetector::writeSingleSpeedTrigger(), MSTractionSubstation::writeTractionSubstationOutput(), MEInductLoop::writeXMLOutput(), and MSE3Collector::writeXMLOutput().

◆ myLane

MSLane* const MSMoveReminder::myLane

protectedinherited

Lane on which the reminder works.

Definition at line 276 of file MSMoveReminder.h.

Referenced by MSE2Collector::detectorUpdate(), MSInductLoop::detectorUpdate(), MSE2Collector::getEstimatedCurrentVehicleNumber(), MSE2Collector::getEstimateQueueLength(), MSMoveReminder::getLane(), MSMoveReminder::MSMoveReminder(), MSE2Collector::notifyEnter(), MSInductLoop::notifyEnter(), MSE2Collector::notifyLeave(), and MSE2Collector::notifyMove().

◆ myLastAngle

double MSDevice_Battery::myLastAngle

protected

Parameter, Vehicle's last angle.

Definition at line 195 of file MSDevice_Battery.h.

Referenced by loadState(), notifyMove(), and saveState().

◆ myLastVehicleUpdateValues

std::map<SUMOTrafficObject*, std::pair<SUMOTime, double> > MSMoveReminder::myLastVehicleUpdateValues

privateinherited

Definition at line 286 of file MSMoveReminder.h.

Referenced by MSMoveReminder::removeFromVehicleUpdateValues(), and MSMoveReminder::updateDetector().

◆ myMaximumBatteryCapacity

double MSDevice_Battery::myMaximumBatteryCapacity

protected

Parameter, The total vehicles's Battery Capacity in Wh, [myMaximumBatteryCapacity >= 0].

Definition at line 189 of file MSDevice_Battery.h.

Referenced by getMaximumBatteryCapacity(), MSDevice_Battery(), setActualBatteryCapacity(), and setMaximumBatteryCapacity().

◆ myPreviousNeighbouringChargingStation

MSChargingStation* MSDevice_Battery::myPreviousNeighbouringChargingStation

protected

Parameter, Pointer to charging station neighbouring with myActChargingStation in which vehicle was placed previously (by default is NULL), i.e. auxiliar pointer for disabling charging vehicle from previous (not current) ChargingStation (if there is no gap between two different chargingStations)

Definition at line 219 of file MSDevice_Battery.h.

Referenced by loadState(), notifyMove(), and saveState().

◆ myStoppingThreshold

double MSDevice_Battery::myStoppingThreshold

protected

Parameter, stopping vehicle threshold [myStoppingThreshold >= 0].

Definition at line 192 of file MSDevice_Battery.h.

Referenced by getStoppingThreshold(), MSDevice_Battery(), notifyMove(), and setStoppingThreshold().

◆ myTotalConsumption

double MSDevice_Battery::myTotalConsumption

protected

Parameter, total vehicle energy consumption.

Definition at line 210 of file MSDevice_Battery.h.

Referenced by getTotalConsumption(), loadState(), notifyMove(), and saveState().

◆ myTotalRegenerated

double MSDevice_Battery::myTotalRegenerated

protected

Parameter, total vehicle energy regeneration.

Definition at line 213 of file MSDevice_Battery.h.

Referenced by getTotalRegenerated(), loadState(), notifyMove(), and saveState().

◆ myTrackFuel

bool MSDevice_Battery::myTrackFuel

protected

whether to track fuel consumption instead of electricity

Definition at line 228 of file MSDevice_Battery.h.

Referenced by MSDevice_Battery(), and notifyMove().

◆ myVehicleStopped

int MSDevice_Battery::myVehicleStopped

protected

Parameter, How many timestep the vehicle is stopped.

Definition at line 225 of file MSDevice_Battery.h.

Referenced by getVehicleStopped(), increaseVehicleStoppedTimer(), loadState(), resetVehicleStoppedTimer(), and saveState().

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

Public Types
enum	Notification { NOTIFICATION_DEPARTED , NOTIFICATION_JUNCTION , NOTIFICATION_SEGMENT , NOTIFICATION_LANE_CHANGE , NOTIFICATION_LOAD_STATE , NOTIFICATION_TELEPORT , NOTIFICATION_TELEPORT_CONTINUATION , NOTIFICATION_PARKING , NOTIFICATION_PARKING_REROUTE , NOTIFICATION_ARRIVED , NOTIFICATION_TELEPORT_ARRIVED , NOTIFICATION_VAPORIZED_CALIBRATOR , NOTIFICATION_VAPORIZED_COLLISION , NOTIFICATION_VAPORIZED_TRACI , NOTIFICATION_VAPORIZED_GUI , NOTIFICATION_VAPORIZED_VAPORIZER , NOTIFICATION_VAPORIZED_BREAKDOWN }
	Definition of a vehicle state. More...

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Notification

Constructor & Destructor Documentation

◆ ~MSDevice_Battery()

◆ MSDevice_Battery() [1/2]

◆ MSDevice_Battery() [2/2]

Member Function Documentation

◆ addTo()

◆ buildTransportableDevices()

◆ buildVehicleDevices() [1/2]

◆ buildVehicleDevices() [2/2]

◆ checkOptions()

◆ cleanupAll()

◆ deviceName()

◆ equippedByDefaultAssignmentOptions()

◆ generateOutput()

◆ getActualBatteryCapacity()

◆ getBoolParam()

◆ getChargingStartTime()

◆ getChargingStationID()

◆ getConsum()

◆ getDescription()

◆ getEnergyCharged()

◆ getEquipmentRNG()

◆ getFloatParam()

◆ getHolder()

◆ getID()

◆ getIDSecure()

◆ getLane()

◆ getMaximumBatteryCapacity()

◆ getMaximumPower()

◆ getNumericalID()

◆ getParameter()

◆ getStoppingThreshold()

◆ getStringParam()

◆ getTimeParam()

◆ getTotalConsumption()

◆ getTotalRegenerated()

◆ getVehicleStopped()

◆ increaseChargingStartTime()

◆ increaseVehicleStoppedTimer()

◆ insertDefaultAssignmentOptions()

◆ insertOptions()

◆ isChargingInTransit()

◆ isChargingStopped()

◆ isParkingRerouter()

◆ loadState()

◆ notifyEnter()

◆ notifyIdle()

◆ notifyLeave()

◆ notifyMove()

◆ notifyMoveInternal()

◆ notifyParking()

◆ notifyStopEnded()

◆ operator=()

◆ readParameterValue()

◆ removeFromVehicleUpdateValues()

◆ resetChargingStartTime()

◆ resetVehicleStoppedTimer()

◆ saveState()

◆ setActualBatteryCapacity()

◆ setDescription()

◆ setID()

◆ setMaximumBatteryCapacity()

◆ setParameter()

◆ setStoppingThreshold()

◆ updateDetector()

Field Documentation

◆ myActChargingStation

◆ myActualBatteryCapacity