API Examples and Methods

The GenRocket runtime application interface allows programmers to access the GenRocket runtime directly create scenarios from their own programs.

--api-file
Description The GenRocket API helps to update the Scenario at runtime just before execution from the user's system or server without going online and l...
Fri, 17 May, 2024 at 1:18 PM
API Method - Initialize
Description This method is used to initialize a Scenario prior to calling the method scenarioRun(scenarioName).  This method needs to be called when contro...
Thu, 25 Apr, 2019 at 10:31 AM
API Method - ScenarioLoad
Description This method is used to load a GenRocket Scenario, Scenario Chain & Scenario Chainset. The GenRocket API requires loading a valid Scenario...
Mon, 2 Sep, 2019 at 3:16 AM
API Method Scenarios
Description This method returns the list of Scenario names.  This method is useful for retrieving the list of Scenarios within a Scenario chain.  The name ...
Sun, 23 Apr, 2017 at 2:01 PM
API Method ScenarioClear
Description This method is used to remove all Domains and Receivers from a Scenario; this will enable a Scenario to be built from scratch.  This method is ...
Fri, 29 Sep, 2023 at 7:25 AM
API Method ScenarioRun
Description This method is used to run a Scenario. Exceptions The following GenRocket exceptions may be thrown by this method:   If no Scenarios ha...
Tue, 23 Jan, 2018 at 8:30 PM
API Method ScenarioRunInMemory
Description This method is used to run Scenario and returns the results in memory only.  In the Scenario, all Receivers are disabled and a SimpleMapReceive...
Wed, 31 Oct, 2018 at 9:07 AM
API Method ScenarioRename
Description This method renames the current name of a Scenario. Requirements  The GenRocket API requires loading a valid Scenario in order to do secu...
Tue, 12 Dec, 2017 at 1:34 PM
API Method ScenarioExecuteLoop
Description This method is used to execute a single loop of the GenRocket engine.  Use this method when it is absolutely necessary to control each iteratio...
Tue, 12 Dec, 2017 at 1:16 PM
API Method ExecuteShutdown
Description The executeShutdown method must be used in conjunction with the scenarioExecuteLoop() method to complete the GenRocket engine's life cycle....
Tue, 12 Dec, 2017 at 1:22 PM