org.openmodelica.simulation.core.models.modelica
Class ModelicaModel

java.lang.Object
  extended by org.openmodelica.simulation.core.models.modelica.ModelicaModel

public class ModelicaModel
extends java.lang.Object

Represents the whole Modelica model with all data which are necessary to simulate a model It contains general model information and a Modelica main class with all properties and their values

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

Constructor Summary
ModelicaModel()
           
ModelicaModel(java.lang.String name, java.lang.String id, java.lang.String version, java.lang.String author, java.lang.String company, java.lang.String comment, java.lang.Integer n_states, java.lang.Integer n_algebraics, java.lang.Integer n_parameters, java.lang.Integer n_inputVars, java.lang.Integer n_outputVars, java.lang.Integer n_string_parameters, java.lang.Integer n_string_variables)
          This Constructor can be used if the general model information are available yet e.g. while reading a "SimInit.xml" or "SimConfig.xml"
 
Method Summary
static ModelicaModel createExampleProject()
          Creates an example Modelica model containing the following data name "Project" id "4021" version "1.2.2" author "Parham" company "EADS" comment "No comment yet" Also containing a Modelica main class: "TwoTanksMain", "TanksConnectedPI", "This is the Mainclass" With a variable "tank1.h", "Real", "No comments yet"
 java.lang.String getAuthor()
           
 java.lang.String getComment()
           
 java.lang.String getCompany()
           
 java.lang.String getId()
           
 ModelicaMainclass getMainclass()
           
 java.lang.Integer getN_algebraics()
           
 java.lang.Integer getN_inputVars()
           
 java.lang.Integer getN_outputVars()
           
 java.lang.Integer getN_parameters()
           
 java.lang.Integer getN_states()
           
 java.lang.Integer getN_string_parameters()
           
 java.lang.Integer getN_string_variables()
           
 java.lang.String getName()
           
 java.lang.String getVersion()
           
 void setMainclass(ModelicaMainclass mainclass)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ModelicaModel

public ModelicaModel()

ModelicaModel

public ModelicaModel(java.lang.String name,
                     java.lang.String id,
                     java.lang.String version,
                     java.lang.String author,
                     java.lang.String company,
                     java.lang.String comment,
                     java.lang.Integer n_states,
                     java.lang.Integer n_algebraics,
                     java.lang.Integer n_parameters,
                     java.lang.Integer n_inputVars,
                     java.lang.Integer n_outputVars,
                     java.lang.Integer n_string_parameters,
                     java.lang.Integer n_string_variables)
This Constructor can be used if the general model information are available yet e.g. while reading a "SimInit.xml" or "SimConfig.xml"

Parameters:
name - Model name
id - Model identification number
version - Model version
author - Model author
company - A company which has right on this model
comment - Developer or User comments
n_states - Number of State variables
n_algebraics - Number of Algebraic variables
n_parameters - Number of Parameters
n_inputVars - Number of InputVariables (Not used yet)
n_outputVars - Number of OutPutVariables (Not used yet)
n_string_parameters - Number of string parameters (Not used yet)
n_string_variables - Number of string variables (Not used yet)
Method Detail

getName

public java.lang.String getName()

getId

public java.lang.String getId()

getVersion

public java.lang.String getVersion()

getAuthor

public java.lang.String getAuthor()

getCompany

public java.lang.String getCompany()

getComment

public java.lang.String getComment()

getN_states

public java.lang.Integer getN_states()

getN_algebraics

public java.lang.Integer getN_algebraics()

getN_parameters

public java.lang.Integer getN_parameters()

getN_inputVars

public java.lang.Integer getN_inputVars()

getN_outputVars

public java.lang.Integer getN_outputVars()

getN_string_parameters

public java.lang.Integer getN_string_parameters()

getN_string_variables

public java.lang.Integer getN_string_variables()

getMainclass

public ModelicaMainclass getMainclass()

setMainclass

public void setMainclass(ModelicaMainclass mainclass)

toString

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

createExampleProject

public static ModelicaModel createExampleProject()
Creates an example Modelica model containing the following data name "Project" id "4021" version "1.2.2" author "Parham" company "EADS" comment "No comment yet" Also containing a Modelica main class: "TwoTanksMain", "TanksConnectedPI", "This is the Mainclass" With a variable "tank1.h", "Real", "No comments yet"

Returns:
a full initialized ModelicaModel with example data, an example modelica main class and a variable