Package hec.rss.model

Class SystemFlowLimitOpRule

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.rss.model.SystemOpRule

hec.rss.model.SystemFlowLimitOpRule

All Implemented Interfaces:

AsciiSerializable, FieldAccessor, Serializable, Cloneable, Comparable, Observer, rma.lang.Modifiable

public class SystemFlowLimitOpRule
extends SystemOpRule
implements Serializable, AsciiSerializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX
static final int	MIN
static final String	PARAMSTR_MAXRULE
static final String	PARAMSTR_MAXRULEID
static final String	PARAMSTR_MINRULE
static final String	PARAMSTR_MINRULEID

Fields inherited from class hec.lang.NamedType

_description, _ignoreModifiedEvents, _index, _isValid, _modified, _name, defaultDescription, defaultName, DESCRIPTION_CHANGED, NAME_CHANGED, RENAME_EVENT

Constructor Summary

Constructors

Constructor	Description
SystemFlowLimitOpRule()
SystemFlowLimitOpRule(String name)

Method Summary

Modifier and Type	Method	Description
Object	clone()	Creates a copy of a the SystemOpRule.
Object	getFieldObject(Field fld)	This method allows access to java.lang.reflect.Field objects within the implementing class.
int	getInterpolationType()
int	getLimitType()	returns the integer type of the limit: -1=Min, 1=Max
DayOfWeekMultiplier	getMultiplier()	Returns a new Day of Week Multiplier object
int	getRssNodeIndex()	returns the integer rssNodeIndex, -1 indicates local limit.
SeasonalRecord	getSeasonalRecord()	Returns a reference to the seasonal record object containing the time varying flow limits
boolean	setFieldObject(Field fld, Object fobj)	This allows access to fields withing the implementing object to set there data.
void	setInterpolationType(int type)
void	setLimitType(int type)	sets the limit type, must ether -1=Min or 1=Max
void	setMultiplier(DayOfWeekMultiplier mult)	Sets the Day of Week Mulitplier
void	setRssNodeIndex(int id)	sets the rssNodeIndex, -1 indicates local limit.
String	toString()	Returns the name of the Rule

Methods inherited from class hec.rss.model.SystemOpRule

getUnitSystem, setController

Methods inherited from class hec.lang.NamedType

addModifiableListener, compareTo, fireModifiedStateChanged, getDescription, getDisplayName, getIgnoreModifiedEvents, getIndex, getName, isModified, isValid, readResolve, removeModifiableListener, rename, set, setDescription, setIgnoreModifiedEvents, setIndex, setModified, setName, setValid, update, useRecursiveModifiedTest

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Details

MIN

public static final int MIN

See Also:

• Constant Field Values

MAX

public static final int MAX

See Also:

• Constant Field Values

PARAMSTR_MAXRULE

public static final String PARAMSTR_MAXRULE

See Also:

• Constant Field Values

PARAMSTR_MINRULE

public static final String PARAMSTR_MINRULE

See Also:

• Constant Field Values

PARAMSTR_MAXRULEID

public static final String PARAMSTR_MAXRULEID

See Also:

• Constant Field Values

PARAMSTR_MINRULEID

public static final String PARAMSTR_MINRULEID

See Also:

• Constant Field Values

Constructor Details

SystemFlowLimitOpRule

public SystemFlowLimitOpRule()

SystemFlowLimitOpRule

public SystemFlowLimitOpRule(String name)

Method Details

getRssNodeIndex

public int getRssNodeIndex()

returns the integer rssNodeIndex, -1 indicates local limit.

setRssNodeIndex

public void setRssNodeIndex(int id)

sets the rssNodeIndex, -1 indicates local limit.

setInterpolationType

public void setInterpolationType(int type)

getInterpolationType

public int getInterpolationType()

getSeasonalRecord

public SeasonalRecord getSeasonalRecord()

Returns a reference to the seasonal record object containing the time varying flow limits

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from class: SystemOpRule

Creates a copy of a the SystemOpRule. The pointer to the owner class, ReservoirSysOp is passed as a reference to the cloned object.

Overrides:

clone in class SystemOpRule

Throws:

CloneNotSupportedException

setLimitType

public void setLimitType(int type)

sets the limit type, must ether -1=Min or 1=Max

getLimitType

public int getLimitType()

returns the integer type of the limit: -1=Min, 1=Max

getMultiplier

public DayOfWeekMultiplier getMultiplier()

Returns a new Day of Week Multiplier object

setMultiplier

public void setMultiplier(DayOfWeekMultiplier mult)

Sets the Day of Week Mulitplier

toString

public String toString()

Returns the name of the Rule

Overrides:

toString in class NamedType

getFieldObject

public Object getFieldObject(Field fld)

Description copied from interface: FieldAccessor

This method allows access to java.lang.reflect.Field objects within the implementing class.

Specified by:

getFieldObject in interface FieldAccessor

Overrides:

getFieldObject in class SystemOpRule

Parameters:

fld - The field to get.

Returns:

The data object that is stored in the given field

setFieldObject

public boolean setFieldObject(Field fld,
 Object fobj)

Description copied from interface: FieldAccessor

This allows access to fields withing the implementing object to set there data.

Specified by:

setFieldObject in interface FieldAccessor

Overrides:

setFieldObject in class SystemOpRule

Parameters:

fld - The java field object representing the member field to be set

fobj - The data to set in that field

Returns:

returns true if successful