de.cesr.more.param
Enum MNetworkBuildingPa

java.lang.Object
  java.lang.Enum<MNetworkBuildingPa>
      de.cesr.more.param.MNetworkBuildingPa

All Implemented Interfaces:

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

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

Parameter definitions used for MORe's network building

Date:

23.09.2011

Enum Constant Summary

ADD_EDGES_TO_GEOGRAPHY
If true, edges are added to the geography (adding many edges to the geography is a performance issue).

BUILD_DIRECTED
"Directedness" of the generated networks.

BUILD_RANDOM_AVG_DEGREE
The average degree of a node in the resulting network.

BUILD_WSSM_BETA
The probability of an edge being rewired randomly; the proportion of randomly rewired edges in a graph.

BUILD_WSSM_CONSIDER_SOURCES
Regarding the SmallWorldNetworkBuilder one must pay attention because of the network direction.

BUILD_WSSM_INITIAL_OUTDEG
Initial degree that is used to build to regular network (local neighbourhood size) to start from.

MILIEU_NETPREFS_PARAMID
The parameter id used to retrieve network preference data from tables MSqlPa.TBLNAME_NET_PREFS and MSqlPa.TBLNAME_NET_PREFS_LINKS.

MILIEU_NETWORK_CSV_COLUMNPREFIX

MILIEU_NETWORK_CSV_DELIMITER

MILIEU_NETWORK_CSV_MILIEULINKS

MILIEU_NETWORK_CSV_MILIEUS

MILIEU_NETWORK_PARAMS
The milieu network parameter map is usually read by MMilieuNetDataReader.

RESTORE_NETWORK_SOURCE_FILE
Restore network Builder

SPATIAL_REFERENCE_ID
Used to initialize the GeometryFactory in MGeoRsNetworkService.

Method Summary

Object	getDefaultValue()
Class<?>	getType()
static MNetworkBuildingPa	valueOf(String name) Returns the enum constant of this type with the specified name.
static MNetworkBuildingPa[]	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_NETWORK_PARAMS

public static final MNetworkBuildingPa MILIEU_NETWORK_PARAMS

The milieu network parameter map is usually read by MMilieuNetDataReader. Default is null.

MILIEU_NETWORK_CSV_MILIEUS

public static final MNetworkBuildingPa MILIEU_NETWORK_CSV_MILIEUS

MILIEU_NETWORK_CSV_MILIEULINKS

public static final MNetworkBuildingPa MILIEU_NETWORK_CSV_MILIEULINKS

MILIEU_NETWORK_CSV_DELIMITER

public static final MNetworkBuildingPa MILIEU_NETWORK_CSV_DELIMITER

MILIEU_NETWORK_CSV_COLUMNPREFIX

public static final MNetworkBuildingPa MILIEU_NETWORK_CSV_COLUMNPREFIX

MILIEU_NETPREFS_PARAMID

public static final MNetworkBuildingPa MILIEU_NETPREFS_PARAMID

The parameter id used to retrieve network preference data from tables MSqlPa.TBLNAME_NET_PREFS and MSqlPa.TBLNAME_NET_PREFS_LINKS. Default: 0

BUILD_RANDOM_AVG_DEGREE

public static final MNetworkBuildingPa BUILD_RANDOM_AVG_DEGREE

The average degree of a node in the resulting network. Determines p ( 1/#agents * AVG_DEGREE).

BUILD_WSSM_BETA

public static final MNetworkBuildingPa BUILD_WSSM_BETA

The probability of an edge being rewired randomly; the proportion of randomly rewired edges in a graph. Range: (0,1); Default: 0.1.

BUILD_WSSM_INITIAL_OUTDEG

public static final MNetworkBuildingPa BUILD_WSSM_INITIAL_OUTDEG

Initial degree that is used to build to regular network (local neighbourhood size) to start from. Must be an even number. Default: 4. If BUILD_WSSM_CONSIDER_SOURCES is TRUE, this value is considered as in-degree!

BUILD_WSSM_CONSIDER_SOURCES

public static final MNetworkBuildingPa BUILD_WSSM_CONSIDER_SOURCES

Regarding the SmallWorldNetworkBuilder one must pay attention because of the network direction. Generally, the small world algorithm considers given k and beta values for the source of a direction. However, in some models we consider the influencer as source and seek to build the network according to the influenced' properties. In this case, set this parameter to FALSE.

RESTORE_NETWORK_SOURCE_FILE

public static final MNetworkBuildingPa RESTORE_NETWORK_SOURCE_FILE

Restore network Builder

BUILD_DIRECTED

public static final MNetworkBuildingPa BUILD_DIRECTED

"Directedness" of the generated networks. Default:true.

ADD_EDGES_TO_GEOGRAPHY

public static final MNetworkBuildingPa ADD_EDGES_TO_GEOGRAPHY

If true, edges are added to the geography (adding many edges to the geography is a performance issue). Default: true.

SPATIAL_REFERENCE_ID

public static final MNetworkBuildingPa SPATIAL_REFERENCE_ID

Used to initialize the GeometryFactory in MGeoRsNetworkService. Default: 4326 (WGS 84)

Method Detail

values

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

Returns:

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

valueOf

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

See Also:

PmParameterDefinition.getType()

getDefaultValue

public Object getDefaultValue()

Specified by:

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

See Also:

PmParameterDefinition.getDefaultValue()