MSEmitter Class Reference

#include <MSEmitter.h>

Inheritance diagram for MSEmitter:

---

Detailed Description

A vehicle emitting device.

Instances of this class are places at a lane where vehicles are inserted into the network. This mechanism can be used in parallel to the standard vehicle emission on roads. An emitter is meant to be used to simulate the entry of a flow into an area at places where induction loops are located at in reality.

Definition at line 59 of file MSEmitter.h.

Public Member Functions
bool	childCheckEmit (MSEmitterChild *child)
size_t	getActiveChildIndex () const
	Returns the index of the currently active child.
const std::string &	getID () const throw ()
	Returns the id.
	MSEmitter (const std::string &id, MSNet &net, MSLane *destLane, SUMOReal pos, const std::string &file) throw ()
	Constructor.
void	schedule (MSEmitterChild *child, MSVehicle *v, SUMOReal speed)
	Schedules a vehicle to emit.
void	setActiveChild (MSEmitterChild *child)
	Sets the given child as the currently used one.
virtual	~MSEmitter () throw ()
Protected Attributes
MSEmitterChild *	myActiveChild
	The currently active child.
MSLane *	myDestLane
MSEmitterChild *	myFileBasedEmitter
	The file-based child.
std::string	myID
	The name of the object.
MSNet &	myNet
	The network the emitter is located in.
SUMOReal	myPos
	The position of the emitter at the lane.
std::map< MSEmitterChild *, std::pair< MSVehicle *, SUMOReal > >	myToEmit
	A map children->vehicles to emit.
Private Member Functions
	MSEmitter (const MSEmitter &)
	Invalidated copy constructor.
MSEmitter &	operator= (const MSEmitter &)
	Invalidated assignment operator.
Data Structures
class	MSEmitter_FileTriggeredChild
	An EmitterChild which uses information from a parsed file. More...
class	MSEmitterChild
	Holder of information about vehicle routes and types. More...

---

Constructor & Destructor Documentation

MSEmitter::MSEmitter	(	const std::string &	id,
		MSNet &	net,
		MSLane *	destLane,
		SUMOReal	pos,
		const std::string &	file
	)			throw ()

Constructor.

Parameters:

[in]	id	The id of the emitter
[in]	net	The net the emitter belongs to
[in]	destLane	The lane the emitter is placed on
[in]	pos	Position of the emitter on the given lane
[in]	file	Name of the file to read the emission definitions from

Definition at line 289 of file MSEmitter.cpp.

References MSEmitter::MSEmitter_FileTriggeredChild::MSEmitter_FileTriggeredChild(), myActiveChild, myFileBasedEmitter, and myPos.

        : MSTrigger(id), myNet(net),
        myDestLane(destLane), myPos((SUMOReal) pos) {
    assert(myPos>=0);
    myActiveChild =
        new MSEmitter_FileTriggeredChild(net, aXMLFilename, *this, net.getVehicleControl());
    myFileBasedEmitter = myActiveChild;
}

MSEmitter::~MSEmitter

(

)

throw () [virtual]

destructor

Definition at line 302 of file MSEmitter.cpp.

References myFileBasedEmitter, and myToEmit.

                              {
    delete myFileBasedEmitter;
    std::map<MSEmitterChild*, std::pair<MSVehicle*, SUMOReal> >::iterator i;
    for (i=myToEmit.begin(); i!=myToEmit.end(); ++i) {
        delete(*i).second.first;
    }
}

MSEmitter::MSEmitter

(

const MSEmitter &

)

[private]

Invalidated copy constructor.

---

Member Function Documentation

bool MSEmitter::childCheckEmit

(

MSEmitterChild *

child

)

Called by a MSEmitterChild (given as parameter) this method checks whether this child is the currently active one and whether a vehicle from this source can be emitted. Returns true if the child can continue with the next vehicle, false otherwise

Definition at line 312 of file MSEmitter.cpp.

References MSVehicleControl::addVehicle(), MSEdge::emit(), MSNet::getCurrentTimeStep(), MSVehicle::getDesiredDepart(), MSLane::getEdge(), MSVehicle::getID(), MSNet::getInstance(), MSVehicle::getMaxSpeed(), MSLane::getMaxSpeed(), MSNet::getVehicleControl(), MSLane::isEmissionSuccess(), MSEdge::isVaporizing(), MIN2(), MIN3(), myActiveChild, myDestLane, myNet, myPos, myToEmit, MSVehicle::onDepart(), and SUMOReal.

