org.matsim.vehicles.VehicleUtils Class Reference

Static Public Member Functions
static VehicleType	createVehicleType (Id< VehicleType > typeId)
static VehicleType	createVehicleType (Id< VehicleType > typeId, String networkMode)
static VehiclesFactory	getFactory ()
static Vehicles	createVehiclesContainer ()
static VehicleType	createDefaultVehicleType ()
static Id< Vehicle >	createVehicleId (Person person, String mode)
static void	copyFromTo (VehicleType in, VehicleType out)
static boolean	hasVehicleId (Person person, String mode)
static Map< String, Id< Vehicle > >	getVehicleIds (Person person)
static Map< String, Id< VehicleType > >	getVehicleTypes (Person person)
static Id< Vehicle >	getVehicleId (Person person, String mode)
static void	insertVehicleIdsIntoAttributes (Person person, Map< String, Id< Vehicle >> modeToVehicle)
static void	insertVehicleIdsIntoPersonAttributes (Person person, Map< String, Id< Vehicle >> modeToVehicle)
static void	insertVehicleTypesIntoAttributes (Person person, Map< String, Id< VehicleType >> modeToVehicleType)
static void	insertVehicleTypesIntoPersonAttributes (Person person, Map< String, Id< VehicleType >> modeToVehicleType)
static VehicleType.DoorOperationMode	getDoorOperationMode (VehicleType vehicleType)
static void	setDoorOperationMode (VehicleType vehicleType, VehicleType.DoorOperationMode mode)
static double	getEgressTime (VehicleType vehicleType)
static void	setEgressTime (VehicleType vehicleType, double egressTime)
static double	getAccessTime (VehicleType vehicleType)
static void	setAccessTime (VehicleType vehicleType, double accessTime)
static Double	getFuelConsumption (VehicleType vehicleType)
static void	setFuelConsumption (VehicleType vehicleType, double literPerMeter)
static String	getHbefaTechnology (EngineInformation ei)
static void	setHbefaTechnology (EngineInformation engineInformation, String hbefaTechnology)
static String	getHbefaVehicleCategory (EngineInformation ei)
static void	setHbefaVehicleCategory (EngineInformation engineInformation, String hbefaVehicleCategory)
static String	getHbefaSizeClass (EngineInformation ei)
static void	setHbefaSizeClass (EngineInformation engineInformation, String hbefaSizeClass)
static String	getHbefaEmissionsConcept (EngineInformation ei)
static void	setHbefaEmissionsConcept (EngineInformation engineInformation, String emissionsConcept)
static Double	getEnergyConsumptionKWhPerMeter (EngineInformation engineInformation)
static void	setEnergyConsumptionKWhPerMeter (EngineInformation engineInformation, double energyConsumptionKWhPerMeter)
static Double	getFuelConsumptionLitersPerMeter (EngineInformation engineInformation)
static void	setFuelConsumptionLitersPerMeter (EngineInformation engineInformation, double fuelConsumptionLitersPerMeter)
static Double	getEnergyCapacity (EngineInformation engineInformation)
static void	setEnergyCapacity (EngineInformation engineInformation, double energyCapacityInKWhOrLiters)
static Double	getCostsPerSecondWaiting (CostInformation costInformation)
static void	setCostsPerSecondWaiting (CostInformation costInformation, double costsPerSecond)
static Double	getCostsPerSecondInService (CostInformation costInformation)
static void	setCostsPerSecondInService (CostInformation costInformation, double costsPerSecond)
static Vehicle	createVehicle (Id< Vehicle > id, VehicleType type)
static Vehicles	getOrCreateAllvehicles (Scenario scenario)
static Vehicle	findVehicle (Id< Vehicle > vehicleId, Scenario scenario)
static void	writeVehicles (Vehicles vehicles, String filename)
static Id< Link >	getInitialLinkId (Vehicle vehicle)
static void	setInitialLinkId (Vehicle vehicle, Id< Link > initialLinkId)

Static Private Attributes
static final Logger	log = LogManager.getLogger( VehicleUtils.class )
static final String	DEFAULT_VEHICLE_TYPE_ID = "defaultVehicleType"
static final String	VEHICLE_ATTRIBUTE_KEY = "vehicles"
static final String	VEHICLE_TYPES_ATTRIBUTE_KEY = "vehicleTypes"
static final String	DOOR_OPERATION_MODE = "doorOperationMode"
static final String	EGRESSTIME = "egressTimeInSecondsPerPerson"
static final String	ACCESSTIME = "accessTimeInSecondsPerPerson"
static final String	FUELCONSUMPTION = "fuelConsumptionLitersPerMeter"
static final String	ENERGYCONSUMPTION = "energyConsumptionKWhPerMeter"
static final String	ENERGYCAPACITY = "energyCapacityInKWhOrLiters"
static final String	HBEFA_VEHICLE_CATEGORY_ = "HbefaVehicleCategory"
static final String	HBEFA_TECHNOLOGY = "HbefaTechnology"
static final String	HBEFA_SIZE_CLASS = "HbefaSizeClass"
static final String	HBEFA_EMISSIONS_CONCEPT = "HbefaEmissionsConcept"
static final String	COST_PER_SECOND_WAITING = "costsPerSecondWaiting"
static final String	COST_PER_SECOND_INSERVICE = "costsPerSecondInService"
static final String	FUEL_TYPE = "fuelType"
static final String	INITIAL_LINK_ID = "initialLinkId"
static int	tryStdCnt = 5
static int	tryTrnCnt = 5

Detailed Description

Author

nagel

Definition at line 41 of file VehicleUtils.java.

Member Function Documentation

createVehicleType() [1/2]

static VehicleType org.matsim.vehicles.VehicleUtils.createVehicleType ( Id< VehicleType >  typeId )

