org.ptolemy.fmi
Class FMIModelDescription

java.lang.Object
  extended by org.ptolemy.fmi.FMIModelDescription

public class FMIModelDescription
extends java.lang.Object

An object that represents the fmiModelDescription element of a modelDescription.xml file contained within a Functional Mock-up Interface (.fmu) file.

A Functional Mock-up Unit file is a .fmu file in zip format that contains a .xml file named "modelDescription.xml". This class is a representation of the elements of that file.

FMI documentation may be found at http://www.modelisar.com/fmi.html.

Version:
$Id: FMIModelDescription.java 63521 2012-05-09 23:25:18Z cxh $
Author:
Christopher Brooks
Accepted Rating:
Red (cxh)
Proposed Rating:
Red (cxh)

Field Summary
 java.util.List<java.io.File> files
          The list of files that were extracted from the .fmu file.
 java.lang.String fmiVersion
          The fmiVersion, typically the value of the fmiVersion attribute from a .fmu file.
 java.lang.String guid
          The FMI guid, typically the value of the guid attribute from a .fmu file.
 java.lang.String modelIdentifier
          The FMI modelIdentifier, typically the value of the modelIdentifier attribute from a .fmu file.
 java.lang.String modelName
          The FMI modelName, typically the value of the modelName attribute from a .fmu file.
 java.util.List<FMIScalarVariable> modelVariables
          The list of ScalarVariable elements.
 com.sun.jna.NativeLibrary nativeLibrary
          The NativeLibrary associated with the platform-dependent shared library in the .fmu file.
 int numberOfContinuousStates
          Number of continuous states.
 int numberOfEventIndicators
          Number of event indicators.
 java.util.Map<java.lang.String,java.lang.String> typeDefinitions
          A map from TypeDefinition type name declarations to the defined type name.
 
Constructor Summary
FMIModelDescription()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

files

public java.util.List<java.io.File> files
The list of files that were extracted from the .fmu file.


fmiVersion

public java.lang.String fmiVersion
The fmiVersion, typically the value of the fmiVersion attribute from a .fmu file. The fmiVersion field is set to 1.0 for FMI 1.0.


guid

public java.lang.String guid
The FMI guid, typically the value of the guid attribute from a .fmu file. The value of guid in the modelDescription.xml file must match the guid in the shared library.


modelIdentifier

public java.lang.String modelIdentifier
The FMI modelIdentifier, typically the value of the modelIdentifier attribute from a .fmu file. The modelIdentifier is the basename for the shared library.


modelName

public java.lang.String modelName
The FMI modelName, typically the value of the modelName attribute from a .fmu file. The modelName may have spaces in it.


modelVariables

public java.util.List<FMIScalarVariable> modelVariables
The list of ScalarVariable elements.


nativeLibrary

public com.sun.jna.NativeLibrary nativeLibrary
The NativeLibrary associated with the platform-dependent shared library in the .fmu file.


numberOfContinuousStates

public int numberOfContinuousStates
Number of continuous states.


numberOfEventIndicators

public int numberOfEventIndicators
Number of event indicators.


typeDefinitions

public java.util.Map<java.lang.String,java.lang.String> typeDefinitions
A map from TypeDefinition type name declarations to the defined type name.

Constructor Detail

FMIModelDescription

public FMIModelDescription()