omc.corba

Class OMCInterface

java.lang.Object

omc.corba.OMCInterface

Direct Known Subclasses:

OMCClient

public abstract class OMCInterface
extends java.lang.Object

Represents a connection to omc over CORBA. A CORBA client is only usable after a call to connect and until a call to disconnect.

Note: Java's CORBA-API uses the java.util.logging framework. If you use another logging framework (for example Logback) you should supress logging from java.util.logging. It's not possible to control the JUC framework from another logging framework. SLF4J has an adapter to route JUC logging into SLF4J. Note that this adapter has performance issues!

A typical workflow with implementations is:

 
  OMCInterface client = new OMCClient();
  client.connect();
  //client is connected; start using it
  client.sendExpression("model test end test;");
  ...
  client.disconnect();
  //client disconnected; stop using it
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	fallbackLocale
static java.lang.String	GET_ERRORS
static java.lang.String	localeEnvVariable
protected org.slf4j.Logger	log
static int	maxSleep
static int	maxTrys

Constructor Summary

Constructors

Constructor and Description
OMCInterface()
OMCInterface(org.slf4j.Logger log)

Method Summary

Modifier and Type	Method and Description
Result	call(java.lang.String functionName, java.lang.Object... args) Calls the function `functionName` with the given arguments.
Result	cd(java.nio.file.Path path)
java.lang.String	checkAllModelsRecursive(java.lang.String modelName) Checks the model `modelName` with the scripting function checkModelsRecursive().
java.lang.String	checkModel(java.lang.String modelName) Checks the model `modelName` with the scripting function checkModel().
abstract void	connect() Connects this client to omc.
abstract void	disconnect() Disconnects this client from omc.
java.util.Optional<java.lang.String>	getClassInformation(java.lang.String className) Returns the class informations about `className`.
java.util.List<java.lang.String>	getList(java.lang.String functionName, java.lang.Object... args) Calls the function `functionName` with the given arguments, converting the result into a List of Strings.
Version	getVersion()
boolean	is_(java.lang.String type, java.lang.String className) Tests wether the `className` is a `type`.
abstract Result	sendExpression(java.lang.String expression) Sends the given expression to omc & returning the result from omc.

Methods inherited from class java.lang.Object

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

Field Detail

GET_ERRORS

public static java.lang.String GET_ERRORS

fallbackLocale

public static java.lang.String fallbackLocale

localeEnvVariable

public static java.lang.String localeEnvVariable

maxTrys

public static final int maxTrys

See Also:

Constant Field Values

maxSleep

public static final int maxSleep

See Also:

Constant Field Values

log

protected final org.slf4j.Logger log

Constructor Detail

OMCInterface

public OMCInterface()

OMCInterface

public OMCInterface(org.slf4j.Logger log)

Method Detail

sendExpression

public abstract Result sendExpression(java.lang.String expression)

Sends the given expression to omc & returning the result from omc.

Parameters:

expression - a modelica-expression

Returns:

answer from omc

connect

public abstract void connect()
                      throws java.io.IOException

Connects this client to omc.

Throws:

java.io.IOException - if an io-error occurs

See Also:

disconnect()

disconnect

public abstract void disconnect()
                         throws java.io.IOException

Disconnects this client from omc.

Throws:

java.io.IOException - if an io-error occurs

See Also:

connect()

call

public Result call(java.lang.String functionName,
                   java.lang.Object... args)

Calls the function `functionName` with the given arguments. The arguments are converted into Strings using `toString()`.

is_

public boolean is_(java.lang.String type,
                   java.lang.String className)

Tests wether the `className` is a `type`. This function prepends `is` to `type`.

getList

public java.util.List<java.lang.String> getList(java.lang.String functionName,
                                                java.lang.Object... args)

Calls the function `functionName` with the given arguments, converting the result into a List of Strings.

Note: If an error occurs the result is an empty list.

checkModel

public java.lang.String checkModel(java.lang.String modelName)

Checks the model `modelName` with the scripting function checkModel().

checkAllModelsRecursive

public java.lang.String checkAllModelsRecursive(java.lang.String modelName)

Checks the model `modelName` with the scripting function checkModelsRecursive().

getClassInformation

public java.util.Optional<java.lang.String> getClassInformation(java.lang.String className)

Returns the class informations about `className`.

Note: If an error occurs the result is empty.

cd

public Result cd(java.nio.file.Path path)

getVersion

public Version getVersion()