GNEPlanParents Class Reference

GNEPlanParents (used for group all plan parents) More...

#include <GNEPlanParents.h>

Collaboration diagram for GNEPlanParents:

Public Member Functions
void	addChildElements (GNEDemandElement *element)
	add the given element in the element as child More...
bool	checkIntegrity (SumoXMLTag planTag, const GNEDemandElement *parent, const CommonXMLStructure::PlanParameters &planParameters) const
	check integrity between planParameters and GNE elements More...
void	clear ()
	clear elements More...
std::vector< GNEAdditional * >	getAdditionalElements () const
	get additionalElements (used in plan constructors) More...
std::vector< GNEDemandElement * >	getDemandElements (GNEDemandElement *parent) const
	get demand elements (used in plan constructors) More...
std::vector< GNEEdge * >	getEdges () const
	get edges (used in plan constructors) More...
std::vector< GNEJunction * >	getJunctions () const
	get junctions (used in plan constructors) More...
	GNEPlanParents ()
	default constructor More...
	GNEPlanParents (const CommonXMLStructure::PlanParameters &planParameters, const GNENetHelper::AttributeCarriers *ACs)
	constructor for parsing the parameters from SUMOSAXAttributes More...
functions for checking stopping places
get from busStop
bool	getFromBusStop () const
bool	getToBusStop () const
	get to busStop More...
bool	getFromTrainStop () const
	get from trainStop More...
bool	getToTrainStop () const
	get to trainStop More...
bool	getFromContainerStop () const
	get from containerStop More...
bool	getToContainerStop () const
	get to containerStop More...
bool	getFromChargingStation () const
	get from chargingStation More...
bool	getToChargingStation () const
	get to chargingStation More...
bool	getFromParkingArea () const
	get from parkingArea More...
bool	getToParkingArea () const
	get to parkingArea More...

Data Fields
std::vector< GNEEdge * >	consecutiveEdges
	edges More...
GNEEdge *	fromEdge = nullptr
	from edge More...
GNEJunction *	fromJunction = nullptr
	from junction More...
GNEDemandElement *	fromRoute = nullptr
	from route (currently only used by walks) More...
GNEAdditional *	fromStoppingPlace = nullptr
	from stoppingPlace More...
GNEAdditional *	fromTAZ = nullptr
	from TAZ More...
GNEEdge *	toEdge = nullptr
	to edge More...
GNEJunction *	toJunction = nullptr
	to junction More...
GNEDemandElement *	toRoute = nullptr
	to route (currently only used by walks) More...
GNEAdditional *	toStoppingPlace = nullptr
	to stoppingPlace More...
GNEAdditional *	toTAZ = nullptr
	to TAZ More...

Detailed Description

GNEPlanParents (used for group all plan parents)

Definition at line 54 of file GNEPlanParents.h.

Constructor & Destructor Documentation

GNEPlanParents() [1/2]

GNEPlanParents::GNEPlanParents

(

)

default constructor

Definition at line 50 of file GNEPlanParents.cpp.

GNEPlanParents() [2/2]

GNEPlanParents::GNEPlanParents	(	const CommonXMLStructure::PlanParameters &	planParameters,
		const GNENetHelper::AttributeCarriers *	ACs
	)

constructor for parsing the parameters from SUMOSAXAttributes

Definition at line 53 of file GNEPlanParents.cpp.

