ModelCenter APIs 2025 R2

Interface ModelCenter::IAssembly

Last update: 16.07.2025

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

COM Instance.

Members

Properties

Property Variables

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

VARIANT ModelCenter::IAssembly::Variables

Pointer to the variables in the Assembly.

Returns:

IDispatch* to an IVariables object.

Return type: VARIANT

Property Groups

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

VARIANT ModelCenter::IAssembly::Groups

Pointer to the Groups in the Assembly.

Returns:

IDispatch* to an IGroups object.

Return type: VARIANT

Property Assemblies

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

VARIANT ModelCenter::IAssembly::Assemblies

Pointer to the Assemblies in the Assembly.

Returns:

IDispatch* to an IAssemblies object.

Return type: VARIANT

Property Components

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

VARIANT ModelCenter::IAssembly::Components

Pointer to the Components in the Assembly.

Returns:

IDispatch* to an IComponents object.

Return type: VARIANT

Property iconID

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

int ModelCenter::IAssembly::iconID

The ID number of the icon to use for the Assembly.

Return type: int

Property IndexInParent

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

int ModelCenter::IAssembly::IndexInParent

Gets the position of the Assembly within the parent.

Return type: int

Property ParentAssembly

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

LPDISPATCH ModelCenter::IAssembly::ParentAssembly

Gets the parent of assembly of this assembly.

Returns:

IDisplatch* to an IAssembly object.

Return type: LPDISPATCH

Property AssemblyType

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

BSTR ModelCenter::IAssembly::AssemblyType

Gets the type of the Assembly (Sequence, Assembly, etc).

Return type: BSTR

Property userData

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

VARIANT ModelCenter::IAssembly::userData

An arbitrary Variant which is not used internally by ModelCenter but can store data for programmatic purposes. Value is not stored across file save/load.

Return type: VARIANT

Public functions

Function getName

BSTR ModelCenter::IAssembly::getName()

Name of the Assembly.

Returns:

The name of the Assembly.

Return type: BSTR

Function getFullName

BSTR ModelCenter::IAssembly::getFullName()

Full ModelCenter path of the Assembly.

Returns:

The full ModelCenter path of the Assembly.

Return type: BSTR

Function addAssembly

IDispatch * ModelCenter::IAssembly::addAssembly(BSTR name, [optional]VARIANT assemblyType)

This method creates a sub-Assembly in the current Assembly object.

Parameters:

  • name: The name of the sub-Assembly to create.
  • assemblyType:

Returns:

IDispatch* to an IAssembly object.

Parameters:

  • BSTR name
  • [optional] VARIANT assemblyType

Return type: IDispatch *

Function addVariable

IDispatch * ModelCenter::IAssembly::addVariable(BSTR name, BSTR type)

Creates a variable for the current Assembly.

Parameters:

  • name: Name of the new variable to create.

  • type: Type of the new variable. Possible types are:

  • double

  • int

  • boolean

  • string

  • file

  • double[]

  • int[]

  • boolean[]

  • string[]

  • quadfacet

  • surfaceofrevolution

  • nurbs

  • bspline

  • ruled

  • skinned

  • vrml

  • node

Returns:

IDispatch* to an IVariable object.

Parameters:

  • BSTR name
  • BSTR type

Return type: IDispatch *

Function rename

void ModelCenter::IAssembly::rename(BSTR name)

Renames the current Assembly.

Parameters:

  • name: New name of the Assembly.

Parameters:

  • BSTR name

Return type: void

Function deleteVariable

void ModelCenter::IAssembly::deleteVariable(BSTR name)

Deletes a variable from the current Assembly.

Parameters:

  • name: Name of the variable to delete.

Parameters:

  • BSTR name

Return type: void

Function addAssembly2

LPDISPATCH ModelCenter::IAssembly::addAssembly2(BSTR name, VARIANT xPos, VARIANT yPos, [optional]VARIANT assemblyType)

This method creates a sub-Assembly in the current Assembly with a specific type and position.

Parameters:

  • name:
  • xPos:
  • yPos:
  • assemblyType:

Returns:

IDispatch* to an IAssembly object.

Parameters:

  • BSTR name
  • VARIANT xPos
  • VARIANT yPos
  • [optional] VARIANT assemblyType

Return type: LPDISPATCH

Function setMetadata

void ModelCenter::IAssembly::setMetadata(BSTR name, MetadataType type, VARIANT value, MetadataAccess access, boolean archive)

Sets the meta data value of the given meta data key name.

Parameters:

  • name: Metadata specifier used to store the data.
  • type:
  • value:
  • access:
  • archive:

Parameters:

Return type: void

Function getMetadata

VARIANT ModelCenter::IAssembly::getMetadata(BSTR name)

Gets the meta data value of the given meta data key name.

Parameters:

  • name: Metadata key name.

Returns:

Metadata value.

Parameters:

  • BSTR name

Return type: VARIANT

Private functions

Function getPositionX

int ModelCenter::IAssembly::getPositionX()

Return type: int

Function getPositionY

int ModelCenter::IAssembly::getPositionY()

Return type: int

Function convertToSubmodel

void ModelCenter::IAssembly::convertToSubmodel(BSTR fileName, VersionStatus versionStatus, BSTR checkinMessage)

Parameters:

Return type: void

Connect with Ansys