static

Definition at line 64 of file VehicleUtils.java.

                                                                         {
        return new VehicleType( typeId );
    }

createVehicleType() [2/2]

static VehicleType org.matsim.vehicles.VehicleUtils.createVehicleType ( Id< VehicleType >  typeId, String  networkMode  )

static

Definition at line 68 of file VehicleUtils.java.

                                                                                            {
        return new VehicleType( typeId, networkMode );
    }

getFactory()

static VehiclesFactory org.matsim.vehicles.VehicleUtils.getFactory ( )

static

Definition at line 72 of file VehicleUtils.java.

Referenced by org.matsim.vehicles.VehicleUtils.createDefaultVehicleType().

                                               {
        return new VehiclesFactoryImpl();
    }

createVehiclesContainer()

static Vehicles org.matsim.vehicles.VehicleUtils.createVehiclesContainer ( )

static

Definition at line 76 of file VehicleUtils.java.

                                                     {
        return new VehiclesImpl();
    }

createDefaultVehicleType()

static VehicleType org.matsim.vehicles.VehicleUtils.createDefaultVehicleType ( )

static

Definition at line 80 of file VehicleUtils.java.

References org.matsim.api.core.v01.TransportMode.car, org.matsim.api.core.v01.Id< T >.create(), org.matsim.vehicles.VehiclesFactory.createVehicleType(), org.matsim.vehicles.VehicleType.getCapacity(), org.matsim.vehicles.VehicleUtils.getFactory(), org.matsim.vehicles.VehicleType.setNetworkMode(), and org.matsim.vehicles.VehicleCapacity.setSeats().

Referenced by org.matsim.core.controler.PrepareForSimImpl.getVehicleTypesForAllNetworkAndMainModes().

                                                         {
        VehicleType defaultVehicleType = VehicleUtils.getFactory()
                .createVehicleType(Id.create(DEFAULT_VEHICLE_TYPE_ID, VehicleType.class));

        defaultVehicleType.getCapacity().setSeats(4);
        defaultVehicleType.setNetworkMode(TransportMode.car);
        return defaultVehicleType;
    }

Here is the call graph for this function:

createVehicleId()

static Id<Vehicle> org.matsim.vehicles.VehicleUtils.createVehicleId ( Person  person, String  mode  )

static

Creates a vehicle id based on the person and the mode

If config.qsim().getVehicleSource() is "modeVehicleTypesFromVehiclesData", the returned id is a combination of the person's id and the supplied mode. E.g. "person1_car

Parameters

person	The person which owns the vehicle
mode	The mode this vehicle is for

Returns

a VehicleId

Definition at line 99 of file VehicleUtils.java.

References org.matsim.api.core.v01.Id< T >.createVehicleId().

Referenced by org.matsim.core.controler.PrepareForSimImpl.createVehicleId().

                                                                          {
        return Id.createVehicleId(person.getId().toString() + "_" + mode);
    }

Here is the call graph for this function:

copyFromTo()

static void org.matsim.vehicles.VehicleUtils.copyFromTo ( VehicleType  in, VehicleType  out  )

static

Definition at line 103 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.AttributesUtils.copyAttributesFromTo(), org.matsim.vehicles.VehicleType.getCapacity(), org.matsim.vehicles.VehicleType.getCostInformation(), org.matsim.vehicles.CostInformation.getCostsPerMeter(), org.matsim.vehicles.CostInformation.getCostsPerSecond(), org.matsim.vehicles.VehicleType.getDescription(), org.matsim.vehicles.VehicleType.getEngineInformation(), org.matsim.vehicles.CostInformation.getFixedCosts(), org.matsim.vehicles.VehicleType.getFlowEfficiencyFactor(), org.matsim.vehicles.VehicleType.getLength(), org.matsim.vehicles.VehicleType.getMaximumVelocity(), org.matsim.vehicles.VehicleType.getNetworkMode(), org.matsim.vehicles.VehicleType.getPcuEquivalents(), org.matsim.vehicles.VehicleCapacity.getSeats(), org.matsim.vehicles.VehicleCapacity.getStandingRoom(), org.matsim.vehicles.VehicleCapacity.getVolumeInCubicMeters(), org.matsim.vehicles.VehicleCapacity.getWeightInTons(), org.matsim.vehicles.CostInformation.setCostsPerSecond(), org.matsim.vehicles.VehicleType.setDescription(), org.matsim.vehicles.VehicleType.setFlowEfficiencyFactor(), org.matsim.vehicles.VehicleType.setLength(), org.matsim.vehicles.VehicleType.setMaximumVelocity(), org.matsim.vehicles.VehicleType.setNetworkMode(), org.matsim.vehicles.VehicleType.setPcuEquivalents(), org.matsim.vehicles.VehicleCapacity.setWeightInTons(), and org.matsim.vehicles.VehicleType.setWidth().

                                                                     {
        out.setMaximumVelocity(in.getMaximumVelocity());
        out.setDescription(in.getDescription());
        out.setPcuEquivalents(in.getPcuEquivalents());
        out.setLength(in.getLength());
        out.setWidth(in.getLength());
        out.setFlowEfficiencyFactor(in.getFlowEfficiencyFactor());
        out.setNetworkMode(in.getNetworkMode());
        // (all the deprecated setters are copied via the attributes!)
        AttributesUtils.copyAttributesFromTo(in, out);

        CostInformation cost = in.getCostInformation();
        out.getCostInformation().setCostsPerSecond(cost.getCostsPerSecond()).setCostsPerMeter(cost.getCostsPerMeter()).setFixedCost(cost.getFixedCosts());
        AttributesUtils.copyAttributesFromTo(cost, out.getCostInformation());

        VehicleCapacity cap = in.getCapacity();
        out.getCapacity().setWeightInTons(cap.getWeightInTons()).setSeats(cap.getSeats()).setSeats(cap.getStandingRoom()).setVolumeInCubicMeters(cap.getVolumeInCubicMeters());
        AttributesUtils.copyAttributesFromTo(cap, out.getCapacity());

        AttributesUtils.copyAttributesFromTo(in.getEngineInformation(), out.getEngineInformation());

    }