References consecutiveEdges, CommonXMLStructure::PlanParameters::consecutiveEdges, CommonXMLStructure::PlanParameters::fromBusStop, CommonXMLStructure::PlanParameters::fromChargingStation, CommonXMLStructure::PlanParameters::fromContainerStop, fromEdge, CommonXMLStructure::PlanParameters::fromEdge, fromJunction, CommonXMLStructure::PlanParameters::fromJunction, CommonXMLStructure::PlanParameters::fromParkingArea, fromRoute, CommonXMLStructure::PlanParameters::fromRoute, fromStoppingPlace, fromTAZ, CommonXMLStructure::PlanParameters::fromTAZ, CommonXMLStructure::PlanParameters::fromTrainStop, GNENetHelper::AttributeCarriers::retrieveAdditional(), GNENetHelper::AttributeCarriers::retrieveDemandElement(), GNENetHelper::AttributeCarriers::retrieveEdge(), GNENetHelper::AttributeCarriers::retrieveJunction(), SUMO_TAG_BUS_STOP, SUMO_TAG_CHARGING_STATION, SUMO_TAG_CONTAINER_STOP, SUMO_TAG_PARKING_AREA, SUMO_TAG_ROUTE, SUMO_TAG_TAZ, SUMO_TAG_TRAIN_STOP, CommonXMLStructure::PlanParameters::toBusStop, CommonXMLStructure::PlanParameters::toChargingStation, CommonXMLStructure::PlanParameters::toContainerStop, toEdge, CommonXMLStructure::PlanParameters::toEdge, toJunction, CommonXMLStructure::PlanParameters::toJunction, CommonXMLStructure::PlanParameters::toParkingArea, toRoute, CommonXMLStructure::PlanParameters::toRoute, toStoppingPlace, toTAZ, CommonXMLStructure::PlanParameters::toTAZ, and CommonXMLStructure::PlanParameters::toTrainStop.

Member Function Documentation

addChildElements()

void GNEPlanParents::addChildElements

(

GNEDemandElement *

element

)

add the given element in the element as child

Definition at line 174 of file GNEPlanParents.cpp.

References GNEHierarchicalElement::addChildElement(), consecutiveEdges, fromEdge, fromJunction, fromRoute, fromStoppingPlace, fromTAZ, toEdge, toJunction, toRoute, toStoppingPlace, and toTAZ.

Referenced by GNERouteHandler::buildContainerStop(), GNERouteHandler::buildPersonStop(), GNERouteHandler::buildPersonTrip(), GNERouteHandler::buildRide(), GNERouteHandler::buildTranship(), GNERouteHandler::buildTransport(), and GNERouteHandler::buildWalk().

Here is the caller graph for this function:

checkIntegrity()

bool GNEPlanParents::checkIntegrity	(	SumoXMLTag	planTag,
		const GNEDemandElement *	parent,
		const CommonXMLStructure::PlanParameters &	planParameters
	)		const

check integrity between planParameters and GNE elements

Definition at line 113 of file GNEPlanParents.cpp.

References CommonXMLStructure::PlanParameters::fromBusStop, CommonXMLStructure::PlanParameters::fromChargingStation, CommonXMLStructure::PlanParameters::fromContainerStop, fromEdge, CommonXMLStructure::PlanParameters::fromEdge, fromJunction, CommonXMLStructure::PlanParameters::fromJunction, CommonXMLStructure::PlanParameters::fromParkingArea, fromRoute, CommonXMLStructure::PlanParameters::fromRoute, fromStoppingPlace, fromTAZ, CommonXMLStructure::PlanParameters::fromTAZ, CommonXMLStructure::PlanParameters::fromTrainStop, GNEAttributeCarrier::getID(), GNEAttributeCarrier::getTagStr(), TLF, CommonXMLStructure::PlanParameters::toBusStop, CommonXMLStructure::PlanParameters::toChargingStation, CommonXMLStructure::PlanParameters::toContainerStop, toEdge, CommonXMLStructure::PlanParameters::toEdge, toJunction, CommonXMLStructure::PlanParameters::toJunction, CommonXMLStructure::PlanParameters::toParkingArea, toRoute, CommonXMLStructure::PlanParameters::toRoute, toStoppingPlace, toString(), toTAZ, CommonXMLStructure::PlanParameters::toTAZ, CommonXMLStructure::PlanParameters::toTrainStop, and WRITE_WARNING.

Referenced by GNERouteHandler::buildContainerStop(), GNERouteHandler::buildPersonStop(), GNERouteHandler::buildPersonTrip(), GNERouteHandler::buildRide(), GNERouteHandler::buildTranship(), GNERouteHandler::buildTransport(), and GNERouteHandler::buildWalk().

