ModelCenter APIs 2025 R2

Interface ModelCenter::IVariable

Last update: 16.07.2025

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

COM instance.

Inherited by:

Members

Properties

Property hasChanged

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

boolean ModelCenter::IVariable::hasChanged

Boolean which indicates if the variable has changed since the last time the boolean was reset. Typically used only by Plug-Ins for their own variables (to avoid conflicting use by different Plug-Ins , macros, or tools). Set the value to false and it will automatically flip to true any time the value changes.

Return type: boolean

Property hide

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

boolean ModelCenter::IVariable::hide

Hides the variable from the User Interface. Variable will not be visible in Component Tree, Data Explorer, or Data Monitors.

Return type: boolean

Property OwningComponent

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

LPDISPATCH ModelCenter::IVariable::OwningComponent

Gets the component that owns this variable.

Returns:

IDispatch* to an IComponent object.

Return type: LPDISPATCH

Public functions

Function isValid

boolean ModelCenter::IVariable::isValid()

Returns whether or not the variable is valid.

Returns:

True if variable is valid. False if the variable is not valid.

Return type: boolean

Reimplemented by:

Function validate

void ModelCenter::IVariable::validate()

Validates the variable by running the component if needed.

Return type: void

Reimplemented by:

Function getName

BSTR ModelCenter::IVariable::getName()

Gets the name of the variable.

Returns:

The name of the variable.

Return type: BSTR

Reimplemented by:

Function getFullName

BSTR ModelCenter::IVariable::getFullName()

Gets the full ModelCenter path of the variable.

Returns:

The full ModelCenter path of the variable.

Return type: BSTR

Reimplemented by:

Function getType

BSTR ModelCenter::IVariable::getType()

Gets the type of the variable.

Returns:

The type of the variable as a string.

Return type: BSTR

Reimplemented by:

Function isInput

boolean ModelCenter::IVariable::isInput()

Finds out whether or not the variable is an input with respect to the model. Returns the same value as isInputToModel.

Return values:

  • true: Input
  • false: Output

Return type: boolean

Reimplemented by:

Function toString

BSTR ModelCenter::IVariable::toString()

Converts the variable value to a string, validating the variable if necessary.

Returns:

The value of the variable as a string.

Return type: BSTR

Reimplemented by:

Function fromString

void ModelCenter::IVariable::fromString(BSTR value)

Sets the value of the variable from the specified string.

Parameters:

  • value: New value.

Parameters:

  • BSTR value

Return type: void

Reimplemented by:

Function toStringAbsolute

BSTR ModelCenter::IVariable::toStringAbsolute()

Converts the value of the variable to a string.

Returns:

The value of the variable as a string.

Return type: BSTR

Reimplemented by:

Function invalidate

void ModelCenter::IVariable::invalidate()

Marks the variable as invalid (needs to be computed). This will set all dependent variables invalid also.

Return type: void

Reimplemented by:

Function directPrecedents

LPDISPATCH ModelCenter::IVariable::directPrecedents([optional]VARIANT followSuspended, [optional]VARIANT reserved)

Returns a list of variables that are immediate precedents to the value of this variable. This function returns all variables that influence this variable and are directly connected via a link to it.

Parameters:

  • followSuspended: Optional boolean specifies whether links which are suspended should be included in the search. Default is false.
  • reserved: Reserved for future use.

Returns:

IDispatch* to an IVariables object.

Parameters:

  • [optional] VARIANT followSuspended
  • [optional] VARIANT reserved

Return type: LPDISPATCH

Reimplemented by:

Function directDependents

LPDISPATCH ModelCenter::IVariable::directDependents([optional]VARIANT followSuspended, [optional]VARIANT reserved)

Returns a list of variables that are immediate dependents of the value of this variable. This function returns all variables that are influenced by this variable and are directly connected via a link to it.

Parameters:

  • followSuspended: Optional boolean specifies whether links which are suspended should be included in the search. Default is false.
  • reserved: Reserved for future use.

Returns:

IDispatch* to an IVariables object.

Parameters:

  • [optional] VARIANT followSuspended
  • [optional] VARIANT reserved

Return type: LPDISPATCH

Reimplemented by:

LPDISPATCH ModelCenter::IVariable::precedentLinks([optional]VARIANT reserved)

Returns a list of links that are immediate precedents to the value of this variable. All the returned links will have this variable as the LHS of the equation. Except for arrays, the returned list will be 1 element long.

Parameters:

  • reserved: Reserved for future use.

Returns:

IDispatch* to an IVariableLinks object.

Parameters:

  • [optional] VARIANT reserved

Return type: LPDISPATCH

Reimplemented by:

LPDISPATCH ModelCenter::IVariable::dependentLinks([optional]VARIANT reserved)

Returns a list of links that immediately depend on the value of this variable. All the returned links will have this variable as part of a RHS equation.

Parameters:

  • reserved: Reserved for future use.

Returns:

IDispatch* to an IVariableLinks object.

Parameters:

  • [optional] VARIANT reserved

Return type: LPDISPATCH

Reimplemented by:

Function precedents

LPDISPATCH ModelCenter::IVariable::precedents([optional]VARIANT followSuspended, [optional]VARIANT reserved)

Returns a list of variables that are precedents to the value of this variable. This function returns all variables that influence this variable, not just directly connected ones.

Parameters:

  • followSuspended: Optional boolean specifies whether links which are suspended should be included in the search. Default is false.
  • reserved: Reserved for future use.

Returns:

IDispatch* to an IVariables object.

Parameters:

  • [optional] VARIANT followSuspended
  • [optional] VARIANT reserved

Return type: LPDISPATCH

Reimplemented by:

Function dependents

LPDISPATCH ModelCenter::IVariable::dependents([optional]VARIANT followSuspended, [optional]VARIANT reserved)

Returns a list of variables that are dependent upon the value of this variable. This function returns all variables that are influenced by this variable, not just directly connected ones.

Parameters:

  • followSuspended: Optional boolean specifies whether links which are suspended should be included in the search. Default is false.
  • reserved: Reserved for future use.

Returns:

IDispatch* to an IVariables object.

Parameters:

  • [optional] VARIANT followSuspended
  • [optional] VARIANT reserved

Return type: LPDISPATCH

Reimplemented by:

Function isInputToComponent

boolean ModelCenter::IVariable::isInputToComponent()

Checks whether or not the variable is an input. Returns true if the variable was originally added as an input, ignoring the current state that can change based off of links.

Return values:

  • true: Input
  • false: Output

Return type: boolean

Reimplemented by:

Function isInputToModel

boolean ModelCenter::IVariable::isInputToModel()

Checks whether or not the variable is an input. A linked input returns false (Output).

Return values:

  • true: Input
  • false: Output

Return type: boolean

Reimplemented by:

Function setMetadata

void ModelCenter::IVariable::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

Reimplemented by:

Function getMetadata

VARIANT ModelCenter::IVariable::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

Reimplemented by:

Connect with Ansys