ptolemy.domains.openmodelica.lib.omc

Class OMCCommand

java.lang.Object

ptolemy.domains.openmodelica.lib.omc.OMCCommand

All Implemented Interfaces:

IOMCCommand

public class OMCCommand
extends java.lang.Object
implements IOMCCommand

OMCCommand is composed of the implementation of the commands for initializing the communication with the OpenModelica compiler(OMC) server, building the Modelica model, fetching the error-information of current run, loading the Modelica file and library and modifying parameter(s) and variable(s) of the Modelica model before building the Modelica model in both interactive and non-interactive processing mode. In addition to executing all these Modelica commands, it plots the result file of the simulation that is generated in plt format.

Since:

Ptolemy II 11.0

Version:

$Id$

Author:

Mana Mirzaei, Based on OMCProxy by Adrian Pop, Elmir Jagudin, Andreas Remar

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

Field Summary

Fields

Modifier and Type	Field and Description
boolean	hasInitialized Check if the communication with OpenModelica Compiler(OMC) is set up.
OmcCommunication	omcCommunication The CORBA object for OpenModelica Compiler(OMC) communication.

Method Summary

Modifier and Type	Method and Description
boolean	getInheritanceCount(java.lang.String modelName) Check if the (base-)model inherits from other classes.
static OMCCommand	getInstance() Create an instance of OMCCommand object in order to provide a global point of access to the instance.
java.util.HashMap	getModelComponent(java.lang.String modelName) Return the list of component declarations within (base-)model.
static ptolemy.domains.openmodelica.lib.omc.OMCCommand._osType	getOs() Fetch the type of Operating System(OS).
void	initializeServer() Initialize the communication with the OpenModelica compiler(OMC) server.
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 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 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.
CompilerResult	sendCommand(java.lang.String modelicaCommand) Send a command to the OpenModelica Compiler(OMC) server and fetches the string result.
void	stopServer() Leave OpenModelica environment, destroy the OMC process and deallocate OMCCommand object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

hasInitialized

public boolean hasInitialized

Check if the communication with OpenModelica Compiler(OMC) is set up.

omcCommunication

public OmcCommunication omcCommunication

The CORBA object for OpenModelica Compiler(OMC) communication.

Method Detail

getInheritanceCount

public boolean getInheritanceCount(java.lang.String modelName)

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

Specified by:

getInheritanceCount in interface IOMCCommand

Parameters:

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

Returns:

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

getInstance

public static OMCCommand getInstance()

Create an instance of OMCCommand object in order to provide a global point of access to the instance. It provides a unique source of OMCCommand instance.

Returns:

An OMCCommand object representing the instance value.

getModelComponent

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

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

Specified by:

getModelComponent in interface IOMCCommand

Parameters:

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

Returns:

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

getOs

public static ptolemy.domains.openmodelica.lib.omc.OMCCommand._osType getOs()

Fetch the type of Operating System(OS).

Returns:

osType The name of the operating system(OS).

initializeServer

public void initializeServer()
                      throws ConnectException

Initialize the communication with the OpenModelica compiler(OMC) server.

Specified by:

initializeServer in interface IOMCCommand

Throws:

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

isError

public 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.

Specified by:

isError in interface IOMCCommand

Parameters:

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

Returns:

Checks If the string is actually an error.

loadModelicaFile

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

load the Modelica file and library.

Specified by:

loadModelicaFile in interface IOMCCommand

Parameters:

fileName - File that the (base-)model should be loaded from.

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

Throws:

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

ConnectException - If no file found at the selective path for loading.

modifyComponents

public 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 model.

Specified by:

modifyComponents in interface IOMCCommand

Parameters:

values - The new values to change the value of the components.

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

components - The name of the components to change.

Throws:

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

IllegalActionException

plotPltFile

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

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

Specified by:

plotPltFile in interface IOMCCommand

Parameters:

modelName - Name of the model which should be built.

Throws:

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

runModel

public 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.

Specified by:

runModel in interface IOMCCommand

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

sendCommand

public CompilerResult sendCommand(java.lang.String modelicaCommand)
                           throws ConnectException

Send a command to the OpenModelica Compiler(OMC) server and fetches the string result.

Parameters:

modelicaCommand - The command which should be sent to the OMC.

Returns:

CompilerResult The result of sendExpression("modelicaCommand") to the OMC.

Throws:

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

stopServer

public void stopServer()
                throws ConnectException

Leave OpenModelica environment, destroy the OMC process and deallocate OMCCommand object.

Specified by:

stopServer in interface IOMCCommand

Throws:

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