Here is the caller graph for this function:

clear()

void GNEPlanParents::clear

(

)

clear elements

Definition at line 212 of file GNEPlanParents.cpp.

References consecutiveEdges, fromEdge, fromJunction, fromRoute, fromStoppingPlace, fromTAZ, toEdge, toJunction, toRoute, toStoppingPlace, and toTAZ.

getAdditionalElements()

std::vector< GNEAdditional * > GNEPlanParents::getAdditionalElements

(

)

const

get additionalElements (used in plan constructors)

Definition at line 358 of file GNEPlanParents.cpp.

References fromStoppingPlace, fromTAZ, toStoppingPlace, and toTAZ.

getDemandElements()

std::vector< GNEDemandElement * > GNEPlanParents::getDemandElements

(

GNEDemandElement *

parent

)

const

get demand elements (used in plan constructors)

Definition at line 377 of file GNEPlanParents.cpp.

References fromRoute, and toRoute.

getEdges()

std::vector< GNEEdge * > GNEPlanParents::getEdges

(

)

const

get edges (used in plan constructors)

Definition at line 341 of file GNEPlanParents.cpp.

References consecutiveEdges, fromEdge, and toEdge.

getFromBusStop()

bool GNEPlanParents::getFromBusStop

(

)

const

Definition at line 228 of file GNEPlanParents.cpp.

References fromStoppingPlace, GNETagProperties::getTag(), GNEAttributeCarrier::getTagProperty(), and SUMO_TAG_BUS_STOP.

getFromChargingStation()

bool GNEPlanParents::getFromChargingStation

(

)

const

get from chargingStation

Definition at line 288 of file GNEPlanParents.cpp.

References fromStoppingPlace, GNETagProperties::getTag(), GNEAttributeCarrier::getTagProperty(), and SUMO_TAG_CHARGING_STATION.

getFromContainerStop()

bool GNEPlanParents::getFromContainerStop

(

)

const

get from containerStop

Definition at line 268 of file GNEPlanParents.cpp.

References fromStoppingPlace, GNETagProperties::getTag(), GNEAttributeCarrier::getTagProperty(), and SUMO_TAG_CONTAINER_STOP.

getFromParkingArea()

bool GNEPlanParents::getFromParkingArea

(

)

const

get from parkingArea

Definition at line 308 of file GNEPlanParents.cpp.

References fromStoppingPlace, GNETagProperties::getTag(), GNEAttributeCarrier::getTagProperty(), and SUMO_TAG_PARKING_AREA.

getFromTrainStop()

bool GNEPlanParents::getFromTrainStop

(

)

const

get from trainStop

Definition at line 248 of file GNEPlanParents.cpp.

References fromStoppingPlace, GNETagProperties::getTag(), GNEAttributeCarrier::getTagProperty(), and SUMO_TAG_TRAIN_STOP.

getJunctions()

std::vector< GNEJunction * > GNEPlanParents::getJunctions

(

)

const

get junctions (used in plan constructors)

Definition at line 328 of file GNEPlanParents.cpp.

References fromJunction, and toJunction.

getToBusStop()

bool GNEPlanParents::getToBusStop

(

)

const

get to busStop

Definition at line 238 of file GNEPlanParents.cpp.

References GNETagProperties::getTag(), GNEAttributeCarrier::getTagProperty(), SUMO_TAG_BUS_STOP, and toStoppingPlace.

getToChargingStation()

bool GNEPlanParents::getToChargingStation

(

)

const

get to chargingStation

Definition at line 298 of file GNEPlanParents.cpp.

References GNETagProperties::getTag(), GNEAttributeCarrier::getTagProperty(), SUMO_TAG_CHARGING_STATION, and toStoppingPlace.

getToContainerStop()

bool GNEPlanParents::getToContainerStop

(

)

const

get to containerStop

Definition at line 278 of file GNEPlanParents.cpp.

References GNETagProperties::getTag(), GNEAttributeCarrier::getTagProperty(), SUMO_TAG_CONTAINER_STOP, and toStoppingPlace.

