|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectPIANOS.datastructures.Variable
public class Variable
A representation for a stochastic or functional variable/parameter in a statistical PIANOS model.
Constructor Summary | |
---|---|
Variable()
Constructs a new Variable from scratch, ready to take in field values. |
Method Summary | |
---|---|
void |
addAffected(Variable variable)
Adds a new Variable at the end of the list of Variables that this Variable affects. |
void |
addDependence(Variable variable)
Adds a new Variable at the end of the list of Variables that this Variables depends on. |
java.util.LinkedList<Variable> |
getAffectsList()
|
java.lang.String |
getAlgorithm()
|
int |
getColumn()
|
java.util.LinkedList<Variable> |
getDependsList()
|
Distribution |
getDistribution()
|
Entity |
getEntity()
|
Equation |
getEquation()
|
int |
getMissingValueCount()
|
java.lang.String |
getName()
|
Distribution |
getProposal()
|
java.lang.String |
getStrategy()
|
int |
getUpdates()
|
void |
incrementMissingValues()
Adds one to the number of missing values. |
boolean |
isData()
|
boolean |
isFunctional()
|
boolean |
isInteger()
|
boolean |
isOk()
Runs this Variable through a health check. |
boolean |
isPrinted()
|
boolean |
isSpatial()
|
void |
setAlgorithm(java.lang.String algorithm)
(currently not implemented) This will set the update algorithm for this Variable. |
void |
setColumn(int column)
Sets the data column number for the Variable (See getColumn()) |
void |
setData(boolean data)
|
void |
setDistribution(Distribution distribution)
|
void |
setEntity(Entity belongsTo)
|
void |
setEquation(Equation equation)
|
void |
setFunctional(boolean functional)
|
void |
setName(java.lang.String name)
|
void |
setPrinted()
Sets that this Variable should be printed. |
void |
setProposal(Distribution proposal)
Sets the proposal Distribution for this variable (see the manual) |
void |
setSpatial(boolean spatial)
|
void |
setStrategy(java.lang.String strategy)
Sets the update strategy for this variable {sequential, random} |
void |
setType(boolean typeInteger)
|
void |
setUpdates(int updates)
Sets the number of updates this variable should have before end of simulation. |
java.lang.String |
toString()
Prints a limited amount of information about this Variable similar to a model file variable definition line. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Variable()
Method Detail |
---|
public java.util.LinkedList<Variable> getAffectsList()
public void addAffected(Variable variable)
public java.util.LinkedList<Variable> getDependsList()
public void addDependence(Variable variable)
public java.lang.String getAlgorithm()
public void setAlgorithm(java.lang.String algorithm)
public int getColumn()
public void setColumn(int column)
public boolean isData()
public void setData(boolean data)
data
- set this to true if the Variable is found in data.public Equation getEquation()
public void setEquation(Equation equation)
public Distribution getDistribution()
public void setDistribution(Distribution distribution)
public boolean isFunctional()
public void setFunctional(boolean functional)
public boolean isSpatial()
public void setSpatial(boolean spatial)
public java.lang.String getName()
public void setName(java.lang.String name)
public void setProposal(Distribution proposal)
public Distribution getProposal()
public void setStrategy(java.lang.String strategy)
public java.lang.String getStrategy()
public void setUpdates(int updates)
public int getUpdates()
public int getMissingValueCount()
public void incrementMissingValues()
public boolean isInteger()
public void setType(boolean typeInteger)
public Entity getEntity()
public void setEntity(Entity belongsTo)
public void setPrinted()
public boolean isPrinted()
public boolean isOk()
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |