Skip to main content

ModelCenter APIs 2025 R2

GlobalParameters

Last update: 16.07.2025

public class GlobalParameters : PHXCOMObject

Global Parameters is a hashtable of values that can be set via the ModelCenter API and used for any purpose the client desires. As a rule of practice to avoid conflicts, parameters should be named with a namespace prefix and a colon, such as "phx:CenterLinkServer". Global Parameters have a boolean flag which indicates whether the value should be passed along to external components, such as Analysis Server tools. Global parameters are saved at the ModelCenter level and as such are not stored across ModelCenter being closed/reopened, but are kept across file close/new file open in a single session.

Author

Sharp

Functions

Name Summary
disableGC public disableGC(gc: Boolean)
If true, prevents releaseObjects from doing anything.
getCount public getCount(): Int
Returns the number of global parameters set
getValue public getValue(index: Int): Any
public getValue(index: String): Any
Gets the value of a global parameter
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.
remove public remove(index: Int)
public remove(index: String)
Removes a global parameter
setExportToRemoteComponents public setExportToRemoteComponents(index: Int, export: Boolean)
public setExportToRemoteComponents(index: String, export: Boolean)
Sets the flag that determines if a global parameter should be exported to all remote components.
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.
setValue public setValue(index: Int, value: Any)
public setValue(index: String, value: Any)
Sets the value of a global parameter.

Connect with Ansys