Here is the call graph for this function:

hasVehicleId()

static boolean org.matsim.vehicles.VehicleUtils.hasVehicleId ( Person  person, String  mode  )

static

Checks whether a person has a vehicle id for mode - without throwing an exception if not.

Parameters

person	the person one wants to check for a vehicle id
mode	the mode for the vehicle id to check

Returns

whether person has a vehicle id for that mode

See also

VehicleUtils#getVehicleId(Person, String)

Definition at line 136 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), org.matsim.utils.objectattributes.attributable.Attributable.getAttributes(), org.matsim.vehicles.PersonVehicles.getVehicle(), and org.matsim.vehicles.VehicleUtils.VEHICLE_ATTRIBUTE_KEY.

                                                                   {
        PersonVehicles personVehicles = (PersonVehicles) person.getAttributes().getAttribute(VehicleUtils.VEHICLE_ATTRIBUTE_KEY);
        return personVehicles != null && personVehicles.getVehicle(mode) != null;
    }

Here is the call graph for this function:

getVehicleIds()

static Map<String, Id<Vehicle> > org.matsim.vehicles.VehicleUtils.getVehicleIds ( Person  person )

static

Retrieves vehicleIds of all vehicles that are assigned to the person.

Parameters

person

the person one wants to retrieve vehicles for

Returns

vehicle ids mapped to the mode the respective vehicle may be used for

Exceptions

RuntimeException

In case no vehicleIds were set

Definition at line 148 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), org.matsim.utils.objectattributes.attributable.Attributable.getAttributes(), and org.matsim.vehicles.VehicleUtils.VEHICLE_ATTRIBUTE_KEY.

Referenced by org.matsim.vehicles.VehicleUtils.getVehicleId().

                                                                        {
        var personVehicles = (PersonVehicles) person.getAttributes().getAttribute(VehicleUtils.VEHICLE_ATTRIBUTE_KEY);
        if (personVehicles == null) {
            throw new RuntimeException("Could not retrieve vehicle id from person: " + person.getId().toString() +
                                   ". \nIf you are not using config.qsim().getVehicleSource() with 'defaultVehicle' or 'modeVehicleTypesFromVehiclesData' you have to provide " +
                                   "a vehicle for each mode for each person. Attach a PersonVehicles instance (containing a map of mode:String -> id:Id<Vehicle>) with key 'vehicles' as person attribute to each person." +
                                   "\n VehicleUtils.insertVehicleIdIntoAttributes does this for you.");
        }
        return personVehicles.getModeVehicles();
    }

Here is the call graph for this function:

getVehicleTypes()

static Map<String, Id<VehicleType> > org.matsim.vehicles.VehicleUtils.getVehicleTypes ( Person  person )

static

Retrieve the optional vehicle types per mode that might be assigned to a person. Returns null if this is not defined.

Definition at line 163 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), org.matsim.utils.objectattributes.attributable.Attributable.getAttributes(), and org.matsim.vehicles.VehicleUtils.VEHICLE_TYPES_ATTRIBUTE_KEY.

Referenced by org.matsim.core.controler.PrepareForSimImpl.createAndAddVehiclesForEveryNetworkMode().

                                                                              {
        var personVehicles = (PersonVehicleTypes) person.getAttributes().getAttribute(VehicleUtils.VEHICLE_TYPES_ATTRIBUTE_KEY);
        return personVehicles != null ? personVehicles.getModeVehicleTypes() : null;
    }

Here is the call graph for this function:

getVehicleId()

static Id<Vehicle> org.matsim.vehicles.VehicleUtils.getVehicleId ( Person  person, String  mode  )

static

Retrieves a vehicleId from the person's attributes.

Returns

the vehicleId of the person's vehicle for the specified mode

Exceptions

RuntimeException

In case no vehicleIds were set or in case no vehicleId was set for the specified mode

Definition at line 174 of file VehicleUtils.java.

References org.matsim.vehicles.VehicleUtils.getVehicleIds().

Referenced by org.matsim.core.mobsim.qsim.agents.PopulationAgentSource.insertVehicles(), and org.matsim.core.router.NetworkRoutingInclAccessEgressModule.toString().

                                                                       {
        Map<String, Id<Vehicle>> vehicleIds = getVehicleIds(person);
        if (!vehicleIds.containsKey(mode)) {
            throw new RuntimeException("Could not retrieve vehicle id from person: " + person.getId().toString() + " for mode: " + mode +
                                   ". \nIf you are not using config.qsim().getVehicleSource() with 'defaultVehicle' or 'modeVehicleTypesFromVehiclesData' you have to provide " +
                                   "a vehicle for each mode for each person. Attach a PersonVehicles instance (containing a map of mode:String -> id:Id<Vehicle>) with key 'vehicles' as person attribute to each person." +
                                   "\n VehicleUtils.insertVehicleIdIntoAttributes does this for you."
            );
        }
        return vehicleIds.get(mode);
    }

Here is the call graph for this function:

insertVehicleIdsIntoAttributes()

static void org.matsim.vehicles.VehicleUtils.insertVehicleIdsIntoAttributes ( Person  person, Map< String, Id< Vehicle >>  modeToVehicle  )

static

Attaches vehicle ids to a person, so that the router knows which vehicle to use for which mode and person.

Parameters

modeToVehicle

