Inheritance diagram for org.matsim.facilities.ActivityFacilityImpl:

Public Member Functions
final double	calcDistance (Coord otherCoord)

final ActivityOptionImpl	createAndAddActivityOption (final String type)

final void	addActivityOption (ActivityOption option)

final void	setCoord (Coord newCoord)

final void	setDesc (String desc)

final String	getDesc ()

final Map< String, ActivityOption >	getActivityOptions ()

final Id< Link >	getLinkId ()

final void	setLinkId (Id< Link > linkId)

final String	toString ()

final Coord	getCoord ()

final Id< ActivityFacility >	getId ()

final Map< String, Object >	getCustomAttributes ()

void	setLocked ()

Attributes	getAttributes ()

Static Public Attributes
static final String	FACILITY_NO_LONGER_IDENTIFIABLE

Protected Member Functions
	ActivityFacilityImpl (final Id< ActivityFacility > id, final Coord center, final Id< Link > linkId)

Private Member Functions
void	testForLocked ()

Private Attributes
Customizable	customizableDelegate

final Map< String, ActivityOption >	activities = new TreeMap<>()

String	desc = null

Coord	coord

Id< ActivityFacility >	id

Id< Link >	linkId

boolean	locked = false

final Attributes	attributes = new AttributesImpl()

Detailed Description

maintainer: mrieser / Senozon AG

Definition at line 40 of file ActivityFacilityImpl.java.

Constructor & Destructor Documentation

◆ ActivityFacilityImpl()

org.matsim.facilities.ActivityFacilityImpl.ActivityFacilityImpl	(	final Id< ActivityFacility >	id,
		final Coord	center,
		final Id< Link >	linkId
	)

protected

Deliberately protected, see MatsimDataClassImplMarkerInterface

Parameters

id
center

Definition at line 73 of file ActivityFacilityImpl.java.

References org.matsim.facilities.ActivityFacilityImpl.id, and org.matsim.facilities.ActivityFacilityImpl.linkId.

                                                                                                              {
         this.id = id;
         this.coord = center;
         this.linkId = linkId;
     }

Member Function Documentation

◆ calcDistance()

final double org.matsim.facilities.ActivityFacilityImpl.calcDistance ( Coord otherCoord )

Definition at line 79 of file ActivityFacilityImpl.java.

References org.matsim.core.utils.geometry.CoordUtils.calcEuclideanDistance().

                                                        {
         return CoordUtils.calcEuclideanDistance(this.coord, otherCoord);
     }

Here is the call graph for this function:

◆ createAndAddActivityOption()

final ActivityOptionImpl org.matsim.facilities.ActivityFacilityImpl.createAndAddActivityOption ( final String type )

Definition at line 83 of file ActivityFacilityImpl.java.

References org.matsim.facilities.ActivityFacilityImpl.addActivityOption().

                                                                                   {
         String type2 = type.intern();
         ActivityOptionImpl a = new ActivityOptionImpl(type2);
         addActivityOption(a);
         return a;
     }

Here is the call graph for this function:

◆ addActivityOption()

final void org.matsim.facilities.ActivityFacilityImpl.addActivityOption ( ActivityOption option )

Implements org.matsim.facilities.ActivityFacility.

Definition at line 91 of file ActivityFacilityImpl.java.

References org.matsim.facilities.ActivityOption.getType().

Referenced by org.matsim.facilities.ActivityFacilityImpl.createAndAddActivityOption().

                                                                {
         String type = option.getType() ;
         if (this.activities.containsKey(type)) {
             throw new RuntimeException(this + "[type=" + type + " already exists]");
         }
         this.activities.put(type, option);
     }

Here is the call graph for this function:

◆ setCoord()

final void org.matsim.facilities.ActivityFacilityImpl.setCoord ( Coord newCoord )

Implements org.matsim.facilities.ActivityFacility.

Definition at line 99 of file ActivityFacilityImpl.java.

References org.matsim.facilities.ActivityFacilityImpl.testForLocked().

                                                {
         testForLocked() ;
         this.coord = newCoord;
     }

Here is the call graph for this function:

◆ setDesc()

