Skip to main content

ModelCenter APIs 2025 R1

Assembly

Last update: 16.07.2025

public class Assembly : PHXCOMObject, IVariableHolder

This is the wrapper class that handles the native COM calls to a Component object. The class is used by Java plug-ins to ModelCenter.

Author

Woyak, 9-01

Properties

Name Summary
ASSEMBLY val ASSEMBLY: String = "Assembly"
Generic (data-driven) assembly type.
FOR_EACH val FOR_EACH: String = "ForEach"
For-each assembly type.
IF val IF: String = "If"
IF-block assembly type.
LOOP val LOOP: String = "Loop"
Loop assembly type.
PARALLEL val PARALLEL: String = "Parallel"
Parallel assembly type.
SEQUENCE val SEQUENCE: String = "Sequence"
Generic (process-driven) assembly type.

Functions

Name Summary
addAssembly public addAssembly(name: String): Assembly
adds a sub-assembly
public addAssembly(name: String, assemblyType: String): Assembly
adds a sub-assembly of the specified type
addAssembly2 public addAssembly2(name: String, xPos: Int, yPos: Int): Assembly
adds a sub-assembly
public addAssembly2(name: String, xPos: Int, yPos: Int, assemblyType: String): Assembly
adds a sub-assembly of the specified type
addVariable public addVariable(name: String, type: String): Variable
adds a variable to the assembly
convertToSubmodel public convertToSubmodel(fileName: String, versionStatus: ModelCenter.VersionStatus, checkinMessage: String)
For internal use only
deleteVariable public deleteVariable(name: String)
deletes a variable from the assembly
disableGC public disableGC(gc: Boolean)
If true, prevents releaseObjects from doing anything.
getAssembly public getAssembly(index: Int): Assembly
public getAssembly(name: String): Assembly
gets the specified assembly
getAssemblyType public getAssemblyType(): String
Gets the type of assembly.
getComponent public getComponent(index: Int): Component
public getComponent(name: String): Component
gets the specified component
getFullName public getFullName(): String
gets the full name of the current object, e.g.
getGroup public getGroup(index: Int): Group
public getGroup(name: String): Group
gets the specified group
getIconID public getIconID(): Int
Gets the icon ID for the icon displayed for this Assembly.
getIndexInParent public getIndexInParent(): Int
Gets the index of the assembly in its parent assembly.
getMetadata public getMetadata(name: String): Variant
Get a metadata value.
getName public getName(): String
gets the name of the current object, e.g.
getNumAssemblies public getNumAssemblies(): Int
get the number of assemblies stored in this object
getNumComponents public getNumComponents(): Int
get the number of components stored in this object
getNumGroups public getNumGroups(): Int
get the number of groups stored in this object
getNumVariables public getNumVariables(): Int
get the number of variables stored in this object
getParentAssembly public getParentAssembly(): Assembly
gets the parent assembly of this component (fails if this is the model/root assembly)
getPositionX public getPositionX(): Int
gets the X co-ordinate value of the current object,
getPositionY public getPositionY(): Int
gets the Y co-ordinate value of the current object,
getUserData public getUserData(): Any
Get user data of the component.
getVariable public getVariable(index: Int): Variable
public getVariable(name: String): Variable
gets the specified variable
release public release()
Releases the COM reference to ModelCenter for this object.
releaseObjects public releaseObjects()
This function attempts to release any COM resources left behind from objects which have been finalized but release() was never called on them.
rename public rename(name: String)
Rename the assembly
setIconID public setIconID(iconID: Int)
Specifies the icon for use with this Assembly.
setMetadata public setMetadata(name: String, type: Variable.MetadataType, value: Any, access: Variable.MetadataAccess, archive: Boolean)
Set a metadata value on an assembly.
setReferenceDebugMode public setReferenceDebugMode(on: Boolean)
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.
setUserData public setUserData(val: Any)
Set user data of the Component

Connect with Ansys