de.cesr.sesamgim.param
Enum GMilieuPa

java.lang.Object
  java.lang.Enum<GMilieuPa>
      de.cesr.sesamgim.param.GMilieuPa

All Implemented Interfaces:

de.cesr.parma.core.PmParameterDefinition, Serializable, Comparable<GMilieuPa>

public enum GMilieuPa
extends Enum<GMilieuPa>
implements de.cesr.parma.core.PmParameterDefinition

Enum Constant Summary

ADD_MILIEU_CONTEXTS_TO_ROOT_CONTEXT
IF true, milieu contexts are added directly as members (agent objects) to the root context.

ALLOW_AGENTS_TO_LEAVE_AREA_BOUNDARIES

ALLOW_AGENTS_TO_LEAVE_INHABITED_AREAS

ALLOW_AGENTS_TO_LEAVE_MC_BOUNDARIES
Setting this property to false causes SesamGIM to read in MZ shapes from GBasicPa#MZ_SHAPEFILE.

DISTRIBUTE_AGENTS_AROUND_GROUP

DISTRIBUTE_AGENTS_UNIFORMLY_IN_MC
When set to true, it is assumed that ALLOW_AGENTS_TO_LEAVE_MC_BOUNDARIES is false!

GROUP_DIST_UNIFORMLY

GROUP_FORCE_SIZE

GROUP_SIZE

MAX_STD_DEV_EXTENSION
When this standard deviation is reached by increases, the search terminates using a search with initials standard deviation and no restrictions.

MILIEU_LIFE_EXPECTANCY
Milieu specific life expectancy distributions.

MILIEU_PREF_PARAMID
Parameter ID for milieu's goal preferenceWeights

MILIEUS
Defines the indices for milieus.

NUM_HHSIZES

NUM_YEARS

STD_DEV_EXTENSION_COUNTER_TRESHOLD
Maximum number of attempts to find a point with the same standard deviation.

STD_DEV_PLACE_AGENTS
Standard deviation from the center coordinates when searching agent locations in the geography.

STD_DEV_PLACE_NEIGHBOURHOODS
Standard deviation from the center coordinates when searching group context locations in the geography.

Method Summary

Object	getDefaultValue()
Class<?>	getType()
static GMilieuPa	valueOf(String name) Returns the enum constant of this type with the specified name.
static GMilieuPa[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.cesr.parma.core.PmParameterDefinition

getDeclaringClass

Enum Constant Detail

MILIEU_PREF_PARAMID

public static final GMilieuPa MILIEU_PREF_PARAMID

Parameter ID for milieu's goal preferenceWeights

MILIEU_LIFE_EXPECTANCY

public static final GMilieuPa MILIEU_LIFE_EXPECTANCY

Milieu specific life expectancy distributions.

MILIEUS

public static final GMilieuPa MILIEUS

Defines the indices for milieus. Given the milieu's short name (i.e. "GLM"), the index may be queried from the map. Number of milieu groups needs to be consistent with defined in SqlPa#TBLNAME_MILIEU_GROUPS

NUM_HHSIZES

public static final GMilieuPa NUM_HHSIZES

NUM_YEARS

public static final GMilieuPa NUM_YEARS

ALLOW_AGENTS_TO_LEAVE_AREA_BOUNDARIES

public static final GMilieuPa ALLOW_AGENTS_TO_LEAVE_AREA_BOUNDARIES

ALLOW_AGENTS_TO_LEAVE_INHABITED_AREAS

public static final GMilieuPa ALLOW_AGENTS_TO_LEAVE_INHABITED_AREAS

ALLOW_AGENTS_TO_LEAVE_MC_BOUNDARIES

public static final GMilieuPa ALLOW_AGENTS_TO_LEAVE_MC_BOUNDARIES

Setting this property to false causes SesamGIM to read in MZ shapes from GBasicPa#MZ_SHAPEFILE.

DISTRIBUTE_AGENTS_UNIFORMLY_IN_MC

public static final GMilieuPa DISTRIBUTE_AGENTS_UNIFORMLY_IN_MC

When set to true, it is assumed that ALLOW_AGENTS_TO_LEAVE_MC_BOUNDARIES is false!

DISTRIBUTE_AGENTS_AROUND_GROUP

public static final GMilieuPa DISTRIBUTE_AGENTS_AROUND_GROUP

STD_DEV_PLACE_AGENTS

public static final GMilieuPa STD_DEV_PLACE_AGENTS

Standard deviation from the center coordinates when searching agent locations in the geography. Relative to the envelope (minimum rectangle that contains the area) of the surrounding area context.

STD_DEV_PLACE_NEIGHBOURHOODS

public static final GMilieuPa STD_DEV_PLACE_NEIGHBOURHOODS

Standard deviation from the center coordinates when searching group context locations in the geography. Relative to the envelope (minimum rectangle that contains the area) of the surrounding area context.

STD_DEV_EXTENSION_COUNTER_TRESHOLD

public static final GMilieuPa STD_DEV_EXTENSION_COUNTER_TRESHOLD

Maximum number of attempts to find a point with the same standard deviation. When this number is reached, a new random number stream with increased standard deviation is used.

MAX_STD_DEV_EXTENSION

public static final GMilieuPa MAX_STD_DEV_EXTENSION

When this standard deviation is reached by increases, the search terminates using a search with initials standard deviation and no restrictions.

GROUP_FORCE_SIZE

public static final GMilieuPa GROUP_FORCE_SIZE

GROUP_SIZE

public static final GMilieuPa GROUP_SIZE

GROUP_DIST_UNIFORMLY

public static final GMilieuPa GROUP_DIST_UNIFORMLY

ADD_MILIEU_CONTEXTS_TO_ROOT_CONTEXT

public static final GMilieuPa ADD_MILIEU_CONTEXTS_TO_ROOT_CONTEXT

IF true, milieu contexts are added directly as members (agent objects) to the root context. For instance, this is required to show milieu contexts in the geography.

Method Detail

values

public static GMilieuPa[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GMilieuPa c : GMilieuPa.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GMilieuPa valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getType

public Class<?> getType()

Specified by:

getType in interface de.cesr.parma.core.PmParameterDefinition

getDefaultValue

public Object getDefaultValue()

Specified by:

getDefaultValue in interface de.cesr.parma.core.PmParameterDefinition