Package hec.clientapp.model

Class SimulationTrialRun

java.lang.Object

java.util.Observable

hec.lang.NamedType

hec.clientapp.model.Manager

hec.clientapp.model.SimulationRun

hec.clientapp.model.SimulationTrialRun

All Implemented Interfaces:

TrialRun, hec.event.ModifiableListener, AsciiSerializable, FieldAccessor, LockableObject, hec.map.MapObjectInterface, MessagePrinter, ModelConstants, TsRecordContainer, Serializable, Cloneable, Comparable, EventListener, Observer, mil.army.usace.hec.rmi.csinterface.CallBackInterface, rma.lang.Modifiable

Direct Known Subclasses:

RssSimTrialRun

public class SimulationTrialRun
extends SimulationRun
implements TrialRun

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILE_EXT	Description of the Field

Fields inherited from class hec.clientapp.model.SimulationRun

_altList, _baseRunName, _modelForecastAltMgrs, _trialList, _trials, NO_SELECTION

Fields inherited from class hec.clientapp.model.Manager

_callBack, _dssFileManagerWrapper, _identifier, _lastModifiedTime, _modifiableListeners, _proxyList, _readOnly, _reloadFailed, _reloadOk, _uiWrapper, _userInterface, _wkspPath, _Workspace, LASTMODIFIED_STRING

Fields inherited from class hec.lang.NamedType

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

Fields inherited from interface hec.model.ModelConstants

FDA_MODEL_NAME, FIA_MODEL_NAME, HFP_MODEL_NAME, MFP_MODEL_NAME, RAS_MODEL_NAME, RESPRM_MODEL_NAME, RSS_MODEL_NAME, SUPPLEMENTAL_MODEL_NAME

Constructor Summary

Constructors

Constructor	Description
SimulationTrialRun()	Constructor for the TrialForecastRun object
SimulationTrialRun(boolean isBaseTrial)	Constructor for the TrialForecastRun object

Method Summary

Modifier and Type	Method	Description
Object	getFieldObject(Field fld)	Gets the FieldObject attribute of the TrialForecastRun object
String	getFileExtension()
Identifier	getIdentifier()	Gets the Identifier attribute of the SimulationTrialRun object
String	getKey()
String	getModel(String programName)
String	getModelAltWorkspaceName()	Gets the ModelAltWorkspaceName attribute of the SimulationRun object.
SimulationRun	getRunParent()	Gets the ForecastRunParent attribute of the TrialForecastRun object
String	getTrialKey()	return the name with trials ie.
int	getTrialPosition()
String	getTrialRunClassName()	Gets the TrialRunClassName attribute of the SimulationRun object
boolean	isAccepted()
boolean	isActiveTrial()	Gets the ActiveTrial attribute of the TrialForecastRun object
boolean	isBaseTrial()	Gets the BaseTrial attribute of the TrialForecastRun object
boolean	isCurrentTrial()	Gets the CurrentTrial attribute of the TrialForecastRun object
void	setAccepted(boolean accepted)	set this trial as having been accepted.
void	setActiveTrial(boolean active)	Sets the ActiveTrial attribute of the TrialForecastRun object
void	setCurrentTrial(boolean current)	Sets the CurrentTrial attribute of the TrialForecastRun object
boolean	setFieldObject(Field fld, Object fobj)	Sets the FieldObject attribute of the TrialForecastRun object
void	setIsBaseTrial(boolean b)	Sets the IsBaseTrial attribute of the TrialForecastRun object
void	setModified(boolean b)	Sets the Modified attribute of the TrialForecastRun object
void	setRunParent(SimulationRun run)	Sets the RunParent attribute of the SimulationTrialRun object
void	setSimulationRunClassName(String name)
void	setTrialKey(String trialKey)
void	setTrialPosition(int pos)
String	toString()	Description of the Method

Methods inherited from class hec.clientapp.model.SimulationRun

