Package hec.rss.model
Interface ScriptedRuleJavaInfc
public interface ScriptedRuleJavaInfc
The Interface ScriptedRuleJavaInfc used to create scripted rules in Java
-
Method Summary
Modifier and TypeMethodDescriptionbooleaninitRuleScript(OpRule currentRule, RssSystem network) Initializes the rule script.runRuleScript(OpRule currentRule, RssSystem network, RunTimeStep currentRuntimestep) Run rule script.
-
Method Details
-
initRuleScript
Initializes the rule script.- Parameters:
currentRule- the current rulenetwork- the RssSystem (ResSim Network)- Returns:
- true, if successful
-
runRuleScript
Run rule script. runRuleScript() is the entry point that is called during the compute.- Parameters:
currentRule- the rule that holds this scriptnetwork- the RssSystem (ResSim Network)currentRuntimestep- the current Run Time Step- Returns:
- the op value OpValue
-