Skip to main content

ModelCenter APIs 2025 R2

AddToModel

Last update: 16.07.2025

public class AddToModel : PHXCOMObject

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

Author

Woyak, 10-01

Constructors

AddToModel constructor(pstrm: Long)constructor(pstrm: Long, addRef: Boolean)

Functions

Name Summary
addInput public addInput(name: String, type: String, value: String): Variable
adds a pending input to the component.
addInput2 public addInput2(name: String, type: String, classURL: String, value: String): Variable
adds a pending input to the component.
addMethod public addMethod(name: String, displayName: String)
Adds the method
addOutput public addOutput(name: String, type: String, value: String): Variable
adds a pending output to the component Valid types of variables are listed below.
addOutput2 public addOutput2(name: String, type: String, classURL: String, value: String): Variable
adds a pending output to the component Valid types of variables are listed below.
addToModel public addToModel()
adds a new component to the Model
addToModel2 public addToModel2(): Boolean
adds a new component to the Model
addToModel3 public addToModel3(name: String): String
clearBusyFlag public clearBusyFlag()
clears the busy state if an Exception is encountered in addInput() or addOutput()
disableGC public disableGC(gc: Boolean)
If true, prevents releaseObjects from doing anything.
getAutoRun public getAutoRun(): Boolean
returns the current autorun flag
getComponent public getComponent(): Component
gets the component object associated with this object
getPrevalidateInputs public getPrevalidateInputs(): Boolean
returns the current prevalidate inputs flag
getProgID public getProgID(): String
gets the "ProgID" registry entry associated with this Plug-In
getRegID public getRegID(): String
gets the registry id associated with this Plug-In
newInstance public newInstance(): AddToModel
creates a new AddToModel object (that is connected to the same ModelCenter session) that is not currently attached to any thread.
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.
setAuthor public setAuthor(str: String)
sets the Plug-In author
setAutoRun public setAutoRun(flag: Boolean)
sets the current autorun flag
setComponentRequirements public setComponentRequirements(str: String)
sets the Plug-In requirements
setDescription public setDescription(str: String)
sets the Plug-In description
setHelpURL public setHelpURL(str: String)
sets the Plug-In help URL
setIcon public setIcon(str: String)
sets the Plug-In icon
setKeywords public setKeywords(str: String)
sets the Plug-In keywords
setPrevalidateInputs public setPrevalidateInputs(flag: Boolean)
sets the current prevalidate inputs flag
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.
setVersion public setVersion(str: String)
sets the Plug-In version
updateComponent public updateComponent()
Reinitializes the inputs and outputs of a Component Plug-In.

Connect with Ansys