org.openmodelica.simulation.core.models.simulation
Class SimulationProject

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

public class SimulationProject
extends java.lang.Object

The SimulationProject contains all information about a simulation project which are stored for example in the org.modelica.simulation.projects path of the eclipse workspace

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

Constructor Summary
SimulationProject(java.lang.String projectName, java.lang.String id, java.lang.String version, java.lang.String author, java.lang.String company, java.lang.String comment)
          Use this constructor if you want to generate a SimulationProject object from a SimProject.xml file Note: Please set the simulation project folder path afterwards
SimulationProject(java.lang.String projectName, java.lang.String id, java.lang.String version, java.lang.String author, java.lang.String company, java.lang.String comment, java.lang.String simulationProjectFolderPath)
          Use this constructor if you want to generate a SimulationProject using the project wizard
 
Method Summary
 void addSimSessConfigs(SimulationSessionConfiguration simSessConfig)
          Adds a simulation session configuration to the simulation project Note: Name for this configuration file should be unique otherwise it will overwrite an existing session configuration file from a simulation project Please ask if name is in use before adding an configuration
 ModelicaModel getModelicaModel()
          Returns the used modelica model
 java.lang.String getModelicaModelName()
           
 java.lang.String getProjectAuthor()
           
 java.lang.String getProjectComment()
           
 java.lang.String getProjectCompany()
           
 java.lang.String getProjectId()
           
 java.lang.String getProjectName()
           
 java.lang.String getProjectVersion()
           
 SimulationSessionConfiguration getSimSessConfig(java.lang.String name)
          Returns an Simulation Session Configuration from the session config container
 java.util.Set<java.lang.String> getSimSessionConfigs()
          Returns all available simulation session configurations for a simulation project as a set of config names
 java.lang.String getSimulationProjectFolderPath()
           
static void main(java.lang.String[] args)
           
 void setModelicaModel(ModelicaModel modelicaModel)
           
 void setProjectAuthor(java.lang.String author)
           
 void setProjectComment(java.lang.String comment)
           
 void setProjectCompany(java.lang.String company)
           
 void setProjectName(java.lang.String projectName)
           
 void setProjectVersion(java.lang.String version)
           
 void setSimulationProjectFolderPath(java.lang.String simulationProjectFolderPath)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SimulationProject

public SimulationProject(java.lang.String projectName,
                         java.lang.String id,
                         java.lang.String version,
                         java.lang.String author,
                         java.lang.String company,
                         java.lang.String comment,
                         java.lang.String simulationProjectFolderPath)
Use this constructor if you want to generate a SimulationProject using the project wizard

Parameters:
projectName - Simulation project name
id - Simulation project identification number
version - Simulation project version
author - Simulation project author
company - Company name, respective rights
comment - simulation project designer or user comments
simulationProjectFolderPath - Path to the root simulation project folder

SimulationProject

public SimulationProject(java.lang.String projectName,
                         java.lang.String id,
                         java.lang.String version,
                         java.lang.String author,
                         java.lang.String company,
                         java.lang.String comment)
Use this constructor if you want to generate a SimulationProject object from a SimProject.xml file Note: Please set the simulation project folder path afterwards

Parameters:
projectName - Simulation project name
id - Simulation project identification number
version - Simulation project version
author - Simulation project author
company - Company name, respective rights
comment - Simulation project designer or user comments
Method Detail

getProjectName

public java.lang.String getProjectName()

setProjectName

public void setProjectName(java.lang.String projectName)

getProjectId

public java.lang.String getProjectId()

getModelicaModel

public ModelicaModel getModelicaModel()
Returns the used modelica model


setModelicaModel

public void setModelicaModel(ModelicaModel modelicaModel)

getProjectVersion

public java.lang.String getProjectVersion()

setProjectVersion

public void setProjectVersion(java.lang.String version)

getProjectAuthor

public java.lang.String getProjectAuthor()

setProjectAuthor

public void setProjectAuthor(java.lang.String author)

getProjectCompany

public java.lang.String getProjectCompany()

setProjectCompany

public void setProjectCompany(java.lang.String company)

getProjectComment

public java.lang.String getProjectComment()

setProjectComment

public void setProjectComment(java.lang.String comment)

getModelicaModelName

public java.lang.String getModelicaModelName()

addSimSessConfigs

public void addSimSessConfigs(SimulationSessionConfiguration simSessConfig)
Adds a simulation session configuration to the simulation project Note: Name for this configuration file should be unique otherwise it will overwrite an existing session configuration file from a simulation project Please ask if name is in use before adding an configuration

Parameters:
simSessConfig - a new Simulation Session configuration

getSimSessConfig

public SimulationSessionConfiguration getSimSessConfig(java.lang.String name)
Returns an Simulation Session Configuration from the session config container

Parameters:
name - Configuration name to find a specified configuration from the container
Returns:
a Simulation Session Configuration object

getSimSessionConfigs

public java.util.Set<java.lang.String> getSimSessionConfigs()
Returns all available simulation session configurations for a simulation project as a set of config names

Returns:
a set of all simulation session configuration names

getSimulationProjectFolderPath

public java.lang.String getSimulationProjectFolderPath()

setSimulationProjectFolderPath

public void setSimulationProjectFolderPath(java.lang.String simulationProjectFolderPath)

toString

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

main

public static void main(java.lang.String[] args)