Skip to main content

ModelCenter APIs 2025 R1

Namespace ModelCenter

Last update: 16.07.2025

Definition: ModelCenter/src/ModelCenter.odl (line 18)

ModelCenter API

Classes

Enumeration types

Enumeration type MetadataType

Definition: ModelCenter/src/ModelCenter.odl (line 31)

enum MetadataType {
  METADATA_TYPE_STRING = 0,
  METADATA_TYPE_DOUBLE = 1,
  METADATA_TYPE_LONG = 2,
  METADATA_TYPE_BOOLEAN = 3,
  METADATA_TYPE_XML = 4,
  METADATA_TYPE_FORCE_TO_32_BITS = 65536
}

Type of metadata.

Enumerator METADATA_TYPE_STRING

Enumerator METADATA_TYPE_DOUBLE

Enumerator METADATA_TYPE_LONG

Enumerator METADATA_TYPE_BOOLEAN

Enumerator METADATA_TYPE_XML

Enumerator METADATA_TYPE_FORCE_TO_32_BITS

Enumeration type MetadataAccess

Definition: ModelCenter/src/ModelCenter.odl (line 44)

enum MetadataAccess {
  METADATA_ACCESS_PRIVATE = 0,
  METADATA_ACCESS_READONLY = 1,
  METADATA_ACCESS_PUBLIC = 2,
  METADATA_ACCESS_FORCE_TO_32_BITS = 65536
}

Access allowed for metadata.

Enumerator METADATA_ACCESS_PRIVATE

Enumerator METADATA_ACCESS_READONLY

Enumerator METADATA_ACCESS_PUBLIC

Enumerator METADATA_ACCESS_FORCE_TO_32_BITS

Enumeration type TradeStudyFormat

Definition: ModelCenter/src/ModelCenter.odl (line 55)

enum TradeStudyFormat {
  TS_FORMAT_PXTZ = 0,
  TS_FORMAT_PXT_COMPRESSED = 1,
  TS_FORMAT_PXT_UNCOMPRESSED = 2,
  TS_FORMAT_TSTUDY = 3
}

An enumeration of the different trade study file formats

Enumerator TS_FORMAT_PXTZ

Used to signify that the format PXTZ was selected and that a file should be saved in that format Deprecated:

This file format is deprecated and files can no longer be saved in this format.

Enumerator TS_FORMAT_PXT_COMPRESSED

Used to signify that the format PXT (Compressed) was selected and that a file should be saved in that format Deprecated:

This file format is deprecated and files can no longer be saved in this format.

Enumerator TS_FORMAT_PXT_UNCOMPRESSED

Used to signify that the format PXT (Uncompressed) was selected and that a file should be saved in that format Deprecated:

This file format is deprecated and files can no longer be saved in this format.

Enumerator TS_FORMAT_TSTUDY

Used to signify that the format TSTUDY was selected and that a file should be saved in that format

Enumeration type VersionStatus

Definition: ModelCenter/src/ModelCenter.odl (line 657)

enum VersionStatus {
  DO_VERSIONING = 0,
  DO_NOT_VERSION = 1,
  DO_VERSIONING_IF_POSSIBLE = 2
}

Versioning option for saving to ModelCenter cloud data storage.

Enumerator DO_VERSIONING

Enumerator DO_NOT_VERSION

Enumerator DO_VERSIONING_IF_POSSIBLE

Enumeration type AssemblyStyle

Definition: ModelCenter/src/ModelCenter.odl (line 3809)

enum AssemblyStyle {
  ASSEMBLY_STYLE_COLLAPSED = 0,
  ASSEMBLY_STYLE_EXPANDED = 1,
  ASSEMBLY_STYLE_CLASSIC = 100,
  ASSEMBLY_STYLE_N_SQUARED = 101,
  ASSEMBLY_STYLE_AUTO_N_SQUARED = 102,
  ASSEMBLY_STYLE_FORCE_32_BITS = 65536
}

Ways to display an assembly.

Enumerator ASSEMBLY_STYLE_COLLAPSED

Collapse the assembly. Not allowed for the model.

Enumerator ASSEMBLY_STYLE_EXPANDED

Expand the assembly. No effect for the model.

Enumerator ASSEMBLY_STYLE_CLASSIC

Set to classic view. Only valid for Data Dependency assemblies.

Enumerator ASSEMBLY_STYLE_N_SQUARED

Set to N^2 view. Only valid for Data Dependency assemblies.

Enumerator ASSEMBLY_STYLE_AUTO_N_SQUARED

Set to auto-N^2 view. Only valid for Data Dependency assemblies.

Enumerator ASSEMBLY_STYLE_FORCE_32_BITS

Enumeration type OnConnectionErrorMode

Definition: ModelCenter/src/ModelCenter.odl (line 5038)

enum OnConnectionErrorMode {
  CONN_ERR_ERROR = 3,
  CONN_ERR_IGNORE = 1,
  CONN_ERR_USEDIALOG = -1
}

Mode of action to take when there is an error with connection. Used with loadModel .

Enumerator CONN_ERR_ERROR

Abort loading and throw the error back to the caller.

Enumerator CONN_ERR_IGNORE

Ignore the error and continue loading (as if user has pressed "Ignore" in the dialog).

Enumerator CONN_ERR_USEDIALOG

(option not available when running ModelCenter in server mode) Shows the error as if the user were loading the file manually with full control.

Functions

Function importlib

ModelCenter::importlib("stdole32.tlb")

Parameters:

  • "stdole32.tlb"

Return type:

Connect with Ansys