Package edu.cmu.tetrad.util

Class ParamDescription

java.lang.Object

edu.cmu.tetrad.util.ParamDescription

public class ParamDescription
extends Object

Describes a parameter.

Version:

$Id: $Id

Author:

josephramsey, Zhou Yuan zhy19@pitt.edu

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ParamDescription

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

Constructor for ParamDescription.

Parameters:

paramName - a String object

shortDescription - a String object

longDescription - a String object

defaultValue - a Serializable object

ParamDescription

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

Constructor for ParamDescription.

Parameters:

paramName - a String object

shortDescription - a String object

longDescription - a String object

defaultValue - a Serializable object

lowerBound - a int

upperBound - a int

ParamDescription

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

Constructor for ParamDescription.

Parameters:

paramName - a String object

shortDescription - a String object

longDescription - a String object

defaultValue - a Serializable object

lowerBound - a double

upperBound - a double

Method Details

getParamName

public String getParamName()

Getter for the field paramName.

Returns:

a String object

setParamName

public void setParamName(String paramName)

Setter for the field paramName.

Parameters:

paramName - a String object

getShortDescription

public String getShortDescription()

Getter for the field shortDescription.

Returns:

a String object

setShortDescription

public void setShortDescription(String shortDescription)

Setter for the field shortDescription.

Parameters:

shortDescription - a String object

getLongDescription

public String getLongDescription()

Getter for the field longDescription.

Returns:

a String object

setLongDescription

public void setLongDescription(String longDescription)

Setter for the field longDescription.

Parameters:

longDescription - a String object

getDefaultValue

public Serializable getDefaultValue()

Getter for the field defaultValue.

Returns:

a Serializable object

setDefaultValue

public void setDefaultValue(Serializable defaultValue)

Setter for the field defaultValue.

Parameters:

defaultValue - a Serializable object

getLowerBoundDouble

public double getLowerBoundDouble()

Getter for the field lowerBoundDouble.

Returns:

a double

setLowerBoundDouble

public void setLowerBoundDouble(double lowerBoundDouble)

Setter for the field lowerBoundDouble.

Parameters:

lowerBoundDouble - a double

getUpperBoundDouble

public double getUpperBoundDouble()

Getter for the field upperBoundDouble.

Returns:

a double

setUpperBoundDouble

public void setUpperBoundDouble(double upperBoundDouble)

Setter for the field upperBoundDouble.

Parameters:

upperBoundDouble - a double

getLowerBoundInt

public int getLowerBoundInt()

Getter for the field lowerBoundInt.

Returns:

a int

setLowerBoundInt

public void setLowerBoundInt(int lowerBoundInt)

Setter for the field lowerBoundInt.

Parameters:

lowerBoundInt - a int

getUpperBoundInt

public int getUpperBoundInt()

Getter for the field upperBoundInt.

Returns:

a int

setUpperBoundInt

public void setUpperBoundInt(int upperBoundInt)

Setter for the field upperBoundInt.

Parameters:

upperBoundInt - a int

getLowerBoundLong

public long getLowerBoundLong()

Getter for the field lowerBoundLong.

Returns:

a long

setLowerBoundLong

public void setLowerBoundLong(long lowerBoundLong)

Setter for the field lowerBoundLong.

Parameters:

lowerBoundLong - a long

getUpperBoundLong

public long getUpperBoundLong()

Getter for the field upperBoundLong.

Returns:

a long

setUpperBoundLong

public void setUpperBoundLong(long upperBoundLong)

Setter for the field upperBoundLong.

Parameters:

upperBoundLong - a long