org.openmodelica.simulation.core.models.simulation
Class SimulationSetting

java.lang.Object
  extended by org.openmodelica.simulation.core.models.simulation.SimulationSetting

public class SimulationSetting
extends java.lang.Object

Simulating a model should be done with different setting. This could help to find problems or to research a model. A Simulation Setting is part of a Session Configuration and helps the user to run a simulation in different settings and to archive this settings A Setting is not changeable, because otherwise the used data get lost. The user can overwrite an existing setting

Author:
EADS Innovation Works, Parham Vasaiely, Parham.Vasaiely@gmx.de

Constructor Summary
SimulationSetting(java.lang.String name, java.lang.String version, java.lang.String author, java.lang.String company, java.lang.String comment, int numberOfRuns, java.lang.String runtimeControlServerIp, java.lang.String runtimeControlServerPort, java.lang.String simulationControlServerIp, java.lang.String simulationControlServerPort, java.lang.String simulationTransferServerIp, java.lang.String simulationTransferServerPort, java.lang.String simStepTimeInSeconds, java.lang.String tolerance, java.lang.String solver)
          Use this constructor as default
 
Method Summary
 java.lang.String getAuthor()
           
 java.lang.String getComment()
           
 java.lang.String getCompany()
           
 java.lang.String getName()
           
 int getNumberOfRuns()
           
 java.lang.String getRuntimeControlServerIp()
           
 java.lang.String getRuntimeControlServerPort()
           
 java.lang.String getSimStepTime()
          The simulation step time is an interval of output results
 java.lang.String getSimulationControlServerIp()
           
 java.lang.String getSimulationControlServerPort()
           
 java.lang.String getSimulationTransferServerIp()
           
 java.lang.String getSimulationTransferServerPort()
           
 java.lang.String getSolver()
           
 java.lang.String getTolerance()
           
 java.lang.String getVersion()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SimulationSetting

public SimulationSetting(java.lang.String name,
                         java.lang.String version,
                         java.lang.String author,
                         java.lang.String company,
                         java.lang.String comment,
                         int numberOfRuns,
                         java.lang.String runtimeControlServerIp,
                         java.lang.String runtimeControlServerPort,
                         java.lang.String simulationControlServerIp,
                         java.lang.String simulationControlServerPort,
                         java.lang.String simulationTransferServerIp,
                         java.lang.String simulationTransferServerPort,
                         java.lang.String simStepTimeInSeconds,
                         java.lang.String tolerance,
                         java.lang.String solver)
Use this constructor as default

Parameters:
name - Session Configuration name where this setting belongs to
version - Session configuration version
author - Session configuration author
company - A company which has right on this Session configuration
comment - Developer or User comments
numberOfRuns - Number of simulations using this Session Configuration
runtimeControlServerIp - IP of the simulation runtime Control server
runtimeControlServerPort - Port of the simulation runtime Control server
simulationControlServerIp - IP of the simulation environment Control server
simulationControlServerPort - Port of the simulation environment Control server
simulationTransferServerIp - IP of the simulation environment Transfer server
simulationTransferServerPort - Port of the simulation environment Transfer server
simStepTimeInSeconds - Interval between single calculation steps
tolerance - Solver calculation tolerance
solver - Solver which should be used during a simulation (DASSL, Euler, RK4)
Method Detail

getName

public java.lang.String getName()

getVersion

public java.lang.String getVersion()

getAuthor

public java.lang.String getAuthor()

getCompany

public java.lang.String getCompany()

getComment

public java.lang.String getComment()

getNumberOfRuns

public int getNumberOfRuns()

getRuntimeControlServerPort

public java.lang.String getRuntimeControlServerPort()

getSimulationControlServerPort

public java.lang.String getSimulationControlServerPort()

getSimulationTransferServerPort

public java.lang.String getSimulationTransferServerPort()

getSolver

public java.lang.String getSolver()

getRuntimeControlServerIp

public java.lang.String getRuntimeControlServerIp()

getSimulationControlServerIp

public java.lang.String getSimulationControlServerIp()

getSimulationTransferServerIp

public java.lang.String getSimulationTransferServerIp()

getSimStepTime

public java.lang.String getSimStepTime()
The simulation step time is an interval of output results

Returns:
simulation step time in seconds

getTolerance

public java.lang.String getTolerance()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object