org.matsim.households.HouseholdsImpl Class Reference

Inheritance diagram for org.matsim.households.HouseholdsImpl:

Public Member Functions
	HouseholdsImpl ()
final void	addHousehold (final Household household)
HouseholdsFactory	getFactory ()
void	setFactory (HouseholdsFactory factory)
Map< Id< Household >, Household >	getHouseholds ()
ObjectAttributes	getHouseholdAttributes ()

Private Attributes
HouseholdsFactory	factory
Map< Id< Household >, Household >	households

Detailed Description

Basic implementation of the Households container, a pure data class

Author

dgrether

Definition at line 34 of file HouseholdsImpl.java.

Constructor & Destructor Documentation

HouseholdsImpl()

org.matsim.households.HouseholdsImpl.HouseholdsImpl

(

)

Definition at line 40 of file HouseholdsImpl.java.

                           {
        this.households = new LinkedHashMap<>();
        this.factory = new HouseholdsFactoryImpl();
    }

Member Function Documentation

addHousehold()

final void org.matsim.households.HouseholdsImpl.addHousehold

(

final Household

household

)

Adds the household to the container. If streaming is set, the household is added, the algorithms are run on the household, and it is subsequently removed. If not, the household is added incrementally to the container.

Parameters

household

Exceptions

IllegalArgumentException

if the container already includes the Id of the household being added.

Definition at line 54 of file HouseholdsImpl.java.

References org.matsim.households.HouseholdsImpl.getHouseholds(), and org.matsim.api.core.v01.Identifiable< T >.getId().

                                                             {
        /* Validate that a household with the same Id does not exist yet. */
        if(this.getHouseholds().containsKey(household.getId())){
            throw new IllegalArgumentException("Household with Id " + household.getId() + 
                    " already exisits.");
        }
        this.households.put(household.getId(), household);
    }

Here is the call graph for this function:

getFactory()

HouseholdsFactory org.matsim.households.HouseholdsImpl.getFactory

(

)

Implements org.matsim.households.Households.

Definition at line 64 of file HouseholdsImpl.java.

References org.matsim.households.HouseholdsImpl.factory.

                                          {
        return this.factory;
    }

setFactory()

void org.matsim.households.HouseholdsImpl.setFactory

(

HouseholdsFactory

factory

)

Definition at line 68 of file HouseholdsImpl.java.

References org.matsim.households.HouseholdsImpl.factory.

                                                      {
        this.factory = factory;
    }

getHouseholds()

Map<Id<Household>, Household> org.matsim.households.HouseholdsImpl.getHouseholds

(

)

Implements org.matsim.households.Households.

Definition at line 73 of file HouseholdsImpl.java.

References org.matsim.households.HouseholdsImpl.households.

Referenced by org.matsim.households.HouseholdsImpl.addHousehold().

                                                         {
        return this.households;
    }

getHouseholdAttributes()

ObjectAttributes org.matsim.households.HouseholdsImpl.getHouseholdAttributes

(

)

Implements org.matsim.households.Households.

Definition at line 78 of file HouseholdsImpl.java.

References org.matsim.utils.objectattributes.FailingObjectAttributes.createHouseholdsAttributes().

                                                     {
        return FailingObjectAttributes.createHouseholdsAttributes();
    }

Here is the call graph for this function:

Member Data Documentation

factory

HouseholdsFactory org.matsim.households.HouseholdsImpl.factory

private

Definition at line 36 of file HouseholdsImpl.java.

Referenced by org.matsim.households.HouseholdsImpl.getFactory(), and org.matsim.households.HouseholdsImpl.setFactory().

households

Map<Id<Household>, Household> org.matsim.households.HouseholdsImpl.households

private

Definition at line 38 of file HouseholdsImpl.java.

Referenced by org.matsim.households.HouseholdsImpl.getHouseholds().

---

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

• households/HouseholdsImpl.java