acceptTrial, addTrial, areManagersModified, getAlternativeNameLength, getAltItems, getAltList, getBaseRunName, getComputeInundation, getConfigurationId, getCoordinateReferenceSystem, getExtent, getIdForModelAlt, getMapIdentifier, getModelAlt, getModelAlt, getModelAltClassName, getModelCount, getModelNameLength, getModelNames, getProgramOrder, getRasModelForecastAlt, getRasModelReference, getRunKey, getSimulation, getTrialKeys, getTrials, getUserName, hasModelAlt, init, isActiveRun, isExpanded, isSelected, load, loadManager, modifiedStateChanged, notifyModifiableListeners, readFile, reLoadFile, removeTrial, saveManagers, setActiveRun, setAltList, setComputeInundation, setConfigurationId, setDefaultModelAltClassName, setDescription, setExpanded, setExtent, setMapIdentifier, setModelsLocked, setName, setSelected, setSimulation, setUserName, unload, unloading, usesModeltAlt, writeFile

Methods inherited from class hec.clientapp.model.Manager

addModifiableListener, backupFile, computeComplete, copyFile, deleteFile, deleting, finalize, getCallback, getCommonDataList, getDirectory, getDSSFileManager, getDSSFileManagerWrapper, getFileManager, getFilename, getGmtOffset, getInputITSDataSet, getInputTSDataSet, getLastModifiedTime, getLastModifiedTimeString, getModTime, getModTime, getOutputITSDataSet, getOutputTSDataSet, getPath, getProxyList, getReadOnly, getRelativePath, getReloadOk, getSaveAsId, getSaveAsId, getUnitSystem, getUserInterface, getWorkspace, getWorkspacePath, hasLock, isCanceled, isForecastManager, loadComplete, loadSaveAsFile, makeAbsolutePath, makeAbsolutePath, makeAbsolutePathFromWatershed, makeRelativePath, makeRelativePathFromWatershed, modifiyForSaveAs, newFile, newTSRecordProxy, newTSRecordProxy, notify, notifyModifiableListeners, openFile, printErrorMessage, printLogMessage, printMessage, printSeparator, printStatus, printTableRow, printWarningMessage, refreshData, reLoadChildManagers, reLoadFile, removeCallBack, removeModifiableListener, renamed, saveChildManagers, saveManager, saveManagerAs, saveManagerAs, setIdentifier, setLastModifiedTime, setLastModifiedTime, setLineAttributes, setLocked, setManagersModifiedTime, setModifiedFalse, setPath, setProgress, setProxyList, setReadOnly, setReloadOk, setUserInterface, setUserInterface, setWorkspace, writeLastModTime

Methods inherited from class hec.lang.NamedType

clone, compareTo, fireModifiedStateChanged, getDescription, getDisplayName, getIgnoreModifiedEvents, getIndex, getName, isModified, isValid, readResolve, rename, set, setIgnoreModifiedEvents, setIndex, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface hec.map.MapObjectInterface

getName

Methods inherited from interface rma.lang.Modifiable

isModified

Methods inherited from interface hec.clientapp.model.TrialRun

getDescription, getName, isModified, setSimulation, writeFile

Field Details

FILE_EXT

public static String FILE_EXT

Description of the Field

Constructor Details

SimulationTrialRun

public SimulationTrialRun()

Constructor for the TrialForecastRun object

SimulationTrialRun

public SimulationTrialRun(boolean isBaseTrial)

Constructor for the TrialForecastRun object

Parameters:

isBaseTrial - Description of Parameter

Method Details

setSimulationRunClassName

public void setSimulationRunClassName(String name)

setIsBaseTrial

public void setIsBaseTrial(boolean b)

Sets the IsBaseTrial attribute of the TrialForecastRun object

Parameters:

b - The new IsBaseTrial value

setRunParent

public void setRunParent(SimulationRun run)

Sets the RunParent attribute of the SimulationTrialRun object

Specified by:

setRunParent in interface TrialRun