final void org.matsim.facilities.ActivityFacilityImpl.setDesc ( String desc )

Definition at line 104 of file ActivityFacilityImpl.java.

                                            {
         if (desc == null) { this.desc = null; }
         else { this.desc = desc.intern(); }
     }

◆ getDesc()

final String org.matsim.facilities.ActivityFacilityImpl.getDesc ( )

Definition at line 109 of file ActivityFacilityImpl.java.

References org.matsim.facilities.ActivityFacilityImpl.desc.

                                   {
         return this.desc;
     }

◆ getActivityOptions()

final Map<String, ActivityOption> org.matsim.facilities.ActivityFacilityImpl.getActivityOptions ( )

Implements org.matsim.facilities.ActivityFacility.

Definition at line 114 of file ActivityFacilityImpl.java.

References org.matsim.facilities.ActivityFacilityImpl.activities.

                                                                   {
         return this.activities;
     }

◆ getLinkId()

final Id<Link> org.matsim.facilities.ActivityFacilityImpl.getLinkId ( )

Implements org.matsim.facilities.Facility.

Definition at line 119 of file ActivityFacilityImpl.java.

References org.matsim.facilities.ActivityFacilityImpl.linkId.

                                       {
         return this.linkId;
     }

◆ setLinkId()

final void org.matsim.facilities.ActivityFacilityImpl.setLinkId ( Id< Link > linkId )

Definition at line 123 of file ActivityFacilityImpl.java.

References org.matsim.facilities.ActivityFacilityImpl.linkId.

                                                  {
         this.linkId = linkId;
     }

◆ toString()

final String org.matsim.facilities.ActivityFacilityImpl.toString ( )

Definition at line 128 of file ActivityFacilityImpl.java.

                                    {
         return "[" + super.toString() +
                    " ID=" + this.id +
                    "| linkID=" + this.linkId +
                    "| nof_activities=" + this.activities.size() +
                    "]";
     }

◆ getCoord()

final Coord org.matsim.facilities.ActivityFacilityImpl.getCoord ( )

Implements org.matsim.api.core.v01.BasicLocation.

Definition at line 137 of file ActivityFacilityImpl.java.

References org.matsim.facilities.ActivityFacilityImpl.coord.

                                   {
         return this.coord;
     }

◆ getId()

final Id<ActivityFacility> org.matsim.facilities.ActivityFacilityImpl.getId ( )

Implements org.matsim.api.core.v01.Identifiable< T >.

Definition at line 142 of file ActivityFacilityImpl.java.

References org.matsim.facilities.ActivityFacilityImpl.id.

Referenced by org.matsim.facilities.ActivityFacilitiesImpl.createAndAddFacility().

                                               {
         return this.id;
     }

◆ getCustomAttributes()

final Map<String, Object> org.matsim.facilities.ActivityFacilityImpl.getCustomAttributes ( )

returns a container for adding arbitrary additional information to a MATSim core object.

IMPORTANT NOTE: This container is meant to use for experiments only. Therefore, do NOT call this method from the core (org.matsim).

Returns: map for storing custom attributes

Implements org.matsim.api.core.v01.Customizable.

Definition at line 147 of file ActivityFacilityImpl.java.

References org.matsim.core.scenario.CustomizableUtils.createCustomizable(), and org.matsim.api.core.v01.Customizable.getCustomAttributes().

                                                            {
         if (this.customizableDelegate == null) {
             this.customizableDelegate = CustomizableUtils.createCustomizable();
         }
         return this.customizableDelegate.getCustomAttributes();
     }

Here is the call graph for this function:

◆ setLocked()

void org.matsim.facilities.ActivityFacilityImpl.setLocked ( )

This is to set certain properties of data objects locked when the simulations start, but allow setters for them upstream of the simulation run. Some of them are (or should be):

IDs (since the IDs are used in the Maps as keys, so changing them without removing and re-inserting the object makes the map invalid)
Some of the coordinates. This is a bit tricky, for example, activities should be able to change their coordinates because of location choice. However, nodes and facilities should not. (And location choice, in consequence, is rather changing the facility reference than changing the coordinate.)

Implements org.matsim.core.scenario.Lockable.