Referenced by MSEmitter::MSEmitter_FileTriggeredChild::execute(), MSEmitter::MSEmitter_FileTriggeredChild::processNextEntryReaderTriggered(), and GUIEmitter::GUIEmitterChild_UserTriggeredChild::wrappedExecute().

                                               {
    if (myToEmit.find(child)==myToEmit.end()) {
        // should not happen - a child is calling and should have a vehicle added
        throw 1;
    }
    if (child!=myActiveChild||myDestLane->getEdge().isVaporizing()) {
        // check whether this is due to vaporization
        if (myDestLane->getEdge().isVaporizing()) {
            myToEmit[child].first->setWasVaporized(true);
        }
        // remove the vehicle previously inserted by the child
        delete myToEmit[child].first;
        // erase the child information
        myToEmit.erase(myToEmit.find(child));
        // inform child to process the next one (the current was not used)
        return true;
    }
    // get the vehicle and the speed the child has read/generated
    MSVehicle *veh = myToEmit[child].first;
    if (veh->getDesiredDepart()>MSNet::getInstance()->getCurrentTimeStep()) {
        return false;
    }
    SUMOReal speed = myToEmit[child].second;
    // !!! add warning if speed to high or negative
    // check whether the speed shall be patched
    SUMOReal pos = myPos;
    if (speed<0) {
        speed = MIN2(myDestLane->getMaxSpeed(), veh->getMaxSpeed());
    } else {
        speed = MIN3(myDestLane->getMaxSpeed(), veh->getMaxSpeed(), speed);
    }
    // try to emit
#ifdef HAVE_MESOSIM
    if (MSGlobals::gUseMesoSim) {
        if (myDestLane->getEdge().emit(*veh,  myNet.getCurrentTimeStep())) {
            veh->onDepart();
            // insert vehicle into the dictionary
            if (!myNet.getVehicleControl().addVehicle(veh->getID(), veh)) {
                // !!!
                throw 1;
            }
            // erase the child information
            myToEmit.erase(myToEmit.find(child));
            return true;
        }
    } else {
#endif
        if (myDestLane->isEmissionSuccess(veh, speed, pos, true)) {
            veh->onDepart();
            // insert vehicle into the dictionary
            if (!myNet.getVehicleControl().addVehicle(veh->getID(), veh)) {
                // !!!
                throw 1;
            }
            // erase the child information
            myToEmit.erase(myToEmit.find(child));
            return true;
        }
#ifdef HAVE_MESOSIM
    }
#endif
    return false;
}

size_t MSEmitter::getActiveChildIndex

(

)

const

Returns the index of the currently active child.

Definition at line 386 of file MSEmitter.cpp.

References myActiveChild, and myFileBasedEmitter.

Referenced by GUIEmitter::GUIManip_TriggeredEmitter::GUIManip_TriggeredEmitter().

                                     {
    return
        myFileBasedEmitter==myActiveChild ? 0 : 1;
}

const std::string& Named::getID

(

)

const throw () [inline, inherited]

Returns the id.

Returns:

The stored id

Definition at line 59 of file Named.h.

References Named::myID.