mode string mapped to vehicle ids. The provided map is copied and stored as unmodifiable map. If a mode key already exists in the persons's attributes it is overridden. Otherwise, existing and provided values are merged into one map We use PersonVehicle Class in order to have a dedicated PersonVehicleAttributeConverter to/from XML

Deprecated:

inline to more expressive method

Definition at line 197 of file VehicleUtils.java.

References org.matsim.vehicles.VehicleUtils.insertVehicleIdsIntoPersonAttributes().

Referenced by org.matsim.core.controler.PrepareForSimImpl.createAndAddVehiclesForEveryNetworkMode().

                                                                                                            {
        insertVehicleIdsIntoPersonAttributes( person, modeToVehicle );
    }

Here is the call graph for this function:

insertVehicleIdsIntoPersonAttributes()

static void org.matsim.vehicles.VehicleUtils.insertVehicleIdsIntoPersonAttributes ( Person  person, Map< String, Id< Vehicle >>  modeToVehicle  )

static

Attaches vehicle ids to a person, so that the router knows which vehicle to use for which mode and person.

Parameters

modeToVehicle

mode string mapped to vehicle ids. The provided map is copied and stored as unmodifiable map. If a mode key already exists in the persons's attributes it is overridden. Otherwise, existing and provided values are merged into one map We use PersonVehicle Class in order to have a dedicated PersonVehicleAttributeConverter to/from XML

Definition at line 208 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), org.matsim.utils.objectattributes.attributable.Attributable.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

Referenced by org.matsim.vehicles.VehicleUtils.insertVehicleIdsIntoAttributes(), org.matsim.core.population.PersonUtils.insertVehicleIdsIntoPersonAttributes(), and org.matsim.core.population.PopulationUtils.insertVehicleIdsIntoPersonAttributes().

                                                                                                                   {
        Object attr = person.getAttributes().getAttribute(VEHICLE_ATTRIBUTE_KEY);
        // copy in case it's a UnmodifiableMap
        Map<String, Id<Vehicle>> modeToVehicleCopy = new HashMap<>(modeToVehicle);
        PersonVehicles personVehicles;
        if (attr == null) {
            personVehicles = new PersonVehicles();
        } else {
            personVehicles = (PersonVehicles) attr;
        }
        personVehicles.addModeVehicleList(modeToVehicleCopy);
        person.getAttributes().putAttribute(VEHICLE_ATTRIBUTE_KEY, personVehicles);
    }

Here is the call graph for this function:

insertVehicleTypesIntoAttributes()

static void org.matsim.vehicles.VehicleUtils.insertVehicleTypesIntoAttributes ( Person  person, Map< String, Id< VehicleType >>  modeToVehicleType  )

static

Attaches vehicle types to a person, so that the router knows which vehicle to use for which mode and person.

Parameters

modeToVehicleType

mode string mapped to vehicle type ids. The provided map is copied and stored as unmodifiable map.

Deprecated:

please inline to more expressive method name

Definition at line 228 of file VehicleUtils.java.

References org.matsim.vehicles.VehicleUtils.insertVehicleTypesIntoPersonAttributes().

                                                                                                                       {
        insertVehicleTypesIntoPersonAttributes( person, modeToVehicleType );
    }

Here is the call graph for this function:

insertVehicleTypesIntoPersonAttributes()

static void org.matsim.vehicles.VehicleUtils.insertVehicleTypesIntoPersonAttributes ( Person  person, Map< String, Id< VehicleType >>  modeToVehicleType  )

static

Attaches vehicle types to a person, so that the router knows which vehicle to use for which mode and person.

Parameters

modeToVehicleType

mode string mapped to vehicle type ids. The provided map is copied and stored as unmodifiable map.

Definition at line 235 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), org.matsim.utils.objectattributes.attributable.Attributable.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

Referenced by org.matsim.vehicles.VehicleUtils.insertVehicleTypesIntoAttributes(), org.matsim.core.population.PersonUtils.insertVehicleTypesIntoPersonAttributes(), and org.matsim.core.population.PopulationUtils.insertVehicleTypesIntoPersonAttributes().

                                                                                                                             {
        Object attr = person.getAttributes().getAttribute(VEHICLE_TYPES_ATTRIBUTE_KEY);

        Map<String, Id<VehicleType>> modeToTypesCopy = new HashMap<>(modeToVehicleType);
        PersonVehicleTypes personVehiclesTypes;
        if (attr == null) {
            personVehiclesTypes = new PersonVehicleTypes();
        } else {
            personVehiclesTypes = (PersonVehicleTypes) attr;
        }
        personVehiclesTypes.putModeVehicleTypes(modeToTypesCopy);
        person.getAttributes().putAttribute(VEHICLE_TYPES_ATTRIBUTE_KEY, personVehiclesTypes);
    }

Here is the call graph for this function:

getDoorOperationMode()

static VehicleType.DoorOperationMode org.matsim.vehicles.VehicleUtils.getDoorOperationMode ( VehicleType  vehicleType )

static

Definition at line 251 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), org.matsim.vehicles.VehicleType.getAttributes(), org.matsim.vehicles.VehicleType.getId(), org.matsim.vehicles.VehicleType.DoorOperationMode.parallel, and org.matsim.vehicles.VehicleType.DoorOperationMode.serial.

