org.liris.smartgov.lez.core.agent.establishment

Class Establishment

java.lang.Object

org.liris.smartgov.lez.core.agent.establishment.Establishment

All Implemented Interfaces:

org.liris.smartgov.simulator.core.agent.moving.ParkingArea

public class Establishment
extends java.lang.Object
implements org.liris.smartgov.simulator.core.agent.moving.ParkingArea

Represents establishments that can receive and perform deliveries.

This class implements the ParkingArea interface, to represent the fact that vehicle are waiting outside of the road graph between each delivery.

Constructor Summary

Constructors

Constructor and Description
Establishment(java.lang.String id, java.lang.String name, ST8 activity, org.liris.smartgov.simulator.urban.geo.utils.LatLon location) Establishment constructor.

Method Summary

Modifier and Type	Method and Description
void	addAgent(org.liris.smartgov.simulator.urban.osm.agent.OsmAgent agent) Adds an agent to the establishment.
void	addRound(Vehicle vehicle, Round round) Adds a round to be performed by the specified vehicle.
void	addVehicleToFleet(Vehicle vehicle) Adds a vehicle to the establishment's fleet.
void	enter(org.liris.smartgov.simulator.core.agent.moving.MovingAgent agent) Currently, does not does anything special, but allows vehicles to leave the graph to enter this establishment.
ST8	getActivity() Returns establishment's activity.
java.util.Collection<org.liris.smartgov.simulator.urban.osm.agent.OsmAgent>	getAgents() Returns agents belonging to this establishment.
org.liris.smartgov.simulator.urban.osm.environment.graph.OsmNode	getClosestOsmNode() Returns this establishment's closest osm node, that can be used to perform deliveries.
java.util.Map<java.lang.String,Vehicle>	getFleet() Returns the establishment vehicles, indexed by their ids.
java.util.Map<VehicleCapacity,java.util.Collection<Vehicle>>	getFleetByCapacity() Returns a convenient fleet representation, indexed by vehicles capacities.
java.lang.String	getId() Returns establishment's id.
org.liris.smartgov.simulator.urban.geo.utils.LatLon	getLocation() Returns establishment's geographical location.
java.lang.String	getName() Returns establishment's name.
java.util.Map<java.lang.String,Personality>	getPersonalities()
java.util.Map<java.lang.String,Round>	getRounds() Returns rounds that must be performed by this establishment, indexed by delivery vehicle ids that must perform each round.
void	leave(org.liris.smartgov.simulator.core.agent.moving.MovingAgent agent) Currently, does not does anything special, but allows vehicles to leave this establishment and enter the road graph.
void	replaceVehicle(java.lang.String id, Vehicle vehicle)
void	resetFleet()
void	setClosestOsmNode(org.liris.smartgov.simulator.urban.osm.environment.graph.OsmNode closestOsmNode) Sets the closest available osm node of this establishment, that belongs to a road.
void	setPersonality(java.lang.String vehicleId, Personality personality) Returns the personality at the specified id
int	spaceLeft() Unused.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Establishment

public Establishment(java.lang.String id,
                     java.lang.String name,
                     ST8 activity,
                     org.liris.smartgov.simulator.urban.geo.utils.LatLon location)

Establishment constructor.

Parameters:

id - establishment id

name - name

activity - ST8 category

location - geographic location

Method Detail

getId

public java.lang.String getId()

Returns establishment's id.

Returns:

establishment's id

getName

public java.lang.String getName()

Returns establishment's name.

Returns:

establishment's name

getActivity

public ST8 getActivity()

Returns establishment's activity.

Returns:

establishment's activity

getLocation

public org.liris.smartgov.simulator.urban.geo.utils.LatLon getLocation()

Returns establishment's geographical location.

Returns:

establishment's geographical location

setClosestOsmNode

public void setClosestOsmNode(org.liris.smartgov.simulator.urban.osm.environment.graph.OsmNode closestOsmNode)

Sets the closest available osm node of this establishment, that belongs to a road.

Parameters:

closestOsmNode - closest available osm node

getClosestOsmNode

public org.liris.smartgov.simulator.urban.osm.environment.graph.OsmNode getClosestOsmNode()

Returns this establishment's closest osm node, that can be used to perform deliveries.

Returns:

closest osm node

setPersonality

public void setPersonality(java.lang.String vehicleId,
                           Personality personality)

Returns the personality at the specified id

Parameters:

id - the id of the personality

getPersonalities

public java.util.Map<java.lang.String,Personality> getPersonalities()

addVehicleToFleet

public void addVehicleToFleet(Vehicle vehicle)

Adds a vehicle to the establishment's fleet.

Vehicles are indexed by their internal DeliveryVehicle ids.

In the current context, the vehicle's id does not have to be unique in the complete simulation, and only need to be unique by establishment, and so does the EstablishmentLoader.

Parameters:

vehicle - vehicle to add to the fleet

resetFleet

public void resetFleet()

addRound

public void addRound(Vehicle vehicle,
                     Round round)

Adds a round to be performed by the specified vehicle.

Rounds are indexed by vehicle ids.

Parameters:

vehicle - vehicle that can perform this round

round - round to perform

getFleet

public java.util.Map<java.lang.String,Vehicle> getFleet()

Returns the establishment vehicles, indexed by their ids.

Returns:

estalishment's fleet

replaceVehicle

public void replaceVehicle(java.lang.String id,
                           Vehicle vehicle)

getFleetByCapacity

public java.util.Map<VehicleCapacity,java.util.Collection<Vehicle>> getFleetByCapacity()

Returns a convenient fleet representation, indexed by vehicles capacities.

Can be used to easily associate vehicles to rounds according to their respective capacities and weight for example.

Returns:

fleet representation, indexed by vehicle capacities

getRounds

public java.util.Map<java.lang.String,Round> getRounds()

Returns rounds that must be performed by this establishment, indexed by delivery vehicle ids that must perform each round.

Returns:

establishment's rounds

addAgent

public void addAgent(org.liris.smartgov.simulator.urban.osm.agent.OsmAgent agent)

Adds an agent to the establishment.

Such agents are not direcly used by the establishments, but represents a nice way to monitor agents and establishments behavior when agents added are agents corresponding to DeliveryDriverBodies that perform establishment's rounds (as it's done currently).

Parameters:

agent - agent to System.out.println(agents.size());add to this establishment

getAgents

public java.util.Collection<org.liris.smartgov.simulator.urban.osm.agent.OsmAgent> getAgents()

Returns agents belonging to this establishment.

Currently, corresponds to agents associated to the delivery drivers that performs establishment's rounds.

Returns:

establishment's agents

enter

public void enter(org.liris.smartgov.simulator.core.agent.moving.MovingAgent agent)

Currently, does not does anything special, but allows vehicles to leave the graph to enter this establishment.

Specified by:

enter in interface org.liris.smartgov.simulator.core.agent.moving.ParkingArea

Parameters:

agent - delivery agent entering this establishment

leave

public void leave(org.liris.smartgov.simulator.core.agent.moving.MovingAgent agent)

Currently, does not does anything special, but allows vehicles to leave this establishment and enter the road graph.

Specified by:

leave in interface org.liris.smartgov.simulator.core.agent.moving.ParkingArea

Parameters:

agent - delivery agent leaving this establishment

spaceLeft

public int spaceLeft()

Unused.

Specified by:

spaceLeft in interface org.liris.smartgov.simulator.core.agent.moving.ParkingArea

Returns:

0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object