Package hec.clientapp.model
Interface Simulation
- All Known Implementing Classes:
AbstractSimulation,SimulationPeriod
public interface Simulation
-
Method Summary
Modifier and TypeMethodDescriptionvoidacceptTrial(SimulationRun run, AltItem altItem, int modelPos, String trialKey) Description of the Methodbooleancompute()Description of the MethodcreateNewTrialRun(String newTrialName, String userName, String trialKey, SimulationRun parent, TrialRun baseTrial, int modelPosition) Returns the description of the simulationGets the EndDateString attribute of the Simulation objectGets the LookbackDateString attribute of the Simulation objectgetModelTrials(String program, String id) getName()Returns the name of the simulationGets the StartDateString attribute of the Simulation objectGets the StreamAlignment attribute of the Simulation objectbooleangetTimeWindow(HecTime start, HecTime end) Gets the TimeWindow attribute of the Simulation objectGets the TimeWindowString attribute of the Simulation objectreturns a Vector of the names of the SimulationTrialRuns that this SimulationPeriod holdsgetUnusedModelTrials(String program, String id) booleanremoveTrial(AltItem altItem, TrialReference trialRef) voidsetEndDate(String date) Sets the EndDate attribute of the Simulation objectvoidsetLookbackDate(String date) Sets the LookbackDate attribute of the Simulation objectvoidsetModified(boolean modified) Sets the Modified attribute of the Simulation objectvoidsetStartDate(String date) Sets the StartDate attribute of the Simulation object
-
Method Details
-
getName
String getName()Returns the name of the simulation -
getDescription
String getDescription()Returns the description of the simulation -
setModified
void setModified(boolean modified) Sets the Modified attribute of the Simulation object- Parameters:
modified- The new Modified value
-
acceptTrial
Description of the Method- Parameters:
run- Description of ParameteraltItem- Description of ParametermodelPos- Description of ParametertrialKey- Description of Parameter
-
removeTrial
-
compute
boolean compute()Description of the Method- Returns:
- Description of the Returned Value
-
getStreamAlignment
StreamAlignment getStreamAlignment()Gets the StreamAlignment attribute of the Simulation object- Returns:
- The StreamAlignment value
-
getTimeWindowString
String getTimeWindowString()Gets the TimeWindowString attribute of the Simulation object- Returns:
- The TimeWindowString value
-
getTimeWindow
Gets the TimeWindow attribute of the Simulation object- Parameters:
start- Description of Parameterend- Description of Parameter- Returns:
- The TimeWindow value
-
getStartDateString
String getStartDateString()Gets the StartDateString attribute of the Simulation object- Returns:
- The StartDateString value
-
setStartDate
Sets the StartDate attribute of the Simulation object- Parameters:
date- The new StartDate value
-
getEndDateString
String getEndDateString()Gets the EndDateString attribute of the Simulation object- Returns:
- The EndDateString value
-
setEndDate
Sets the EndDate attribute of the Simulation object- Parameters:
date- The new EndDate value
-
getLookbackDateString
String getLookbackDateString()Gets the LookbackDateString attribute of the Simulation object- Returns:
- The LookbackDateString value
-
setLookbackDate
Sets the LookbackDate attribute of the Simulation object- Parameters:
date- The new LookbackDate value
-
getModelTrials
-
getUnusedModelTrials
-
getTrialRunNames
Vector getTrialRunNames()returns a Vector of the names of the SimulationTrialRuns that this SimulationPeriod holds -
createNewTrialRun
-