Referenced by org.matsim.vehicles.VehicleType.getDoorOperationMode(), and org.matsim.vehicles.VehicleWriterV1.writeVehicleTypes().

                                                                                               {
        final Object attribute = vehicleType.getAttributes().getAttribute( DOOR_OPERATION_MODE );
        if ( attribute==null ) {
            return VehicleType.DoorOperationMode.serial; // this was the default value in V1; could also return null instead.
        } else if (attribute instanceof VehicleType.DoorOperationMode ){
            return (VehicleType.DoorOperationMode) attribute;
        } else if (attribute instanceof String) {
            String modeString = (String) attribute;
            if ( VehicleType.DoorOperationMode.serial.toString().equalsIgnoreCase(modeString )) {
                return VehicleType.DoorOperationMode.serial;
            } else if ( VehicleType.DoorOperationMode.parallel.toString().equalsIgnoreCase(modeString )) {
                return VehicleType.DoorOperationMode.parallel;
            } else {
                throw new IllegalArgumentException("VehicleType " + vehicleType.getId().toString() + " : Door operation mode " + modeString + "is not supported");
            }
        }
        else {
            throw new RuntimeException("Type of " + attribute + "is not supported here");
        }
    }

Here is the call graph for this function:

setDoorOperationMode()

static void org.matsim.vehicles.VehicleUtils.setDoorOperationMode ( VehicleType  vehicleType, VehicleType.DoorOperationMode  mode  )

static

Definition at line 272 of file VehicleUtils.java.

References org.matsim.vehicles.VehicleType.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

Referenced by org.matsim.vehicles.VehicleType.setDoorOperationMode().

                                                                                                          {
        vehicleType.getAttributes().putAttribute( DOOR_OPERATION_MODE, mode ) ;
    }

Here is the call graph for this function:

getEgressTime()

static double org.matsim.vehicles.VehicleUtils.getEgressTime ( VehicleType  vehicleType )

static

Definition at line 276 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), and org.matsim.vehicles.VehicleType.getAttributes().

Referenced by org.matsim.vehicles.VehicleType.getEgressTime(), and org.matsim.vehicles.VehicleWriterV1.writeVehicleTypes().

                                                                {
        final Object attribute = vehicleType.getAttributes().getAttribute( EGRESSTIME );
        if ( attribute==null ) {
            return 1.0 ; // this was the default value in V1; could also return Double-null instead.
        } else {
            return (double) attribute;
        }
    }

Here is the call graph for this function:

setEgressTime()

static void org.matsim.vehicles.VehicleUtils.setEgressTime ( VehicleType  vehicleType, double  egressTime  )

static

Definition at line 285 of file VehicleUtils.java.

References org.matsim.vehicles.VehicleType.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

Referenced by org.matsim.vehicles.VehicleType.setEgressTime().

                                                                                 {
        vehicleType.getAttributes().putAttribute(EGRESSTIME, egressTime);
    }

Here is the call graph for this function:

getAccessTime()

static double org.matsim.vehicles.VehicleUtils.getAccessTime ( VehicleType  vehicleType )

static

Definition at line 289 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), and org.matsim.vehicles.VehicleType.getAttributes().

Referenced by org.matsim.vehicles.VehicleType.getAccessTime(), and org.matsim.vehicles.VehicleWriterV1.writeVehicleTypes().

                                                                {
        final Object attribute = vehicleType.getAttributes().getAttribute( ACCESSTIME );
        if ( attribute==null ) {
            return 1.0 ; // this was the default value in V1; could also return Double-null instead.
        } else {
            return (double) attribute ;
        }
    }

Here is the call graph for this function:

setAccessTime()

static void org.matsim.vehicles.VehicleUtils.setAccessTime ( VehicleType  vehicleType, double  accessTime  )

static

Definition at line 298 of file VehicleUtils.java.

References org.matsim.vehicles.VehicleType.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

Referenced by org.matsim.vehicles.VehicleType.setAccessTime().

                                                                                 {
        vehicleType.getAttributes().putAttribute(ACCESSTIME, accessTime);
    }

Here is the call graph for this function:

getFuelConsumption()

static Double org.matsim.vehicles.VehicleUtils.getFuelConsumption ( VehicleType  vehicleType )

static

Deprecated:

use getFuelConsumptionPerMeter instead

Definition at line 306 of file VehicleUtils.java.

References org.matsim.vehicles.VehicleType.getEngineInformation(), and org.matsim.vehicles.VehicleUtils.getFuelConsumptionLitersPerMeter().

Referenced by org.matsim.vehicles.VehicleUtils.createVehicle(), org.matsim.vehicles.EngineInformation.getFuelConsumption(), and org.matsim.vehicles.VehicleWriterV1.writeEngineInformation().

                                                                     {
        return getFuelConsumptionLitersPerMeter(vehicleType.getEngineInformation());
    }

Here is the call graph for this function:

setFuelConsumption()

static void org.matsim.vehicles.VehicleUtils.setFuelConsumption ( VehicleType  vehicleType, double  literPerMeter  )

static

Deprecated:

use setFuelConsumptionPerMeter instead

Definition at line 314 of file VehicleUtils.java.

References org.matsim.vehicles.VehicleType.getEngineInformation(), and org.matsim.vehicles.VehicleUtils.setFuelConsumptionLitersPerMeter().

Referenced by org.matsim.vehicles.VehicleUtils.createVehicle(), and org.matsim.vehicles.EngineInformation.setFuelConsumption().

                                                                                         {
        setFuelConsumptionLitersPerMeter(vehicleType.getEngineInformation(), literPerMeter);
    }

Here is the call graph for this function:

getHbefaTechnology()

static String org.matsim.vehicles.VehicleUtils.getHbefaTechnology ( EngineInformation  ei )

static

Definition at line 320 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), and org.matsim.vehicles.EngineInformation.getAttributes().

                                                                   {
        return (String) ei.getAttributes().getAttribute( HBEFA_TECHNOLOGY ) ;
    }

Here is the call graph for this function:

setHbefaTechnology()

static void org.matsim.vehicles.VehicleUtils.setHbefaTechnology ( EngineInformation  engineInformation, String  hbefaTechnology  )

static

Definition at line 323 of file VehicleUtils.java.

