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

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

public class ModelicaMainclass
extends java.lang.Object

Represents the Modelica main class which contains all properties and their values

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

Constructor Summary
ModelicaMainclass(java.lang.String name, java.lang.String type, java.lang.String comment)
          Defalt constructor
 
Method Summary
 void addInputVariable(ModelicaProperty inputVariable)
          Puts a new InputVariable into the InputVariable map If the InputVariable name exists the value will be overwritten
 void addOutputVariable(ModelicaProperty outputVariable)
          Puts a new OutputVariable into the OutputVariable map If the OutputVariable name exists the value will be overwritten
 void addParameter(ModelicaProperty parameter)
          Puts a new parameter into the parameters map If the parameter name exists the value will be overwritten
 void addVariable(ModelicaProperty variable)
          Puts a new variable into the variables map If the variable name exists the value will be overwritten
 java.util.Set<java.lang.String> getAllFullQualifiedInputVariableNames()
          Returns all in the inputVariables collection containing inputVariable names
 java.util.Set<java.lang.String> getAllFullQualifiedOutputVariableNames()
          Returns all in the OutputVariable collection containing OutputVariable names
 java.util.Set<java.lang.String> getAllFullQualifiedParameterNames()
          Returns all in the parameter collection containing parameter names
 java.util.Set<java.lang.String> getAllFullQualifiedVariableNames()
          Returns all in the variable collection containing variable names
 java.lang.String getComment()
           
 ModelicaProperty getInputVariableByName(java.lang.String fullQualifiedName)
          Searches in the InputVariable collection to return a Modelica Property from the math type InputVariable with a given full qualified name.
 java.lang.String getName()
           
 ModelicaProperty getOutputVariableByName(java.lang.String fullQualifiedName)
          Searches in the OutputVariable collection to return a Modelica Property from the math type OutputVariable with a given full qualified name.
 ModelicaProperty getParameterByName(java.lang.String fullQualifiedName)
          Searches in the parameter collection to return a Modelica Property from the math type parameter with a given full qualified name.
 java.lang.String getType()
           
 ModelicaProperty getVariableByName(java.lang.String fullQualifiedName)
          Searches in the variable collection to return a Modelica Property from the math type state or algebraic with a given full qualified name.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ModelicaMainclass

public ModelicaMainclass(java.lang.String name,
                         java.lang.String type,
                         java.lang.String comment)
Defalt constructor

Parameters:
name - Is the name of the Modelica main class
type - Is the class name of the Modelica main class
comment - All comments from the developer of this class
Method Detail

getName

public java.lang.String getName()

getComment

public java.lang.String getComment()

getType

public java.lang.String getType()

getAllFullQualifiedVariableNames

public java.util.Set<java.lang.String> getAllFullQualifiedVariableNames()
Returns all in the variable collection containing variable names

Returns:
set of strings with all full qualified variable names

getAllFullQualifiedParameterNames

public java.util.Set<java.lang.String> getAllFullQualifiedParameterNames()
Returns all in the parameter collection containing parameter names

Returns:
set of strings with all full qualified parameter names

getAllFullQualifiedInputVariableNames

public java.util.Set<java.lang.String> getAllFullQualifiedInputVariableNames()
Returns all in the inputVariables collection containing inputVariable names

Returns:
set of strings with all full qualified inputVariable names

getAllFullQualifiedOutputVariableNames

public java.util.Set<java.lang.String> getAllFullQualifiedOutputVariableNames()
Returns all in the OutputVariable collection containing OutputVariable names

Returns:
set of strings with all full qualified OutputVariable names

getVariableByName

public ModelicaProperty getVariableByName(java.lang.String fullQualifiedName)
Searches in the variable collection to return a Modelica Property from the math type state or algebraic with a given full qualified name.

Parameters:
fullQualifiedName -
Returns:
If the variable collection contains a Modelica variable with the name fullQualifiedName, the variable will be return. Otherwise a null will be returned

getParameterByName

public ModelicaProperty getParameterByName(java.lang.String fullQualifiedName)
Searches in the parameter collection to return a Modelica Property from the math type parameter with a given full qualified name.

Parameters:
fullQualifiedName -
Returns:
If the parameter collection contains a Modelica parameter with the name fullQualifiedName, the parameter will be return. Otherwise a null will be returned

getInputVariableByName

public ModelicaProperty getInputVariableByName(java.lang.String fullQualifiedName)
Searches in the InputVariable collection to return a Modelica Property from the math type InputVariable with a given full qualified name.

Parameters:
fullQualifiedName -
Returns:
If the InputVariable collection contains a Modelica InputVariable with the name fullQualifiedName, the parameter will be return. Otherwise a null will be returned

getOutputVariableByName

public ModelicaProperty getOutputVariableByName(java.lang.String fullQualifiedName)
Searches in the OutputVariable collection to return a Modelica Property from the math type OutputVariable with a given full qualified name.

Parameters:
fullQualifiedName -
Returns:
If the OutputVariable collection contains a Modelica OutputVariable with the name fullQualifiedName, the parameter will be return. Otherwise a null will be returned

addVariable

public void addVariable(ModelicaProperty variable)
Puts a new variable into the variables map If the variable name exists the value will be overwritten

Parameters:
variable - from type ModelicaProperty

addParameter

public void addParameter(ModelicaProperty parameter)
Puts a new parameter into the parameters map If the parameter name exists the value will be overwritten

Parameters:
parameter - from type ModelicaProperty

addInputVariable

public void addInputVariable(ModelicaProperty inputVariable)
Puts a new InputVariable into the InputVariable map If the InputVariable name exists the value will be overwritten

Parameters:
InputVariable - from type ModelicaProperty

addOutputVariable

public void addOutputVariable(ModelicaProperty outputVariable)
Puts a new OutputVariable into the OutputVariable map If the OutputVariable name exists the value will be overwritten

Parameters:
OutputVariable - from type ModelicaProperty

toString

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