Parameters:

run - The new RunParent value

getRunParent

public SimulationRun getRunParent()

Gets the ForecastRunParent attribute of the TrialForecastRun object

Specified by:

getRunParent in interface TrialRun

Returns:

The ForecastRunParent value

getModelAltWorkspaceName

public String getModelAltWorkspaceName()

Description copied from class: SimulationRun

Gets the ModelAltWorkspaceName attribute of the SimulationRun object. This represents the model directory that will be used to store the simulation run.

Specified by:

getModelAltWorkspaceName in class SimulationRun

Returns:

The ModelAltWorkspaceName value

getTrialRunClassName

public String getTrialRunClassName()

Description copied from class: SimulationRun

Gets the TrialRunClassName attribute of the SimulationRun object

Specified by:

getTrialRunClassName in class SimulationRun

Returns:

returns the class name used to construct or identify the class to be used for trial runs. Allows different simulations to specify different trial classes. The class must subclass the object hec.clientapp.model.SimulationRun

See Also:

• SimulationRun

getIdentifier

public Identifier getIdentifier()

Gets the Identifier attribute of the SimulationTrialRun object

Specified by:

getIdentifier in interface TrialRun

Overrides:

getIdentifier in class Manager

Returns:

The Identifier value

setActiveTrial

public void setActiveTrial(boolean active)

Sets the ActiveTrial attribute of the TrialForecastRun object

Parameters:

active - The new ActiveTrial value

setCurrentTrial

public void setCurrentTrial(boolean current)

Sets the CurrentTrial attribute of the TrialForecastRun object

Parameters:

current - The new CurrentTrial value

setModified

public void setModified(boolean b)

Sets the Modified attribute of the TrialForecastRun object

Specified by:

setModified in interface rma.lang.Modifiable

Overrides:

setModified in class SimulationRun

Parameters:

b - The new Modified value

isBaseTrial

public boolean isBaseTrial()

Gets the BaseTrial attribute of the TrialForecastRun object

Returns:

The BaseTrial value

isActiveTrial

public boolean isActiveTrial()

Gets the ActiveTrial attribute of the TrialForecastRun object

Returns:

The ActiveTrial value

isCurrentTrial

public boolean isCurrentTrial()

Gets the CurrentTrial attribute of the TrialForecastRun object

Returns:

The CurrentTrial value

toString

public String toString()

Description of the Method

Overrides:

toString in class SimulationRun

Returns:

Description of the Returned Value

getKey

public String getKey()

Overrides:

getKey in class SimulationRun

getModel

public String getModel(String programName)

Overrides:

getModel in class SimulationRun

getFileExtension

public String getFileExtension()

Overrides:

getFileExtension in class SimulationRun

getTrialKey

public String getTrialKey()

return the name with trials ie. Q1B2R3----

Specified by:

getTrialKey in interface TrialRun

setTrialKey

public void setTrialKey(String trialKey)

setTrialPosition

public void setTrialPosition(int pos)

getTrialPosition

public int getTrialPosition()

Specified by:

getTrialPosition in interface TrialRun

setFieldObject

public boolean setFieldObject(Field fld,
 Object fobj)

Sets the FieldObject attribute of the TrialForecastRun object

Specified by:

setFieldObject in interface FieldAccessor

Overrides:

setFieldObject in class SimulationRun

Parameters:

fld - The new FieldObject value

fobj - The new FieldObject value

Returns:

Description of the Returned Value

getFieldObject

public Object getFieldObject(Field fld)

Gets the FieldObject attribute of the TrialForecastRun object

Specified by:

getFieldObject in interface FieldAccessor

Overrides:

getFieldObject in class SimulationRun

Parameters:

fld - Description of Parameter

Returns:

The FieldObject value

setAccepted

public void setAccepted(boolean accepted)

set this trial as having been accepted.

Parameters:

b -

isAccepted

public boolean isAccepted()

Returns:

whether this trial has been accepted.