p3j.pppm.parameters
Class Parameter

java.lang.Object
  extended by p3j.pppm.parameters.Parameter
All Implemented Interfaces:
Serializable

public class Parameter
extends Object
implements Serializable

Represents a parameter in the PPPM. A parameter is basically a name, associated with an ID. It denotes a certain basic sort of parameter within the PPPM, e.g. the fertility of emigrants, the fertility of natives, etc. Each parameter has to come in certain (matrix) dimensions, which are defined here as valueWidth and valueHeight. These are given in MatrixDimension. A parameter might be generation-dependent, expressed by generationDependent, e.g., fertility of X-th generation of emigrants. Note that this class only stores the general aspects of the parameter. The definition of an actual input parameter kind, e.g. the fertility of the 5-th generation of emigrants, is done by ParameterInstance objects. All instances of this class are defined as constants in Parameters. Created on January 18, 2007

Author:
Christina Bohk, Roland Ewald
See Also:
Serialized Form

Constructor Summary
Parameter()
          Constructor for bean compatibility.
Parameter(int paramID, boolean genDependent, String paramName, MatrixDimension height, MatrixDimension width, Population pop)
          Default constructor.
 
Method Summary
 int getID()
           
 String getName()
           
 Population getPopulation()
           
 MatrixDimension getValueHeight()
           
 MatrixDimension getValueWidth()
           
 boolean isGenerationDependent()
           
 void setGenerationDependent(boolean generationDependent)
           
 void setID(int paramID)
           
 void setName(String name)
           
 void setPopulation(Population population)
           
 void setValueHeight(MatrixDimension valHeight)
           
 void setValueWidth(MatrixDimension valWidth)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Parameter

public Parameter(int paramID,
                 boolean genDependent,
                 String paramName,
                 MatrixDimension height,
                 MatrixDimension width,
                 Population pop)
Default constructor.

Parameters:
paramID - the unique identifier of the parameter
genDependent - if true, this parameter is generation-dependent
paramName - name of the parameter
height - height of the parameter matrix
width - width of the parameter matrix
pop - the population this parameter belongs to

Parameter

public Parameter()
Constructor for bean compatibility.

Method Detail

getValueWidth

public MatrixDimension getValueWidth()

setValueWidth

public void setValueWidth(MatrixDimension valWidth)

getValueHeight

public MatrixDimension getValueHeight()

setValueHeight

public void setValueHeight(MatrixDimension valHeight)

isGenerationDependent

public boolean isGenerationDependent()

setGenerationDependent

public void setGenerationDependent(boolean generationDependent)

getID

public int getID()

setID

public final void setID(int paramID)

getName

public String getName()

setName

public void setName(String name)

getPopulation

public Population getPopulation()

setPopulation

public void setPopulation(Population population)

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2012. All Rights Reserved.