Definition at line 155 of file ActivityFacilityImpl.java.

                             {
         this.locked = true ;
     }

◆ testForLocked()

void org.matsim.facilities.ActivityFacilityImpl.testForLocked ( )

private

Definition at line 159 of file ActivityFacilityImpl.java.

Referenced by org.matsim.facilities.ActivityFacilityImpl.setCoord().

                                  {
         if ( this.locked ) {
             throw new RuntimeException("too late to do this") ;
         }
     }

◆ getAttributes()

Attributes org.matsim.facilities.ActivityFacilityImpl.getAttributes ( )

Implements org.matsim.utils.objectattributes.attributable.Attributable.

Definition at line 166 of file ActivityFacilityImpl.java.

References org.matsim.facilities.ActivityFacilityImpl.attributes.

                                       {
         return this.attributes;
     }

Member Data Documentation

◆ customizableDelegate

Customizable org.matsim.facilities.ActivityFacilityImpl.customizableDelegate

private

Definition at line 51 of file ActivityFacilityImpl.java.

◆ activities

final Map<String, ActivityOption> org.matsim.facilities.ActivityFacilityImpl.activities = new TreeMap<>()

private

Definition at line 53 of file ActivityFacilityImpl.java.

Referenced by org.matsim.facilities.ActivityFacilityImpl.getActivityOptions().

◆ desc

String org.matsim.facilities.ActivityFacilityImpl.desc = null

private

Definition at line 55 of file ActivityFacilityImpl.java.

Referenced by org.matsim.facilities.ActivityFacilityImpl.getDesc().

◆ coord

Coord org.matsim.facilities.ActivityFacilityImpl.coord

private

Definition at line 57 of file ActivityFacilityImpl.java.

Referenced by org.matsim.facilities.ActivityFacilityImpl.getCoord().

◆ id

Id<ActivityFacility> org.matsim.facilities.ActivityFacilityImpl.id

private

Definition at line 59 of file ActivityFacilityImpl.java.

Referenced by org.matsim.facilities.ActivityFacilityImpl.ActivityFacilityImpl(), and org.matsim.facilities.ActivityFacilityImpl.getId().

◆ linkId

Id<Link> org.matsim.facilities.ActivityFacilityImpl.linkId

private

Definition at line 61 of file ActivityFacilityImpl.java.

Referenced by org.matsim.facilities.ActivityFacilityImpl.ActivityFacilityImpl(), org.matsim.facilities.ActivityFacilityImpl.getLinkId(), and org.matsim.facilities.ActivityFacilityImpl.setLinkId().

◆ locked

boolean org.matsim.facilities.ActivityFacilityImpl.locked = false

private

Definition at line 63 of file ActivityFacilityImpl.java.

◆ attributes

final Attributes org.matsim.facilities.ActivityFacilityImpl.attributes = new AttributesImpl()

private

Definition at line 65 of file ActivityFacilityImpl.java.

Referenced by org.matsim.facilities.ActivityFacilityImpl.getAttributes().

◆ FACILITY_NO_LONGER_IDENTIFIABLE

final String org.matsim.facilities.Facility.FACILITY_NO_LONGER_IDENTIFIABLE

staticinherited

Initial value:

= "After refactoring, facility " +
                                                     "does not longer automatically " +
                                                     "implement Identifiable.  Don't know what to do."

Definition at line 40 of file Facility.java.

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

facilities/ActivityFacilityImpl.java

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ActivityFacilityImpl()

Member Function Documentation

◆ calcDistance()

◆ createAndAddActivityOption()

◆ addActivityOption()

◆ setCoord()

◆ setDesc()

◆ getDesc()

◆ getActivityOptions()

◆ getLinkId()

◆ setLinkId()

◆ toString()

◆ getCoord()

◆ getId()

◆ getCustomAttributes()

◆ setLocked()

◆ testForLocked()

◆ getAttributes()

Member Data Documentation

◆ customizableDelegate

◆ activities

◆ desc

◆ coord

◆ id

◆ linkId

◆ locked

◆ attributes

◆ FACILITY_NO_LONGER_IDENTIFIABLE