## On this page

  

 

 # ModelCenter

 Last update: 30.07.2026 

public class [ModelCenter](index.md) : [PHXCOMObject](./../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/index.md), [IModelCenter](./../-i-model-center/index.md)

This is the wrapper class that handles the native COM calls to ModelCenter. The class is used by Java plug-ins to ModelCenter or by stand-alone Java programs to interact with ModelCenter.

Example:

```kotlin

try
{
   ModelCenter mc = new ModelCenter();
   mc.loadModel( "d:\\test.pxc" );

   for ( int x = 0; x < 10; x++ )
   {
      System.out.print( "x = " + x );
      mc.setValue( "Model.Script.x", "" + x );
      System.out.println( ", y = " + mc.getValue( "Model.Script.y" ) );
   }

   mc.close();
}
catch ( ModelCenterException e )
{
   e.printStackTrace();
}


```

#### Author

Woyak, 9-01

## Constructors

[ModelCenter](-model-center.md)constructor()  
default constructor.  
constructor(optionStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
default constructor.  
constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), f: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html))  
Connects this Java object to the specified session of ModelCenter.  
constructor(pstrm: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), f: [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html), addRef: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))  
Connects this Java object to the specified session of ModelCenter.## Types

NameSummary[AssemblyStyle](-assembly-style/index.md)enum [AssemblyStyle](-assembly-style/index.md)  
Ways to display an assembly.[AssemblyStyleInfo](-assembly-style-info/index.md)public class [AssemblyStyleInfo](-assembly-style-info/index.md)  
Information about an assembly's visual style.[VersionStatus](-version-status/index.md)enum [VersionStatus](-version-status/index.md)  
Ways to version a file## Properties