getToParkingArea()

bool GNEPlanParents::getToParkingArea

(

)

const

get to parkingArea

Definition at line 318 of file GNEPlanParents.cpp.

References GNETagProperties::getTag(), GNEAttributeCarrier::getTagProperty(), SUMO_TAG_PARKING_AREA, and toStoppingPlace.

getToTrainStop()

bool GNEPlanParents::getToTrainStop

(

)

const

get to trainStop

Definition at line 258 of file GNEPlanParents.cpp.

References GNETagProperties::getTag(), GNEAttributeCarrier::getTagProperty(), SUMO_TAG_TRAIN_STOP, and toStoppingPlace.

Field Documentation

consecutiveEdges

std::vector<GNEEdge*> GNEPlanParents::consecutiveEdges

edges

Definition at line 127 of file GNEPlanParents.h.

Referenced by addChildElements(), clear(), getEdges(), and GNEPlanParents().

fromEdge

GNEEdge* GNEPlanParents::fromEdge = nullptr

from edge

Definition at line 121 of file GNEPlanParents.h.

Referenced by addChildElements(), checkIntegrity(), clear(), getEdges(), and GNEPlanParents().

fromJunction

GNEJunction* GNEPlanParents::fromJunction = nullptr

from junction

Definition at line 130 of file GNEPlanParents.h.

Referenced by addChildElements(), checkIntegrity(), clear(), getJunctions(), and GNEPlanParents().

fromRoute

GNEDemandElement* GNEPlanParents::fromRoute = nullptr

from route (currently only used by walks)

Definition at line 148 of file GNEPlanParents.h.

Referenced by addChildElements(), checkIntegrity(), clear(), getDemandElements(), and GNEPlanParents().

fromStoppingPlace

GNEAdditional* GNEPlanParents::fromStoppingPlace = nullptr

from stoppingPlace

Definition at line 142 of file GNEPlanParents.h.

Referenced by addChildElements(), checkIntegrity(), clear(), getAdditionalElements(), getFromBusStop(), getFromChargingStation(), getFromContainerStop(), getFromParkingArea(), getFromTrainStop(), and GNEPlanParents().

fromTAZ

GNEAdditional* GNEPlanParents::fromTAZ = nullptr

from TAZ

Definition at line 136 of file GNEPlanParents.h.

Referenced by addChildElements(), checkIntegrity(), clear(), getAdditionalElements(), and GNEPlanParents().

toEdge

GNEEdge* GNEPlanParents::toEdge = nullptr

to edge

Definition at line 124 of file GNEPlanParents.h.

Referenced by addChildElements(), checkIntegrity(), clear(), getEdges(), and GNEPlanParents().

toJunction

GNEJunction* GNEPlanParents::toJunction = nullptr

to junction

Definition at line 133 of file GNEPlanParents.h.

Referenced by addChildElements(), checkIntegrity(), clear(), getJunctions(), and GNEPlanParents().

toRoute

GNEDemandElement* GNEPlanParents::toRoute = nullptr

to route (currently only used by walks)

Definition at line 151 of file GNEPlanParents.h.

Referenced by addChildElements(), checkIntegrity(), clear(), getDemandElements(), and GNEPlanParents().

toStoppingPlace

GNEAdditional* GNEPlanParents::toStoppingPlace = nullptr

to stoppingPlace

Definition at line 145 of file GNEPlanParents.h.

Referenced by addChildElements(), checkIntegrity(), clear(), getAdditionalElements(), getToBusStop(), getToChargingStation(), getToContainerStop(), getToParkingArea(), getToTrainStop(), and GNEPlanParents().

toTAZ

GNEAdditional* GNEPlanParents::toTAZ = nullptr

to TAZ

Definition at line 139 of file GNEPlanParents.h.

Referenced by addChildElements(), checkIntegrity(), clear(), getAdditionalElements(), and GNEPlanParents().

---

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

• GNEPlanParents.h
• GNEPlanParents.cpp