Referenced by RORouteDef_Alternatives::addAlternative(), MSRouteProbe::addRoute(), MSEmitter::MSEmitter_FileTriggeredChild::buildAndScheduleFlowVehicle(), MSCalibrator::MSCalibrator_FileTriggeredChild::buildAndScheduleFlowVehicle(), RORouteDef_Complete::buildCurrentRoute(), ODDistrictHandler::closeDistrict(), NBTrafficLightDefinition::collectLinks(), NBTrafficLightDefinition::compute(), GUIPointOfInterest::drawGL(), MSInductLoop::enterDetectorByMove(), MSVTypeProbe::execute(), MSNet::getBusStopID(), GUITriggeredRerouter::getMicrosimID(), GUIPointOfInterest::getMicrosimID(), GUILaneSpeedTrigger::getMicrosimID(), GUIInductLoop::MyWrapper::getMicrosimID(), GUIEmitter::getMicrosimID(), GUIBusStop::getMicrosimID(), GUI_E2_ZS_Collector::MyWrapper::getMicrosimID(), traci::TraCIServer::handlePoiDomain(), RORDLoader_SUMOBase::myCharacters(), NBOwnTLDef::myCompute(), NBLoadedTLDef::myCompute(), MSTriggeredRerouter::myStartElement(), MSLaneSpeedTrigger::myStartElement(), MSEmitter::MSEmitter_FileTriggeredChild::myStartElement(), MSCalibrator::MSCalibrator_FileTriggeredChild::myStartElement(), NBLoadedTLDef::SignalGroup::patchTYellow(), TraCIServerAPI_Vehicle::processGet(), MSVehicle::replaceRoute(), MSVehicle::saveState(), NBOwnTLDef::setTLControllingInformation(), NBLoadedTLDef::setTLControllingInformation(), RORDLoader_SUMOBase::startRoute(), GUIEmitter::GUIEmitterChild_UserTriggeredChild::wrappedExecute(), NBTrafficLightLogic::writeXML(), MSRouteProbe::writeXMLOutput(), MSInductLoop::writeXMLOutput(), MSE2Collector::writeXMLOutput(), and MSVehicle::~MSVehicle().

                                           {
        return myID;
    }

MSEmitter& MSEmitter::operator=

(

const MSEmitter &

)

[private]

Invalidated assignment operator.

void MSEmitter::schedule	(	MSEmitterChild *	child,
		MSVehicle *	v,
		SUMOReal	speed
	)

Schedules a vehicle to emit.

Definition at line 378 of file MSEmitter.cpp.

References myToEmit, and MSVehicle::onTryEmit().

Referenced by MSEmitter::MSEmitter_FileTriggeredChild::buildAndScheduleFlowVehicle(), MSEmitter::MSEmitter_FileTriggeredChild::myStartElement(), and GUIEmitter::GUIEmitterChild_UserTriggeredChild::wrappedExecute().

                                                  {
    v->onTryEmit();
    myToEmit[child] = std::make_pair(v, speed);
}

void MSEmitter::setActiveChild

(

MSEmitterChild *

child

)

Sets the given child as the currently used one.

Definition at line 393 of file MSEmitter.cpp.

References myActiveChild.

                                           {
    myActiveChild = c;
}

---

Field Documentation

MSEmitterChild* MSEmitter::myActiveChild [protected]

The currently active child.

Definition at line 287 of file MSEmitter.h.

Referenced by childCheckEmit(), getActiveChildIndex(), MSEmitter(), setActiveChild(), and GUIEmitter::setActiveChild().

MSLane* MSEmitter::myDestLane [protected]

the lane the emitter is placed on

Definition at line 275 of file MSEmitter.h.

Referenced by childCheckEmit().

MSEmitterChild* MSEmitter::myFileBasedEmitter [protected]

The file-based child.

Definition at line 281 of file MSEmitter.h.

Referenced by getActiveChildIndex(), GUIEmitter::getEdgeProbs(), GUIEmitter::getUserFlow(), GUIEmitter::GUIEmitter(), MSEmitter(), GUIEmitter::setActiveChild(), GUIEmitter::setUserFlow(), and ~MSEmitter().

std::string Named::myID [protected, inherited]

The name of the object.

Definition at line 66 of file Named.h.

Referenced by RORouteDef_OrigDest::buildCurrentRoute(), RORouteDef_Complete::buildCurrentRoute(), RORouteDef_Alternatives::buildCurrentRoute(), and Named::getID().

MSNet& MSEmitter::myNet [protected]

The network the emitter is located in.

Definition at line 272 of file MSEmitter.h.

Referenced by childCheckEmit(), and GUIEmitter::setUserFlow().

SUMOReal MSEmitter::myPos [protected]

The position of the emitter at the lane.

Definition at line 278 of file MSEmitter.h.

Referenced by childCheckEmit(), and MSEmitter().

std::map<MSEmitterChild*, std::pair<MSVehicle*, SUMOReal> > MSEmitter::myToEmit [protected]

A map children->vehicles to emit.

Definition at line 284 of file MSEmitter.h.

Referenced by childCheckEmit(), schedule(), and ~MSEmitter().

---

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

• MSEmitter.h
• MSEmitter.cpp