References org.matsim.vehicles.EngineInformation.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

                                                                                                         {
        engineInformation.getAttributes().putAttribute( HBEFA_TECHNOLOGY, hbefaTechnology ) ;
    }

Here is the call graph for this function:

getHbefaVehicleCategory()

static String org.matsim.vehicles.VehicleUtils.getHbefaVehicleCategory ( EngineInformation  ei )

static

Definition at line 327 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), and org.matsim.vehicles.EngineInformation.getAttributes().

                                                                        {
        return (String) ei.getAttributes().getAttribute( HBEFA_VEHICLE_CATEGORY_ ) ;
    }

Here is the call graph for this function:

setHbefaVehicleCategory()

static void org.matsim.vehicles.VehicleUtils.setHbefaVehicleCategory ( EngineInformation  engineInformation, String  hbefaVehicleCategory  )

static

Definition at line 330 of file VehicleUtils.java.

References org.matsim.vehicles.EngineInformation.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

                                                                                                                   {
        engineInformation.getAttributes().putAttribute( HBEFA_VEHICLE_CATEGORY_, hbefaVehicleCategory ) ;
    }

Here is the call graph for this function:

getHbefaSizeClass()

static String org.matsim.vehicles.VehicleUtils.getHbefaSizeClass ( EngineInformation  ei )

static

Definition at line 334 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), and org.matsim.vehicles.EngineInformation.getAttributes().

                                                                   {
        return (String) ei.getAttributes().getAttribute(HBEFA_SIZE_CLASS);
    }

Here is the call graph for this function:

setHbefaSizeClass()

static void org.matsim.vehicles.VehicleUtils.setHbefaSizeClass ( EngineInformation  engineInformation, String  hbefaSizeClass  )

static

Definition at line 337 of file VehicleUtils.java.

References org.matsim.vehicles.EngineInformation.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

                                                                                                       {
        engineInformation.getAttributes().putAttribute( HBEFA_SIZE_CLASS, hbefaSizeClass ) ;
    }

Here is the call graph for this function:

getHbefaEmissionsConcept()

static String org.matsim.vehicles.VehicleUtils.getHbefaEmissionsConcept ( EngineInformation  ei )

static

Definition at line 341 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), and org.matsim.vehicles.EngineInformation.getAttributes().

                                                                          {
        return (String) ei.getAttributes().getAttribute(HBEFA_EMISSIONS_CONCEPT);
    }

Here is the call graph for this function:

setHbefaEmissionsConcept()

static void org.matsim.vehicles.VehicleUtils.setHbefaEmissionsConcept ( EngineInformation  engineInformation, String  emissionsConcept  )

static

Definition at line 344 of file VehicleUtils.java.

References org.matsim.vehicles.EngineInformation.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

                                                                                                                {
        engineInformation.getAttributes().putAttribute( HBEFA_EMISSIONS_CONCEPT, emissionsConcept ) ;
    }

Here is the call graph for this function:

getEnergyConsumptionKWhPerMeter()

static Double org.matsim.vehicles.VehicleUtils.getEnergyConsumptionKWhPerMeter ( EngineInformation  engineInformation )

static

Definition at line 348 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), and org.matsim.vehicles.EngineInformation.getAttributes().

                                                                                              {
        return (Double) engineInformation.getAttributes().getAttribute(ENERGYCONSUMPTION);
    }

Here is the call graph for this function:

setEnergyConsumptionKWhPerMeter()

static void org.matsim.vehicles.VehicleUtils.setEnergyConsumptionKWhPerMeter ( EngineInformation  engineInformation, double  energyConsumptionKWhPerMeter  )

static

Definition at line 352 of file VehicleUtils.java.

References org.matsim.vehicles.EngineInformation.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

                                                                                                                                 {
        engineInformation.getAttributes().putAttribute(ENERGYCONSUMPTION, energyConsumptionKWhPerMeter);
    }

Here is the call graph for this function:

getFuelConsumptionLitersPerMeter()

static Double org.matsim.vehicles.VehicleUtils.getFuelConsumptionLitersPerMeter ( EngineInformation  engineInformation )

static

Definition at line 356 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), and org.matsim.vehicles.EngineInformation.getAttributes().

Referenced by org.matsim.vehicles.VehicleUtils.getFuelConsumption().

                                                                                               {
        return (Double) engineInformation.getAttributes().getAttribute(FUELCONSUMPTION);
    }

Here is the call graph for this function:

setFuelConsumptionLitersPerMeter()

static void org.matsim.vehicles.VehicleUtils.setFuelConsumptionLitersPerMeter ( EngineInformation  engineInformation, double  fuelConsumptionLitersPerMeter  )

static

Definition at line 360 of file VehicleUtils.java.

References org.matsim.vehicles.EngineInformation.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

Referenced by org.matsim.vehicles.VehicleUtils.setFuelConsumption().

                                                                                                                                   {
        engineInformation.getAttributes().putAttribute(FUELCONSUMPTION, fuelConsumptionLitersPerMeter);
    }

Here is the call graph for this function:

getEnergyCapacity()

static Double org.matsim.vehicles.VehicleUtils.getEnergyCapacity ( EngineInformation  engineInformation )

static

Definition at line 364 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), and org.matsim.vehicles.EngineInformation.getAttributes().

                                                                                {
        return (Double) engineInformation.getAttributes().getAttribute(ENERGYCAPACITY);
    }

Here is the call graph for this function:

setEnergyCapacity()

static void org.matsim.vehicles.VehicleUtils.setEnergyCapacity ( EngineInformation  engineInformation, double  energyCapacityInKWhOrLiters  )

static

Definition at line 368 of file VehicleUtils.java.

