Skip to main content

ModelCenter APIs 2025 R2

BooleanArray

Last update: 16.07.2025

public class BooleanArray : Array

A variable type class for ModelCenter

Author

Woyak, 10/2001

Functions

Name Summary
dependentLinks public dependentLinks(): VariableLinks
Returns a list of links that immediately depend on the value of this variable.
disableGC public disableGC(gc: Boolean)
If true, prevents releaseObjects from doing anything.
fromString public fromString(value: String, index: Long)
sets the value for the variable from a string
public fromString(str: String)
Sets the value for the variable from a string.
getAutoSize public getAutoSize(): Boolean
gets the autoSize flag.
getDescription public getDescription(): String
gets the description for the variable
getDimensions public getDimensions(): Variant
gets the dimensions of an array
getDirectDependents public getDirectDependents(): Variables
public getDirectDependents(followSuspended: Boolean): Variables
Gets all the immediately linked outputs of this variable.
getDirectPrecedents public getDirectPrecedents(): Variables
public getDirectPrecedents(followSuspended: Boolean): Variables
Gets all the immediately linked inputs of this variable.
getFullName public getFullName(): String
Gets the full name of the variable, e.g.
getHasChanged public getHasChanged(): Boolean
Boolean which indicates if the variable has changed since the last time the boolean was reset.
getHide public getHide(): Boolean
Gets whether the variable is hidden or not
getLength public getLength(): Long
gets the size of the array.
public getLength(dimension: Long): Long
gets the size of a specific dimension in the array.
getMetadata public getMetadata(name: String): Variant
Get a metadata value.
getName public getName(): String
Gets the name of the variable, e.g.
getNumDimensions public getNumDimensions(): Long
gets the number of dimensions
getOwningComponent public getOwningComponent(): Component
Get the component which owns this variable.
getSize public getSize(): Long
gets the size of the array.
public getSize(dimension: Long): Long
gets the size of a specific dimension in the array.
getType public getType(): String
Gets the type of the variable.
getValue public getValue(index: String): Boolean
public getValue(d1: Long): Boolean
public getValue(d1: Long, d2: Long): Boolean
public getValue(d1: Long, d2: Long, d3: Long): Boolean
public getValue(d1: Long, d2: Long, d3: Long, d4: Long): Boolean
public getValue(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long): Boolean
public getValue(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long): Boolean
public getValue(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long): Boolean
public getValue(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long): Boolean
public getValue(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long): Boolean
public getValue(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long, d10: Long): Boolean
gets the value of the variable at a specific location
getValueAbsolute public getValueAbsolute(index: String): Boolean
public getValueAbsolute(d1: Long): Boolean
public getValueAbsolute(d1: Long, d2: Long): Boolean
public getValueAbsolute(d1: Long, d2: Long, d3: Long): Boolean
public getValueAbsolute(d1: Long, d2: Long, d3: Long, d4: Long): Boolean
public getValueAbsolute(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long): Boolean
public getValueAbsolute(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long): Boolean
public getValueAbsolute(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long): Boolean
public getValueAbsolute(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long): Boolean
public getValueAbsolute(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long): Boolean
public getValueAbsolute(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long, d10: Long): Boolean
gets the value of the variable at a specific location without validatating.
invalidate public invalidate()
Invalidates the variable
isInput public isInput(): Boolean
Indicates whether the variable is an input or output
isInputToComponent public isInputToComponent(): Boolean
Indicates whether a variable is an input to a component
isInputToModel public isInputToModel(): Boolean
Indicates whether a variable is an input to the Model
isValid public isValid(): Boolean
Indicates whether the variable is currently valid or not
precedentLinks public precedentLinks(): VariableLinks
Returns a list of links that are immediate precedents to the value of this 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.
setAutoSize public setAutoSize(flag: Boolean)
sets the autoSize flag.
setDescription public setDescription(description: String)
sets the description for the variable
setDimensions public setDimensions(d1: Long)
public setDimensions(d1: Long, d2: Long)
public setDimensions(d1: Long, d2: Long, d3: Long)
public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long)
public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long)
public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long)
public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long)
public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long)
public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long)
public setDimensions(d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long, d10: Long)
sets the size of the dimensions of the array
setHasChanged public setHasChanged(flag: Boolean)
Boolean which indicates if the variable has changed since the last time the boolean was reset.
setHide public setHide(flag: Boolean)
Set whether the variable is hidden or not
setLength public setLength(size: Long)
sets the size of the array.
public setLength(size: Long, dimension: Long)
sets the size of a specific dimension in the array.
setMetadata public setMetadata(name: String, type: Variable.MetadataType, value: Any, access: Variable.MetadataAccess, archive: Boolean)
Set a metadata value on a variable.
setNumDimensions public setNumDimensions(num: Long)
sets the number of dimensions
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.
setSize public setSize(size: Long)
sets the size of the array.
public setSize(size: Long, dimension: Long)
sets the size of a specific dimension in the array.
setValue public setValue(value: Boolean, index: String)
public setValue(value: Boolean, d1: Long)
public setValue(value: Boolean, d1: Long, d2: Long)
public setValue(value: Boolean, d1: Long, d2: Long, d3: Long)
public setValue(value: Boolean, d1: Long, d2: Long, d3: Long, d4: Long)
public setValue(value: Boolean, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long)
public setValue(value: Boolean, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long)
public setValue(value: Boolean, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long)
public setValue(value: Boolean, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long)
public setValue(value: Boolean, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long)
public setValue(value: Boolean, d1: Long, d2: Long, d3: Long, d4: Long, d5: Long, d6: Long, d7: Long, d8: Long, d9: Long, d10: Long)
sets the value of the variable at a specific location
toString public toString(index: Long): String
converts the variable value to a string representation.
public toString(): String
Converts the variable value to a string representation.
toStringAbsolute public toStringAbsolute(index: Long): String
converts the variable value to a string representation.
public toStringAbsolute(): String
Converts the variable value to a string representation.
validate public validate()
Causes the scheduler to get a valid value for this variable.

Connect with Ansys