de.cesr.sesamgim.param
Enum GPlzPa

java.lang.Object
  extended by java.lang.Enum<GPlzPa>
      extended by de.cesr.sesamgim.param.GPlzPa
All Implemented Interfaces:
de.cesr.parma.core.PmParameterDefinition, Serializable, Comparable<GPlzPa>

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

SesamGIM - Geographical Initialisation for Milieu Agents


Enum Constant Summary
PLZ_ALLOW_AGENT_TO_LEAVE_PLZ_AREAS
          If set to false, it is ensured that calculated agent position are within PLZ areas.
PLZ_PROJECTION_NAME
          The name of the Repast Simphony geography projection that contains PLZ shapes.
PLZ_SHAPEFILE
          The shape file that defines the inhabited region TODO check if contains shapes!
 
Method Summary
 Object getDefaultValue()
           
 Class<?> getType()
           
static GPlzPa valueOf(String name)
          Returns the enum constant of this type with the specified name.
static GPlzPa[] 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

PLZ_PROJECTION_NAME

public static final GPlzPa PLZ_PROJECTION_NAME
The name of the Repast Simphony geography projection that contains PLZ shapes. Usually, it is the same as GBasicPa.AREA_PROJECTION_NAME.


PLZ_ALLOW_AGENT_TO_LEAVE_PLZ_AREAS

public static final GPlzPa PLZ_ALLOW_AGENT_TO_LEAVE_PLZ_AREAS
If set to false, it is ensured that calculated agent position are within PLZ areas. Of course, it applies only in case GInitialisersPa.INITIALISER_PLZ is not null and in case GMilieuPa.DISTRIBUTE_AGENTS_UNIFORMLY_IN_MC is not true. Default: false.


PLZ_SHAPEFILE

public static final GPlzPa PLZ_SHAPEFILE
The shape file that defines the inhabited region TODO check if contains shapes!

Method Detail

values

public static GPlzPa[] 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 (GPlzPa c : GPlzPa.values())
    System.out.println(c);

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

valueOf

public static GPlzPa 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