References org.matsim.vehicles.EngineInformation.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

                                                                                                                  {
        engineInformation.getAttributes().putAttribute(ENERGYCAPACITY, energyCapacityInKWhOrLiters);
    }

Here is the call graph for this function:

getCostsPerSecondWaiting()

static Double org.matsim.vehicles.VehicleUtils.getCostsPerSecondWaiting ( CostInformation  costInformation )

static

Definition at line 373 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), and org.matsim.vehicles.CostInformation.getAttributes().

                                                                                   {
        return (Double) costInformation.getAttributes().getAttribute(COST_PER_SECOND_WAITING);
    }

Here is the call graph for this function:

setCostsPerSecondWaiting()

static void org.matsim.vehicles.VehicleUtils.setCostsPerSecondWaiting ( CostInformation  costInformation, double  costsPerSecond  )

static

Definition at line 378 of file VehicleUtils.java.

References org.matsim.vehicles.CostInformation.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

                                                                                                        {
        costInformation.getAttributes().putAttribute(COST_PER_SECOND_WAITING, costsPerSecond);
    }

Here is the call graph for this function:

getCostsPerSecondInService()

static Double org.matsim.vehicles.VehicleUtils.getCostsPerSecondInService ( CostInformation  costInformation )

static

Definition at line 383 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), and org.matsim.vehicles.CostInformation.getAttributes().

                                                                                     {
        return (Double) costInformation.getAttributes().getAttribute(COST_PER_SECOND_INSERVICE);
    }

Here is the call graph for this function:

setCostsPerSecondInService()

static void org.matsim.vehicles.VehicleUtils.setCostsPerSecondInService ( CostInformation  costInformation, double  costsPerSecond  )

static

Definition at line 388 of file VehicleUtils.java.

References org.matsim.vehicles.CostInformation.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

                                                                                                          {
        costInformation.getAttributes().putAttribute(COST_PER_SECOND_INSERVICE, costsPerSecond);
    }

Here is the call graph for this function:

createVehicle()

static Vehicle org.matsim.vehicles.VehicleUtils.createVehicle ( Id< Vehicle >  id, VehicleType  type  )

static

Definition at line 392 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), org.matsim.vehicles.EngineInformation.getAttributes(), org.matsim.vehicles.VehicleUtils.getFuelConsumption(), org.matsim.utils.objectattributes.attributable.Attributes.putAttribute(), and org.matsim.vehicles.VehicleUtils.setFuelConsumption().

                                                                            {
        return new VehicleImpl( id , type );
    }

Here is the call graph for this function:

getOrCreateAllvehicles()

static Vehicles org.matsim.vehicles.VehicleUtils.getOrCreateAllvehicles ( Scenario  scenario )

static

Definition at line 428 of file VehicleUtils.java.

References org.matsim.api.core.v01.Scenario.addScenarioElement(), and org.matsim.api.core.v01.Scenario.getScenarioElement().

Referenced by org.matsim.vehicles.VehicleUtils.findVehicle().

                                                                        {
        Vehicles map = (Vehicles) scenario.getScenarioElement( "allvehicles" );
        if ( map==null ) {
            log.info( "adding scenario element for allvehicles container" );
            map = new VehiclesImpl();
            scenario.addScenarioElement("allvehicles" , map);
        }
        return map;
    }

Here is the call graph for this function:

findVehicle()

static Vehicle org.matsim.vehicles.VehicleUtils.findVehicle ( Id< Vehicle >  vehicleId, Scenario  scenario  )

static

Definition at line 439 of file VehicleUtils.java.

References org.matsim.core.gbl.Gbl.FUTURE_SUPPRESSED, org.matsim.vehicles.VehicleUtils.getOrCreateAllvehicles(), org.matsim.api.core.v01.Scenario.getTransitVehicles(), org.matsim.vehicles.Vehicles.getVehicles(), and org.matsim.api.core.v01.Scenario.getVehicles().

                                                                                 {
        Vehicle vehicle = getOrCreateAllvehicles( scenario ).getVehicles().get( vehicleId );
        if ( vehicle==null ) {
            if ( tryStdCnt>0){
                tryStdCnt--;
                log.info("vehicleId={} not in allVehicles; trying standard vehicles container ...", vehicleId);
                if ( tryStdCnt==0 ) {
                    log.info( Gbl.FUTURE_SUPPRESSED );
                }
            }
            vehicle = scenario.getVehicles().getVehicles().get(  vehicleId );
        }
        if ( vehicle==null ) {
            if ( tryTrnCnt>0 ) {
                tryTrnCnt--;
                log.info("vehicleId={} not in allVehicles; trying transit vehicles container ...", vehicleId);
                if ( tryTrnCnt==0 ) {
                    log.info(  Gbl.FUTURE_SUPPRESSED );
                }
            }
            vehicle = scenario.getTransitVehicles().getVehicles().get(  vehicleId );
        }
        if ( vehicle==null ) {
            log.info("unable to find vehicle for vehicleId={}; will return null", vehicleId);
        }
        return vehicle ;
    }

Here is the call graph for this function:

writeVehicles()

static void org.matsim.vehicles.VehicleUtils.writeVehicles ( Vehicles  vehicles, String  filename  )

static

Definition at line 466 of file VehicleUtils.java.

References org.matsim.vehicles.MatsimVehicleWriter.writeFile().

                                                                           {
        new MatsimVehicleWriter( vehicles ).writeFile( filename );

    }

Here is the call graph for this function:

getInitialLinkId()

static Id<Link> org.matsim.vehicles.VehicleUtils.getInitialLinkId ( Vehicle  vehicle )

static

Definition at line 471 of file VehicleUtils.java.

References org.matsim.api.core.v01.Id< T >.createLinkId(), org.matsim.utils.objectattributes.attributable.Attributes.getAttribute(), and org.matsim.utils.objectattributes.attributable.Attributable.getAttributes().

