ptolemy.domains.openmodelica.lib.omc

Interface IOMCCommand

All Known Implementing Classes:

OMCCommand

public interface IOMCCommand

The interface to the OMCCommand.

Since:

Ptolemy II 11.0

Version:

$Id$

Author:

Mana Mirzaei

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

Method Summary

Modifier and Type	Method and Description
boolean	getInheritanceCount(java.lang.String modelName) Check if the (base-)model inherits from other classes.
java.util.HashMap	getModelComponent(java.lang.String modelName) Return the list of component declarations within (base-)model.
void	initializeServer() Initialize the communication with the (OpenModelica compiler)OMC.
boolean	isError(java.lang.String retval) Check if there is an error in the return value of sendCommand("command") method and fetch the error-information of current run.
void	loadModelicaFile(java.lang.String fileName, java.lang.String modelName) load the Modelica file(s) and library.
void	modifyComponents(java.lang.String values, java.lang.String modelName, java.lang.String components) Modify parameter(s) and variable(s) of the Modelica model before building the Modelica model.
void	plotPltFile(java.lang.String modelName) Plot the plt file by calling PxgraphApplication.main(modelName).
void	runModel(java.lang.String fileName, java.lang.String modelName, java.lang.String startTime, java.lang.String stopTime, int numberOfIntervals, java.lang.String outputFormat, java.lang.String processingMode) Build the Modelica model.
void	stopServer() Leave and quit OpenModelica environment.

Method Detail

getInheritanceCount

boolean getInheritanceCount(java.lang.String modelName)

Check if the (base-)model inherits from other classes.

Parameters:

modelName - The (base-)model that should be built.

Returns:

Check Return true, if the number of inherited classes is more than zero.

getModelComponent

java.util.HashMap getModelComponent(java.lang.String modelName)

Return the list of component declarations within (base-)model.

Parameters:

modelName - The (base-)model that should be built.

Returns:

HashMap The list of component declarations within (base-)model.

initializeServer

void initializeServer()
               throws ConnectException

Initialize the communication with the (OpenModelica compiler)OMC.

Throws:

ConnectException - If we're unable to start communicating with the server.

isError

boolean isError(java.lang.String retval)

Check if there is an error in the return value of sendCommand("command") method and fetch the error-information of current run.

Parameters:

retval - The string returned by the (OpenModelica Compiler)OMC.

Returns:

Check If the string is actually an error.

loadModelicaFile

void loadModelicaFile(java.lang.String fileName,
                      java.lang.String modelName)
               throws ConnectException

load the Modelica file(s) and library.

Parameters:

fileName - File which the model should be loaded from.

modelName - Name of the model which should be built.

Throws:

ConnectException - If commands couldn't be sent to the (OpenModelic Compiler)OMC.

modifyComponents

void modifyComponents(java.lang.String values,
                      java.lang.String modelName,
                      java.lang.String components)
               throws IllegalActionException,
                      ConnectException

Modify parameter(s) and variable(s) of the Modelica model before building the Modelica model.

Parameters:

values - New values to change the components' values.

modelName - The (base-)model that should be built.

components - The models' components to change.

Throws:

ConnectException - If commands couldn't be sent to the (OpenModelica Compiler)OMC.

IllegalActionException

plotPltFile

void plotPltFile(java.lang.String modelName)
          throws ConnectException

Plot the plt file by calling PxgraphApplication.main(modelName).

Parameters:

modelName - Name of the model which should be built.

Throws:

ConnectException - If commands could not be sent to the OMC.

runModel

void runModel(java.lang.String fileName,
              java.lang.String modelName,
              java.lang.String startTime,
              java.lang.String stopTime,
              int numberOfIntervals,
              java.lang.String outputFormat,
              java.lang.String processingMode)
       throws ConnectException,
              java.io.IOException,
              IllegalActionException

Build the Modelica model. Then, run the executable result file of buildModel() in both interactive and non-interactive processing mode in order to generate the simulation result file.

Parameters:

fileName - File which the model should be loaded from.

modelName - Name of the (base-)model which should be built.

startTime - The start time of simulation.

stopTime - The stop time of simulation.

numberOfIntervals - Number of intervals in the result file.

outputFormat - Format of the result file.

processingMode - The mode of processing for running the executable result file of building the Modelica model.

Throws:

ConnectException - If commands couldn't be sent to the (OpenModelic Compiler)OMC.

java.io.IOException - If the executable result file of buildModel() couldn't be executed.

IllegalActionException

stopServer

void stopServer()
         throws ConnectException

Leave and quit OpenModelica environment.

Throws:

ConnectException - If quit command couldn't be sent to the OMC.