Package edu.cmu.tetrad.util

Class ParamDescription

java.lang.Object

edu.cmu.tetrad.util.ParamDescription

public class ParamDescription
extends Object

Describes a parameter.

Author:

josephramsey, Zhou Yuan zhy19@pitt.edu

Constructor Summary

Constructors

Constructor	Description
ParamDescription(String paramName, String shortDescription, String longDescription, Serializable defaultValue)
ParamDescription(String paramName, String shortDescription, String longDescription, Serializable defaultValue, double lowerBound, double upperBound)
ParamDescription(String paramName, String shortDescription, String longDescription, Serializable defaultValue, int lowerBound, int upperBound)

Method Summary

Modifier and Type	Method	Description
Serializable	getDefaultValue()
String	getLongDescription()
double	getLowerBoundDouble()
int	getLowerBoundInt()
long	getLowerBoundLong()
String	getParamName()
String	getShortDescription()
double	getUpperBoundDouble()
int	getUpperBoundInt()
long	getUpperBoundLong()
void	setDefaultValue(Serializable defaultValue)
void	setLongDescription(String longDescription)
void	setLowerBoundDouble(double lowerBoundDouble)
void	setLowerBoundInt(int lowerBoundInt)
void	setLowerBoundLong(long lowerBoundLong)
void	setParamName(String paramName)
void	setShortDescription(String shortDescription)
void	setUpperBoundDouble(double upperBoundDouble)
void	setUpperBoundInt(int upperBoundInt)
void	setUpperBoundLong(long upperBoundLong)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ParamDescription

public ParamDescription(String paramName,
 String shortDescription,
 String longDescription,
 Serializable defaultValue)

ParamDescription

public ParamDescription(String paramName,
 String shortDescription,
 String longDescription,
 Serializable defaultValue,
 int lowerBound,
 int upperBound)

ParamDescription

public ParamDescription(String paramName,
 String shortDescription,
 String longDescription,
 Serializable defaultValue,
 double lowerBound,
 double upperBound)

Method Details

getParamName

public String getParamName()

setParamName

public void setParamName(String paramName)

getShortDescription

public String getShortDescription()

setShortDescription

public void setShortDescription(String shortDescription)

getLongDescription

public String getLongDescription()

setLongDescription

public void setLongDescription(String longDescription)

getDefaultValue

public Serializable getDefaultValue()

setDefaultValue

public void setDefaultValue(Serializable defaultValue)

getLowerBoundDouble

public double getLowerBoundDouble()

setLowerBoundDouble

public void setLowerBoundDouble(double lowerBoundDouble)

getUpperBoundDouble

public double getUpperBoundDouble()

setUpperBoundDouble

public void setUpperBoundDouble(double upperBoundDouble)

getLowerBoundInt

public int getLowerBoundInt()

setLowerBoundInt

public void setLowerBoundInt(int lowerBoundInt)

getUpperBoundInt

public int getUpperBoundInt()

setUpperBoundInt

public void setUpperBoundInt(int upperBoundInt)

getLowerBoundLong

public long getLowerBoundLong()

setLowerBoundLong

public void setLowerBoundLong(long lowerBoundLong)

getUpperBoundLong

public long getUpperBoundLong()

setUpperBoundLong

public void setUpperBoundLong(long upperBoundLong)