The Wrapper in SIMPLACE

Top  Previous  Next

Class: net/simplace/simulation/wrapper/SimplaceWrapper

 

Running the simulations

 

SimplaceWrapper(WorkDir, OutputDir) – inits the wrapper

prepareProject(Project,Solution) – inits the project/solution

createSimulation(parameters,doQueue)

runSimulations()

 

Fetching the results

 

getSimulationIDs – the list of simulation ids

DataContainer = getResults(outputId, simulationID)

 - DataContainer.getHeaderStrings

     - DataContainer.getTypeStrings

     - DataContainer.getHeaderUnits

 - DataContainer.getDataObjects(from,to) -> Object[][]

 

!!!  Only outputs of type MEMORY can be retrieved !!!

 

Stepwise running

 

DataContainer = step(count) – returns the whole Varmap (i.e. constants, inputs, outputs etc.) after performing count steps

DataContainer = step(filter,count) – returns only the variables in the filter list from the Varmap after performing count steps

 

The SimplaceWrapper

 

The SimplaceWrapper class provides high level functions to setup and run a simulation as well as retrieve data stored in a memory output.

These functions can be called from other programming languages that provide mechanisms to call java functions (mostly realized by JNI interfaces).

 

SIMPLACE can be installed as package for the following wrappers:

 

R package SIMPLACE

Python package SIMPLACE

Octave package SIMPLACE

Matlab SIMPLACE functions

 

 

wrappers