NameSummary[ASSEMBLY\_TYPE\_ASSEMBLY](-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md)val [ASSEMBLY\_TYPE\_ASSEMBLY](-a-s-s-e-m-b-l-y_-t-y-p-e_-a-s-s-e-m-b-l-y.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Assembly"[ASSEMBLY\_TYPE\_FOR\_EACH](-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md)val [ASSEMBLY\_TYPE\_FOR\_EACH](-a-s-s-e-m-b-l-y_-t-y-p-e_-f-o-r_-e-a-c-h.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "ForEach"[ASSEMBLY\_TYPE\_IF](-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md)val [ASSEMBLY\_TYPE\_IF](-a-s-s-e-m-b-l-y_-t-y-p-e_-i-f.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "If"[ASSEMBLY\_TYPE\_PARALLEL](-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md)val [ASSEMBLY\_TYPE\_PARALLEL](-a-s-s-e-m-b-l-y_-t-y-p-e_-p-a-r-a-l-l-e-l.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Parallel"[ASSEMBLY\_TYPE\_SEQUENCE](-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md)val [ASSEMBLY\_TYPE\_SEQUENCE](-a-s-s-e-m-b-l-y_-t-y-p-e_-s-e-q-u-e-n-c-e.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "Sequence"[CONN\_ERR\_ERROR](-c-o-n-n_-e-r-r_-e-r-r-o-r.md)val [CONN\_ERR\_ERROR](-c-o-n-n_-e-r-r_-e-r-r-o-r.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 3[CONN\_ERR\_IGNORE](-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md)val [CONN\_ERR\_IGNORE](-c-o-n-n_-e-r-r_-i-g-n-o-r-e.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 1[CONN\_ERR\_USEDIALOG](-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md)val [CONN\_ERR\_USEDIALOG](-c-o-n-n_-e-r-r_-u-s-e-d-i-a-l-o-g.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = -1[MODEL\_TYPE\_DATA](-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md)val [MODEL\_TYPE\_DATA](-m-o-d-e-l_-t-y-p-e_-d-a-t-a.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "dataModel"[MODEL\_TYPE\_PROCESS](-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md)val [MODEL\_TYPE\_PROCESS](-m-o-d-e-l_-t-y-p-e_-p-r-o-c-e-s-s.md): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html) = "processModel"## Functions

NameSummary[addIcon](add-icon.md)public [addIcon](add-icon.md)(iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)  
Registers an icon with ModelCenter.[addNewMacro](add-new-macro.md)public [addNewMacro](add-new-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), isAppMacro: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))  
adds a new Macro to ModelCenter's macro facility[allowBringWindowToFront](allow-bring-window-to-front.md)public [allowBringWindowToFront](allow-bring-window-to-front.md)(processID: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))  
Use OS calls to allow another process to bring a window to the front.[autoLink](auto-link.md)public [autoLink](auto-link.md)(srcComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), destComp: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
auto links the variables of two Components[breakLink](break-link.md)public [breakLink](break-link.md)(variable: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
Breaks the link of a specified variable[checkout](checkout.md)public [checkout](checkout.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](./../-feature/index.md)  
Should check out a license feature from Ansys[checkout2](checkout2.md)public [checkout2](checkout2.md)(feature: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), productRelease: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Feature](./../-feature/index.md)  
Should check out a license feature from Ansys[close](close.md)public [close](close.md)()  
closes ModelCenter.[closeHTMLViewer](close-h-t-m-l-viewer.md)public [closeHTMLViewer](close-h-t-m-l-viewer.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)  
closes the HTMLViewer embedded browser tool[closeModel](close-model.md)public [closeModel](close-model.md)()  
closes the model within ModelCenter[createAndInitComponent](create-and-init-component.md)public [createAndInitComponent](create-and-init-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), initString: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Component](./../-component/index.md)  
Creates a new component and initializes it from string data.[createAssembly](create-assembly.md)public [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](./../-assembly/index.md)  
public [createAssembly](create-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), assemblyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](./../-assembly/index.md)  
creates an assembly[createAssemblyVariable](create-assembly-variable.md)public [createAssemblyVariable](create-assembly-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), type: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](./../-variable/index.md)  
creates an assembly variable[createComponent](create-component.md)public [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
public [createComponent](create-component.md)(serverPath: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parentName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), xPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), yPos: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))  
Instantiates a new component into the Model[createDataCollector](create-data-collector.md)public [createDataCollector](create-data-collector.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataCollector](./../-data-collector/index.md)  
creates a Data Collector for storing and displaying data[createDataExplorer](create-data-explorer.md)public [createDataExplorer](create-data-explorer.md)(tradeStudyType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), setup: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DataExplorer](./../-data-explorer/index.md)  
creates a Data Explorer for storing and displaying data[createDataHistoryVariable](create-data-history-variable.md)public [createDataHistoryVariable](create-data-history-variable.md)(): [DHVariable](./../-d-h-variable/index.md)  
Creates a new DHVariable instance.[createDataMonitor](create-data-monitor.md)public [createDataMonitor](create-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), x: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), y: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [DataMonitor](./../-data-monitor/index.md)  
create a data monitor and associate it with a particular component[createJobManager](create-job-manager.md)public [createJobManager](create-job-manager.md)(): [JobManager](./../-job-manager/index.md)  
creates a JobManager object for performing trade study runs  
public [createJobManager](create-job-manager.md)(showProgressDialog: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [JobManager](./../-job-manager/index.md)  
public [createJobManager](create-job-manager.md)(progressDialogParent: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [JobManager](./../-job-manager/index.md)  
Creates a JobManager for performing trade study runs.[createLink](create-link.md)public [createLink](create-link.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), equation: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
Creates a new link[createPlugInFrame](create-plug-in-frame.md)public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)  
Create a frame window in which to embed the java plug-in  
public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)  
public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)  
public [createPlugInFrame](create-plug-in-frame.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), reserved: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), plugin: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), container: [Container](https://docs.oracle.com/javase/8/docs/api/java/awt/Container.html), showFavorites: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), defWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), defHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minWidth: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), minHeight: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)[createTradeStudy](create-trade-study.md)public [createTradeStudy](create-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [TradeStudy](./../-trade-study/index.md)  
Creates the specified trade study and returns a handle to it.[destroyPlugInFrame](destroy-plug-in-frame.md)public [destroyPlugInFrame](destroy-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))  
Destroys the frame window which the java plug-in is embedded in[disableGC](./../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)public [disableGC](./../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/disable-g-c.md)(gc: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))  
If true, prevents releaseObjects from doing anything.[dumpComDebug](dump-com-debug.md)public [dumpComDebug](dump-com-debug.md)()  
Dumps COM debugging information on the ModelCenter process side; only has an effect if ModelCenter is compiled in Debug mode.[getActiveJobManager](get-active-job-manager.md)public [getActiveJobManager](get-active-job-manager.md)(): [JobManager](./../-job-manager/index.md)  
Gets the Job Manager associated with the currently running trade study.[getAppName](get-app-name.md)public [getAppName](get-app-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)  
Gets the Application name[getAssembly](get-assembly.md)public [getAssembly](get-assembly.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Assembly](./../-assembly/index.md)  
Gets the specified assembly from the model.[getAssemblyStyle](get-assembly-style.md)public [getAssemblyStyle](get-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [ModelCenter.AssemblyStyleInfo](-assembly-style-info/index.md)  
Get the visual style of an assembly.[getComponent](get-component.md)public [getComponent](get-component.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Component](./../-component/index.md)  
Gets the specified component from the Model[getDataCollector](get-data-collector.md)public [getDataCollector](get-data-collector.md)(index: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [DataCollector](./../-data-collector/index.md)[getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md)public [getDataCollectorForDataExplorer](get-data-collector-for-data-explorer.md)(dataExplorer: [DataExplorer](./../-data-explorer/index.md)): [DataCollector](./../-data-collector/index.md)  
Retrieves a DataCollector for the DataExplorer with the specified ID.[getDataExplorer](get-data-explorer.md)public [getDataExplorer](get-data-explorer.md)(id: [Variant](./../-variant/index.md)): [DataExplorer](./../-data-explorer/index.md)  
gets a specific DataExplorer[getDataMonitor](get-data-monitor.md)public [getDataMonitor](get-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](./../-variant/index.md)): [DataMonitor](./../-data-monitor/index.md)  
gets a specific data monitor associated with a particular component[getFileSystemInfo](get-file-system-info.md)public [getFileSystemInfo](get-file-system-info.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [FileSystemInfo](./../-file-system-info/index.md)  
Gets the FileSystemInfo for a given URI.[getFormatter](get-formatter.md)public [getFormatter](get-formatter.md)(format: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Format](./../-format/index.md)  
Gets an instance of a formatter object[getFrame](get-frame.md)public [getFrame](get-frame.md)(): [JFrame](https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html)  
gets a Frame that should be used as the parent for all windows displayed by Java plug-ins.[getGlobalParameters](get-global-parameters.md)public [getGlobalParameters](get-global-parameters.md)(): [GlobalParameters](./../-global-parameters/index.md)  
Gets the list of global parameters[getHaltStatus](get-halt-status.md)public [getHaltStatus](get-halt-status.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)  
checks to see if the halt button has been pressed[getIsInteractive](get-is-interactive.md)public [getIsInteractive](get-is-interactive.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)  
Determine if the current ModelCenter is running interactively - that is, if it has a GUI and a main window.[getLastErrorMessage](get-last-error-message.md)public [getLastErrorMessage](get-last-error-message.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)  
retrieves the text associated with the last ModelCenter error[getLicensingPath](get-licensing-path.md)public [getLicensingPath](get-licensing-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)  
Gets the ModelCenter licensing path returns ModelCenter licensing path[getLinks](get-links.md)public [getLinks](get-links.md)(includeReferences: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [VariableLinks](./../-variable-links/index.md)  
Retreive a list of all links in a model[getLogger](get-logger.md)public [getLogger](get-logger.md)(): [Logger](./../../com.phoenix_int.ModelCenter.logging/-logger/index.md)  
Retrieves a logger.[getMacroScript](get-macro-script.md)public [getMacroScript](get-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)  
get the script for a macro if the macro exists[getMacroScriptLanguage](get-macro-script-language.md)public [getMacroScriptLanguage](get-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)  
get the script language for a macro if the macro exists[getMacroTimeout](get-macro-timeout.md)public [getMacroTimeout](get-macro-timeout.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)  
get the timeout for a macro if the macro exists[getModel](get-model.md)public [getModel](get-model.md)(): [Assembly](./../-assembly/index.md)  
Gets the Model object[getModelCenterPath](get-model-center-path.md)public [getModelCenterPath](get-model-center-path.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)  
Retrieves the install path for ModelCenter.[getModelDirectory](get-model-directory.md)public [getModelDirectory](get-model-directory.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)  
Gets the Model directory returns an exception when Model is not open returns an empty string when Model has not been saved[getModelFileName](get-model-file-name.md)public [getModelFileName](get-model-file-name.md)(): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)  
Gets the Model file name[getPreference](get-preference.md)public [getPreference](get-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](./../-variant/index.md)  
gets a preference[getProcessID](get-process-i-d.md)public [getProcessID](get-process-i-d.md)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)  
Retrieves the process identifier (PID) of the ModelCenter process.[getRunOnlyMode](get-run-only-mode.md)public [getRunOnlyMode](get-run-only-mode.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)  
Gets the status of ModelCenter being in Run-Only Mode.[getScreenUpdating](get-screen-updating.md)public [getScreenUpdating](get-screen-updating.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)  
returns the current screen updating flag[getTradeStudyFilters](get-trade-study-filters.md)public [getTradeStudyFilters](get-trade-study-filters.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)&lt;[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)&gt;  
Get the filters for saving Trade Study files (for use in showFileBrowseDialog and showFileSaveDialog)[getValue](get-value.md)public [getValue](get-value.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](./../-variant/index.md)  
gets a value for the specified variable[getValueAbsolute](get-value-absolute.md)public [getValueAbsolute](get-value-absolute.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](./../-variant/index.md)  
gets a value for the specified variable without validating it[getVariable](get-variable.md)public [getVariable](get-variable.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variable](./../-variable/index.md)  
Gets the specified variable from the Model[getVariableMetaData](get-variable-meta-data.md)public [getVariableMetaData](get-variable-meta-data.md)(name: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [DHVariable](./../-d-h-variable/index.md)  
Get metadata about the specified variable from the Model.[getVersion](get-version.md)public [getVersion](get-version.md)(index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)  
Gets the ModelCenter version[getXMLExtension](get-x-m-l-extension.md)public [getXMLExtension](get-x-m-l-extension.md)(nodeName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), attributeName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), attributeValue: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)  
For internal use only.[guiCloseAllMultiplexers](gui-close-all-multiplexers.md)public [guiCloseAllMultiplexers](gui-close-all-multiplexers.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)  
Attempts to close the DataExplorers of all vizualization multiplexers.[guiLoadFile](gui-load-file.md)public [guiLoadFile](gui-load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)  
Loads a file in "GUI" mode, that is, unlike loadFile(...), will produce a prompt to the user to verify whether or not any currently opened model should be saved prior to loading the given file.[guiSaveModel](gui-save-model.md)public [guiSaveModel](gui-save-model.md)()  
Saves a file in "GUI" mode, which will pop up a dialog if the file has not yet been saved.[halt](halt.md)public [halt](halt.md)()  
Halts any running trade studies[hidePlugInFrame](hide-plug-in-frame.md)public [hidePlugInFrame](hide-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))  
Hides the frame window which the java plugin is embedded in[HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md)public [HTMLViewerWaitForClose](-h-t-m-l-viewer-wait-for-close.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))  
waits for the HTMLViewer embedded browser tool to close[internalLicensing](internal-licensing.md)public [internalLicensing](internal-licensing.md)(one: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), two: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))  
For internal use only[invokeHelp](invoke-help.md)public [invokeHelp](invoke-help.md)(helpID: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))  
Display a topic in ModelCenter's help system[isOkToClose](is-ok-to-close.md)public [isOkToClose](is-ok-to-close.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)  
Determine whether it's ok to shutdown ModelCenter or whether there are still windows open[launchDataCollectorPlugIn](launch-data-collector-plug-in.md)public [launchDataCollectorPlugIn](launch-data-collector-plug-in.md)(plugInName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), dataExplorer: [DataExplorer](./../-data-explorer/index.md))  
Launches a specific Data Collector PlugIn, by name, on the specified Data Explorer.[launchHTMLViewer](launch-h-t-m-l-viewer.md)public [launchHTMLViewer](launch-h-t-m-l-viewer.md)(url: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), popup: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)  
starts the HTMLViewer embedded browser tool[launchMacroEditor](launch-macro-editor.md)public [launchMacroEditor](launch-macro-editor.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
launches the macro editor, displays the macro scrip if it exists[launchTradeStudy](launch-trade-study.md)public [launchTradeStudy](launch-trade-study.md)(idStr: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
Launches the specified trade study.[loadFile](load-file.md)public [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
public [loadFile](load-file.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))  
opens the specified Model[loadModel](load-model.md)public [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
public [loadModel](load-model.md)(modelFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), connectErrorMode: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))  
opens the specified Model[MessageBox](-message-box.md)public [MessageBox](-message-box.md)(msg: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
displays a Windows Message Box[moveComponent](move-component.md)public [moveComponent](move-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), parent: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))  
Moves a component.[newInstance](new-instance.md)public [newInstance](new-instance.md)(): [ModelCenter](index.md)  
creates a new ModelCenter object (that is connected to the same ModelCenter session) that is not currently attached to any thread.[newModel](new-model.md)public [newModel](new-model.md)()  
loads ModelCenter with a new, empty Model (data dependency model - MODEL\_TYPE\_DATA)  
public [newModel](new-model.md)(modelType: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
loads ModelCenter with a new, empty Model[parallelInstance](parallel-instance.md)public [parallelInstance](parallel-instance.md)(): [ModelCenter](index.md)  
For internal use only[release](./../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)public [release](./../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release.md)()  
Releases the COM reference to ModelCenter for this object.[releaseObjects](./../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)public [releaseObjects](./../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/release-objects.md)()  
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them.[removeComponent](remove-component.md)public [removeComponent](remove-component.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
Removes a specified component[removeDataMonitor](remove-data-monitor.md)public [removeDataMonitor](remove-data-monitor.md)(component: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), index: [Variant](./../-variant/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)  
remove a specific data monitor associated with a particular component[run](run.md)public [run](run.md)(variableArray: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
A comma-separated list of ModelCenter variables to validate.[runAntFile](run-ant-file.md)public [runAntFile](run-ant-file.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
runs an ANT testing file[runMacro](run-macro.md)public [runMacro](run-macro.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](./../-variant/index.md)  
runs a macro[runMacro2](run-macro2.md)public [runMacro2](run-macro2.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [Variant](./../-variant/index.md)  
runs a macro and passes the current modelCenter object to the script (i.e.[saveModel](save-model.md)public [saveModel](save-model.md)()  
saves the current Model with it's existing file name[saveModelAs](save-model-as.md)public [saveModelAs](save-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
saves the current Model with the specified file name[saveTradeStudy](save-trade-study.md)public [saveTradeStudy](save-trade-study.md)(uri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), fileType: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), dataExplorer: [DataExplorer](./../-data-explorer/index.md))  
Save the trade study inside of the Data Explorer[saveVersionedModel](save-versioned-model.md)public [saveVersionedModel](save-versioned-model.md)(versionStatus: [ModelCenter.VersionStatus](-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
saves the current Model with it's existing file name[saveVersionedModelAs](save-versioned-model-as.md)public [saveVersionedModelAs](save-versioned-model-as.md)(fileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), versionStatus: [ModelCenter.VersionStatus](-version-status/index.md), checkinMessage: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
saves the current Model with the specified file name[setAssemblyStyle](set-assembly-style.md)public [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](-assembly-style/index.md))  
Set the visual style of an assembly.  
public [setAssemblyStyle](set-assembly-style.md)(assemblyName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), style: [ModelCenter.AssemblyStyle](-assembly-style/index.md), width: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), height: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))  
 Set the visual style of an assembly including (optionally) width and height.[setIconPlugInFrame](set-icon-plug-in-frame.md)public [setIconPlugInFrame](set-icon-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), iconFile: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
Sets the icon for the frame window which the java plugin is embedded in[setLoginCallback](set-login-callback.md)public [setLoginCallback](set-login-callback.md)(callback: [ILoginCallback](./../-i-login-callback/index.md))  
Set the login callback to use[setMacroScript](set-macro-script.md)public [setMacroScript](set-macro-script.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), script: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
set the script for a macro if the macro exists[setMacroScriptLanguage](set-macro-script-language.md)public [setMacroScriptLanguage](set-macro-script-language.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), language: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
set the script lancuage for a macro if the macro exists[setMacroTimeout](set-macro-timeout.md)public [setMacroTimeout](set-macro-timeout.md)(macroName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), timeout: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html))  
sets the timeout for a macro if the macro exists[setPassword](set-password.md)public [setPassword](set-password.md)(password: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
Sets the global default password combination in ModelCenter[setPreference](set-preference.md)public [setPreference](set-preference.md)(prefName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
Sets a preference[setReferenceDebugMode](./../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)public [setReferenceDebugMode](./../../com.phoenix_int.ModelCenter.util/-p-h-x-c-o-m-object/set-reference-debug-mode.md)(on: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))  
When set to true, the system will keep a list of active COM objects that are allocated but not yet released since this method was invoked.[setRunOnlyMode](set-run-only-mode.md)public [setRunOnlyMode](set-run-only-mode.md)(shouldBeInRunOnly: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))  
Sets the status of ModelCenter being in Run-Only Mode to the specified value.[setScheduler](set-scheduler.md)public [setScheduler](set-scheduler.md)(scheduler: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
Sets the appropriate schdeuler.[setScreenUpdating](set-screen-updating.md)public [setScreenUpdating](set-screen-updating.md)(flag: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))  
sets a flag indicating if the ModelCenter window should update due to Model changes.[setUserName](set-user-name.md)public [setUserName](set-user-name.md)(username: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
Sets the global default username combination in ModelCenter[setValue](set-value.md)public [setValue](set-value.md)(varName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), value: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
sets the value for the specified variable[setXMLExtension](set-x-m-l-extension.md)public [setXMLExtension](set-x-m-l-extension.md)(xml: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html))  
For internal use only.[showFileBrowseDialog](show-file-browse-dialog.md)public [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)&lt;[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)&gt;, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)  
public [showFileBrowseDialog](show-file-browse-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)&lt;[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)&gt;, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)  
Displays file selection dialog for loading and returns URL of selected file.[showFileSaveDialog](show-file-save-dialog.md)public [showFileSaveDialog](show-file-save-dialog.md)(title: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), selectedFilter: [ValueHolder](./../../com.phoenix_int.ModelCenter.util/-value-holder/index.md)&lt;[Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html)&gt;, initialFileName: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), filters: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)&lt;[String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)&gt;, initialUri: [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html), hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)  
Displays file selection dialog for saving and returns URL of selected file.[showPlugInFrame](show-plug-in-frame.md)public [showPlugInFrame](show-plug-in-frame.md)(hwnd: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html))  
Shows the frame window which the java plugin is embedded in[startGUIMode](start-g-u-i-mode.md)public [startGUIMode](start-g-u-i-mode.md)(showDialogs: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))  
THIS FUNCTION IS A BETA CAPABILITY Normally when invoked via COM, ModelCenter is in "server" mode and it hides all GUI and dialogs.[tradeStudyEnd](trade-study-end.md)public [tradeStudyEnd](trade-study-end.md)()  
lets ModelCenter know that a trade study is ending[tradeStudyStart](trade-study-start.md)public [tradeStudyStart](trade-study-start.md)()  
lets ModelCenter know that a trade study is beginning