Referenced by org.matsim.core.mobsim.qsim.agents.PopulationAgentSource.findVehicleLink().

                                                             {
        String attribute = (String) vehicle.getAttributes().getAttribute(INITIAL_LINK_ID);
        return attribute == null ? null : Id.createLinkId(attribute);
    }

Here is the call graph for this function:

setInitialLinkId()

static void org.matsim.vehicles.VehicleUtils.setInitialLinkId ( Vehicle  vehicle, Id< Link >  initialLinkId  )

static

Definition at line 476 of file VehicleUtils.java.

References org.matsim.utils.objectattributes.attributable.Attributable.getAttributes(), and org.matsim.utils.objectattributes.attributable.Attributes.putAttribute().

                                                                                 {
        vehicle.getAttributes().putAttribute(INITIAL_LINK_ID, initialLinkId.toString());
    }

Here is the call graph for this function:

Member Data Documentation

log

final Logger org.matsim.vehicles.VehicleUtils.log = LogManager.getLogger( VehicleUtils.class )

staticprivate

Definition at line 42 of file VehicleUtils.java.

DEFAULT_VEHICLE_TYPE_ID

final String org.matsim.vehicles.VehicleUtils.DEFAULT_VEHICLE_TYPE_ID = "defaultVehicleType"

staticprivate

Definition at line 44 of file VehicleUtils.java.

VEHICLE_ATTRIBUTE_KEY

final String org.matsim.vehicles.VehicleUtils.VEHICLE_ATTRIBUTE_KEY = "vehicles"

staticprivate

Definition at line 45 of file VehicleUtils.java.

Referenced by org.matsim.vehicles.VehicleUtils.getVehicleIds(), and org.matsim.vehicles.VehicleUtils.hasVehicleId().

VEHICLE_TYPES_ATTRIBUTE_KEY

final String org.matsim.vehicles.VehicleUtils.VEHICLE_TYPES_ATTRIBUTE_KEY = "vehicleTypes"

staticprivate

Definition at line 46 of file VehicleUtils.java.

Referenced by org.matsim.vehicles.VehicleUtils.getVehicleTypes().

DOOR_OPERATION_MODE

final String org.matsim.vehicles.VehicleUtils.DOOR_OPERATION_MODE = "doorOperationMode"

staticprivate

Definition at line 49 of file VehicleUtils.java.

EGRESSTIME

final String org.matsim.vehicles.VehicleUtils.EGRESSTIME = "egressTimeInSecondsPerPerson"

staticprivate

Definition at line 50 of file VehicleUtils.java.

ACCESSTIME

final String org.matsim.vehicles.VehicleUtils.ACCESSTIME = "accessTimeInSecondsPerPerson"

staticprivate

Definition at line 51 of file VehicleUtils.java.

FUELCONSUMPTION

final String org.matsim.vehicles.VehicleUtils.FUELCONSUMPTION = "fuelConsumptionLitersPerMeter"

staticprivate

Definition at line 52 of file VehicleUtils.java.

ENERGYCONSUMPTION

final String org.matsim.vehicles.VehicleUtils.ENERGYCONSUMPTION = "energyConsumptionKWhPerMeter"

staticprivate

Definition at line 53 of file VehicleUtils.java.

ENERGYCAPACITY

final String org.matsim.vehicles.VehicleUtils.ENERGYCAPACITY = "energyCapacityInKWhOrLiters"

staticprivate

Definition at line 54 of file VehicleUtils.java.

HBEFA_VEHICLE_CATEGORY_

final String org.matsim.vehicles.VehicleUtils.HBEFA_VEHICLE_CATEGORY_ = "HbefaVehicleCategory"

staticprivate

Definition at line 55 of file VehicleUtils.java.

HBEFA_TECHNOLOGY

final String org.matsim.vehicles.VehicleUtils.HBEFA_TECHNOLOGY = "HbefaTechnology"

staticprivate

Definition at line 56 of file VehicleUtils.java.

HBEFA_SIZE_CLASS

final String org.matsim.vehicles.VehicleUtils.HBEFA_SIZE_CLASS = "HbefaSizeClass"

staticprivate

Definition at line 57 of file VehicleUtils.java.

HBEFA_EMISSIONS_CONCEPT

final String org.matsim.vehicles.VehicleUtils.HBEFA_EMISSIONS_CONCEPT = "HbefaEmissionsConcept"

staticprivate

Definition at line 58 of file VehicleUtils.java.

COST_PER_SECOND_WAITING

final String org.matsim.vehicles.VehicleUtils.COST_PER_SECOND_WAITING = "costsPerSecondWaiting"

staticprivate

Definition at line 59 of file VehicleUtils.java.

COST_PER_SECOND_INSERVICE

final String org.matsim.vehicles.VehicleUtils.COST_PER_SECOND_INSERVICE = "costsPerSecondInService"

staticprivate

Definition at line 60 of file VehicleUtils.java.

FUEL_TYPE

final String org.matsim.vehicles.VehicleUtils.FUEL_TYPE = "fuelType"

staticprivate

Definition at line 61 of file VehicleUtils.java.

INITIAL_LINK_ID

final String org.matsim.vehicles.VehicleUtils.INITIAL_LINK_ID = "initialLinkId"

staticprivate

Definition at line 62 of file VehicleUtils.java.

tryStdCnt

int org.matsim.vehicles.VehicleUtils.tryStdCnt = 5

staticprivate

Definition at line 437 of file VehicleUtils.java.

tryTrnCnt

int org.matsim.vehicles.VehicleUtils.tryTrnCnt = 5

staticprivate

Definition at line 438 of file VehicleUtils.java.

---

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

• vehicles/VehicleUtils.java