Interface ModelCenter::IObjectVariable

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

COM Instance.

Inherits from:

ModelCenter::IVariable

Members

Properties

Property hasChanged

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

boolean ModelCenter::IObjectVariable::hasChanged

Return type: boolean

Property hide

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

boolean ModelCenter::IObjectVariable::hide

Return type: boolean

Property OwningComponent

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

LPDISPATCH ModelCenter::IObjectVariable::OwningComponent

Return type: LPDISPATCH

Property value

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

BSTR ModelCenter::IObjectVariable::value

Value of the variable.

Return type: BSTR

Property description

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

BSTR ModelCenter::IObjectVariable::description

The description of the variable.

Return type: BSTR

Public functions

Function isValid

boolean ModelCenter::IObjectVariable::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

Reimplements: isValid

Function validate

void ModelCenter::IObjectVariable::validate()

Validates the variable by running the component if needed.

Return type: void

Reimplements: validate

Function getName

BSTR ModelCenter::IObjectVariable::getName()

Gets the name of the variable.

Returns:

The name of the variable.

Return type: BSTR

Reimplements: getName

Function getFullName

BSTR ModelCenter::IObjectVariable::getFullName()

Gets the full ModelCenter path of the variable.

Returns:

The full ModelCenter path of the variable.

Return type: BSTR

Reimplements: getFullName

Function getType

BSTR ModelCenter::IObjectVariable::getType()

Gets the type of the variable.

Returns:

The type of the variable as a string.

Return type: BSTR

Reimplements: getType

Function isInput

boolean ModelCenter::IObjectVariable::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

Reimplements: isInput

Function toString

BSTR ModelCenter::IObjectVariable::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

Reimplements: toString

Function fromString

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

Sets the value of the variable from the specified string.

Parameters:

value: New value.

Parameters:

BSTR value

Return type: void

Reimplements: fromString

Function toStringAbsolute

BSTR ModelCenter::IObjectVariable::toStringAbsolute()

Converts the value of the variable to a string.

Returns:

The value of the variable as a string.

Return type: BSTR

Reimplements: toStringAbsolute

Function invalidate

void ModelCenter::IObjectVariable::invalidate()

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

Return type: void

Reimplements: invalidate

Function directPrecedents

LPDISPATCH ModelCenter::IObjectVariable::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

Reimplements: directPrecedents

Function directDependents

LPDISPATCH ModelCenter::IObjectVariable::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

Reimplements: directDependents

Function precedentLinks

LPDISPATCH ModelCenter::IObjectVariable::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

Reimplements: precedentLinks

Function dependentLinks

LPDISPATCH ModelCenter::IObjectVariable::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

Reimplements: dependentLinks

Function precedents

LPDISPATCH ModelCenter::IObjectVariable::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

Reimplements: precedents

Function dependents

LPDISPATCH ModelCenter::IObjectVariable::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

Reimplements: dependents

Function isInputToComponent

boolean ModelCenter::IObjectVariable::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

Reimplements: isInputToComponent

Function isInputToModel

boolean ModelCenter::IObjectVariable::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

Reimplements: isInputToModel

Function setMetadata

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

BSTR name
MetadataType type
VARIANT value
MetadataAccess access
boolean archive

Return type: void

Reimplements: setMetadata

Function getMetadata

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

Reimplements: getMetadata

Function getClassURL

BSTR ModelCenter::IObjectVariable::getClassURL()

Gets the class URL.

Returns:

The URL for the class.

Return type: BSTR

Function getMemberValue

VARIANT ModelCenter::IObjectVariable::getMemberValue(BSTR member)

Gets the value of a member.

Parameters:

member: Member index; (e.g., member1, grp1.member1, member1[1], member1[1,2]).

Returns:

The value of the member.

Parameters:

BSTR member

Return type: VARIANT

Function getMemberValueAbsolute

VARIANT ModelCenter::IObjectVariable::getMemberValueAbsolute(BSTR member)

Gets the value of a member without validating the variable.

Parameters:

member: Name of the member.

Returns:

The value of the member.

Parameters:

BSTR member

Return type: VARIANT

Function setMemberValue

void ModelCenter::IObjectVariable::setMemberValue(BSTR member, BSTR value)

Sets the value of a member.

Parameters:

member: Name of the member.
value: The value of the member.

Parameters:

BSTR member
BSTR value

Return type: void

Function setMember

void ModelCenter::IObjectVariable::setMember(BSTR member, BSTR value, BSTR type)

Sets the value of a member. A new member will be created if the member does not exist or the current type is not the same as the type specified.

Parameters:

member: Name of the member.
value: The value of the member.
type: Type of the member.

Parameters:

BSTR member
BSTR value
BSTR type

Return type: void

Function deleteMember

void ModelCenter::IObjectVariable::deleteMember(BSTR member)

Delete a member for non-strict type object. An error will be thrown for strict types

Parameters:

member: Member index.

Parameters:

BSTR member

Return type: void

Function deleteAllMembers

void ModelCenter::IObjectVariable::deleteAllMembers()

Delete all members for non-strict type object. An error will be thrown for strict types.

Return type: void

Function callMethod

VARIANT ModelCenter::IObjectVariable::callMethod(BSTR method)

Call a method and return a value (primitive or array of primitives) if any.

Parameters:

method: Name of the method.

Returns:

Value of the method.

Parameters:

BSTR method

Return type: VARIANT

Function isNonStrictType

boolean ModelCenter::IObjectVariable::isNonStrictType()

Check whether a class is a non-strict type.

Returns:

yes(TRUE) or no(FALSE).

Return type: boolean

Function toXML

BSTR ModelCenter::IObjectVariable::toXML()

Return an XML representation of the object.

Returns:

An XML representation of the object.

Return type: BSTR

Function fromXML

void ModelCenter::IObjectVariable::fromXML(BSTR str)

Update the object from an XML string.

Parameters:

str: Content of an object in XML format.

Parameters:

BSTR str

Return type: void

Function hasMember

boolean ModelCenter::IObjectVariable::hasMember(BSTR member)

Check if a member exists.

Parameters:

member: Name of the member.

Returns:

yes(TRUE) or no(FALSE).

Parameters:

BSTR member

Return type: boolean

Function isNumericMember

boolean ModelCenter::IObjectVariable::isNumericMember(BSTR member)

Check if a member is a numeric type.

Parameters:

member: Name of the member.

Returns:

yes(TRUE) or no(FALSE).

Parameters:

BSTR member

Return type: boolean

Function reinitialize

void ModelCenter::IObjectVariable::reinitialize()

Reinitialize the object using the current class type.

Return type: void

Function getMemberLength

long ModelCenter::IObjectVariable::getMemberLength(BSTR member, [optional] VARIANT dim)

Get length of an array member.

Parameters:

member: Name of the member.
dim: Dimension id of the array member.

Returns:

The length of the array member.

Parameters:

BSTR member
[optional] VARIANT dim

Return type: long

Function setMemberLength

void ModelCenter::IObjectVariable::setMemberLength(BSTR member, long length, [optional] VARIANT dim)

Set length of an array member.

Parameters:

member: Name of the member.
length: Length of the array.
dim: Dimension id of the array member.

Parameters:

BSTR member
long length
[optional] VARIANT dim

Return type: void

Function setMemberDimensions

void ModelCenter::IObjectVariable::setMemberDimensions(BSTR member, long d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)

Set dimension of an array member.

Parameters:

member: Name of the member.
d1: length of the 1st dimension.
d2: length of the 2nd dimension.
d3: length of the 3rd dimension.
d4: length of the 4th dimension.
d5: length of the 5th dimension.
d6: length of the 6th dimension.
d7: length of the 7th dimension.
d8: length of the 8th dimension.
d9: length of the 9th dimension.
d10: length of the 10th dimension.

Parameters:

BSTR member
long d1
[optional] VARIANT d2
[optional] VARIANT d3
[optional] VARIANT d4
[optional] VARIANT d5
[optional] VARIANT d6
[optional] VARIANT d7
[optional] VARIANT d8
[optional] VARIANT d9
[optional] VARIANT d10

Return type: void

Function getMemberNumDimensions

long ModelCenter::IObjectVariable::getMemberNumDimensions(BSTR member)

Get number of dimensions of an array member.

Parameters:

member: Name of the member.

Returns:

The number of dimensions of an array member.

Parameters:

BSTR member

Return type: long

Function getMemberDimensions

VARIANT ModelCenter::IObjectVariable::getMemberDimensions(BSTR member)

Get dimensions and size of an array member.

Parameters:

member: Name of the member.

Returns:

The number of demensions of the member.

Parameters:

BSTR member

Return type: VARIANT

Function getMemberType

BSTR ModelCenter::IObjectVariable::getMemberType(BSTR member)

Get type of the member.

Parameters:

member: Name of the member.

Returns:

The type of the member.

Parameters:

BSTR member

Return type: BSTR

Function hasMemberLowerBound

boolean ModelCenter::IObjectVariable::hasMemberLowerBound(BSTR member)

Check if a member has lower bound defined.

Parameters:

member: Name of the member.

Returns:

yes(TRUE) or no(FALSE).

Parameters:

BSTR member

Return type: boolean

Function hasMemberUpperBound

boolean ModelCenter::IObjectVariable::hasMemberUpperBound(BSTR member)

Check if a member has upper bound defined.

Parameters:

member: Name of the member.

Returns:

yes(TRUE) or no(FALSE).

Parameters:

BSTR member

Return type: boolean

Function getMemberLowerBound

double ModelCenter::IObjectVariable::getMemberLowerBound(BSTR member)

Get lowerBound of a member.

Parameters:

member: Name of the member.

Returns:

The lowerBound of the member.

Parameters:

BSTR member

Return type: double

Function setMemberLowerBound

void ModelCenter::IObjectVariable::setMemberLowerBound(BSTR member, double lowerBound)

Set lowerBound of the member.

Parameters:

member: Name of the member.
lowerBound: The lower bound

Parameters:

BSTR member
double lowerBound

Return type: void

Function getMemberUpperBound

double ModelCenter::IObjectVariable::getMemberUpperBound(BSTR member)

Get upperBound of the member.

Parameters:

member: Name of the member.

Returns:

The upperBlound of the member.

Parameters:

BSTR member

Return type: double

Function setMemberUpperBound

void ModelCenter::IObjectVariable::setMemberUpperBound(BSTR member, double upperBound)

Set upperBound of the member.

Parameters:

member: Name of the member.
upperBound: The upper bound.

Parameters:

BSTR member
double upperBound

Return type: void

Function getMemberEnumValues

BSTR ModelCenter::IObjectVariable::getMemberEnumValues(BSTR member)

Get enum values of the member.

Parameters:

member: Name of the member.

Returns:

The enum values of the member.

Parameters:

BSTR member

Return type: BSTR

Function setMemberEnumValues

void ModelCenter::IObjectVariable::setMemberEnumValues(BSTR member, BSTR enumValues)

Set enum values of the member.

Parameters:

member: Name of the member.
enumValues: Enumerated values as a comma separated string.

Parameters:

BSTR member
BSTR enumValues

Return type: void

Function getMemberEnumAliases

BSTR ModelCenter::IObjectVariable::getMemberEnumAliases(BSTR member)

Get enum aliases of the member.

Parameters:

member: Name of the member.

Returns:

The enum aliases of the member.

Parameters:

BSTR member

Return type: BSTR

Function setMemberEnumAliases

void ModelCenter::IObjectVariable::setMemberEnumAliases(BSTR member, BSTR enumAliases)

Set enum aliases of the member.

Parameters:

member: Name of the member.
enumAliases: Enumerated aliases as a comma separated string.

Parameters:

BSTR member
BSTR enumAliases

Return type: void

Function getMemberDescription

BSTR ModelCenter::IObjectVariable::getMemberDescription(BSTR member)

Get description of the member.

Parameters:

member: Name of the member.

Returns:

The description of the member.

Parameters:

BSTR member

Return type: BSTR

Function setMemberDescription

void ModelCenter::IObjectVariable::setMemberDescription(BSTR member, BSTR description)

Set description of the member.

Parameters:

member: Name of the member.
description: The description.

Parameters:

BSTR member
BSTR description

Return type: void

Function getMemberUnits

BSTR ModelCenter::IObjectVariable::getMemberUnits(BSTR member)

Get units of the member.

Parameters:

member: Name of the member.

Returns:

The units of the member.

Parameters:

BSTR member

Return type: BSTR

Function setMemberUnits

void ModelCenter::IObjectVariable::setMemberUnits(BSTR member, BSTR units)

Set units of the member.

Parameters:

member: Name of the member.
units: The units.

Parameters:

BSTR member
BSTR units

Return type: void

Function getMemberProperty

BSTR ModelCenter::IObjectVariable::getMemberProperty(BSTR member, BSTR propertyName)

Get value of a property of the member.

Parameters:

member: Name of the member.
propertyName: Name of the property.

Returns:

The value of the property of the member.

Parameters:

BSTR member
BSTR propertyName

Return type: BSTR

Function setMemberProperty

void ModelCenter::IObjectVariable::setMemberProperty(BSTR member, BSTR propertyName, BSTR propertyValue)

Set value of a property of the member.

Parameters:

member: Name of the member.
propertyName: Name of the property.
propertyValue: Value of the property.

Parameters:

BSTR member
BSTR propertyName
BSTR propertyValue

Return type: void

Function getMemberList

VARIANT ModelCenter::IObjectVariable::getMemberList(BSTR member)

Get a list of child members.

Parameters:

member: Name of the member.

Returns:

The list of child members.

Parameters:

BSTR member

Return type: VARIANT

Function getMethodList

VARIANT ModelCenter::IObjectVariable::getMethodList()

Get a list of methods.

Returns:

The list of methods.

Return type: VARIANT

Function toFile

void ModelCenter::IObjectVariable::toFile(BSTR member, BSTR fileName, VARIANT encoding)

Write a file member to a file.

Parameters:

member: Name of the member
fileName: Destination file name.
encoding: File encoding to be used (e.g., utf8, binary, ascii). ascii is assumed if empty.

Parameters:

BSTR member
BSTR fileName
VARIANT encoding

Return type: void

Function fromFile

void ModelCenter::IObjectVariable::fromFile(BSTR member, BSTR fileName)

Load a file into a file member.

Parameters:

member: Name of the member.
fileName: Source file name.

Parameters:

BSTR member
BSTR fileName

Return type: void

Function toFileAbsolute

void ModelCenter::IObjectVariable::toFileAbsolute(BSTR member, BSTR fileName, VARIANT encoding)

Write a file member to a file without validating the variable.

Parameters:

member: Name of the member
fileName: Destination file name.
encoding: File encoding to be used (e.g., utf8, binary, ascii). ascii is assumed if empty.

Parameters:

BSTR member
BSTR fileName
VARIANT encoding

Return type: void

Function getIsBinary

boolean ModelCenter::IObjectVariable::getIsBinary(BSTR member)

Gets the user set binary property of the file. File variables are either binary or ASCII.

Parameters:

member: Name of the member.

Returns:

True if the binary property of the file is true, else false.

Parameters:

BSTR member

Return type: boolean

Function setIsBinary

void ModelCenter::IObjectVariable::setIsBinary(BSTR member, boolean isBinary)

Sets the binary property of the file object. File variables are either binary or ASCII.

Parameters:

member: Name of the member.
isBinary: Value for the binary property.

Parameters:

BSTR member
boolean isBinary

Return type: void

Function getFileName

BSTR ModelCenter::IObjectVariable::getFileName(BSTR member)

Get the file name of a file member.

Parameters:

member: Name of the member.

Returns:

The name of the file.

Parameters:

BSTR member

Return type: BSTR

Function setFileName

void ModelCenter::IObjectVariable::setFileName(BSTR member, BSTR fileName)

Sets the file name of the file object. Also sets the file extension if given in the name.

Parameters:

member: Name of the member.
fileName: The name of the file.

Parameters:

BSTR member
BSTR fileName

Return type: void

Function getFileExtension

BSTR ModelCenter::IObjectVariable::getFileExtension(BSTR member)

Gets the file extension of an object file, which may be empty.

Parameters:

member: Name of the member.

Returns:

The file extension, or empty string if no extension exists.

Parameters:

BSTR member

Return type: BSTR

Function setFileExtension

void ModelCenter::IObjectVariable::setFileExtension(BSTR member, BSTR fileExtension)

Sets the file extension of the object file. The method adds the preceding '.' if excluded.

Parameters:

member: Name of the member.
fileExtension: The value of the new file extension.

Parameters:

BSTR member
BSTR fileExtension

Return type: void

Function getArrayMemberValueAbsolute

VARIANT ModelCenter::IObjectVariable::getArrayMemberValueAbsolute(BSTR member, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)

Get value of array member without validating the variable.

Parameters:

member: Member name.
d1: index in the 1st dimension (0-based index)
d2: index in the 2nd dimension (0-based index)
d3: index in the 3rd dimension (0-based index)
d4: index in the 4th dimension (0-based index)
d5: index in the 5th dimension (0-based index)
d6: index in the 6th dimension (0-based index)
d7: index in the 7th dimension (0-based index)
d8: index in the 8th dimension (0-based index)
d9: index in the 9th dimension (0-based index)
d10: index in the 10th dimension (0-based index)

Returns:

Value of the array element.

Parameters:

BSTR member
VARIANT d1
[optional] VARIANT d2
[optional] VARIANT d3
[optional] VARIANT d4
[optional] VARIANT d5
[optional] VARIANT d6
[optional] VARIANT d7
[optional] VARIANT d8
[optional] VARIANT d9
[optional] VARIANT d10

Return type: VARIANT

Function getArrayMemberValue

VARIANT ModelCenter::IObjectVariable::getArrayMemberValue(BSTR member, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)

Get value of array member.

Parameters:

member: Member name.
d1: index in the 1st dimension (0-based index)
d2: index in the 2nd dimension (0-based index)
d3: index in the 3rd dimension (0-based index)
d4: index in the 4th dimension (0-based index)
d5: index in the 5th dimension (0-based index)
d6: index in the 6th dimension (0-based index)
d7: index in the 7th dimension (0-based index)
d8: index in the 8th dimension (0-based index)
d9: index in the 9th dimension (0-based index)
d10: index in the 10th dimension (0-based index)

Returns:

Value of the array element.

Parameters:

BSTR member
VARIANT d1
[optional] VARIANT d2
[optional] VARIANT d3
[optional] VARIANT d4
[optional] VARIANT d5
[optional] VARIANT d6
[optional] VARIANT d7
[optional] VARIANT d8
[optional] VARIANT d9
[optional] VARIANT d10

Return type: VARIANT

Function setArrayMemberValue

void ModelCenter::IObjectVariable::setArrayMemberValue(BSTR member, BSTR value, VARIANT d1, [optional] VARIANT d2, [optional] VARIANT d3, [optional] VARIANT d4, [optional] VARIANT d5, [optional] VARIANT d6, [optional] VARIANT d7, [optional] VARIANT d8, [optional] VARIANT d9, [optional] VARIANT d10)

Set value of an array member.

Parameters:

member: Name of the member.
value: Value to be set.
d1: index in the 1st dimension (0-based index)
d2: index in the 2nd dimension (0-based index)
d3: index in the 3rd dimension (0-based index)
d4: index in the 4th dimension (0-based index)
d5: index in the 5th dimension (0-based index)
d6: index in the 6th dimension (0-based index)
d7: index in the 7th dimension (0-based index)
d8: index in the 8th dimension (0-based index)
d9: index in the 9th dimension (0-based index)
d10: index in the 10th dimension (0-based index)

Parameters:

BSTR member
BSTR value
VARIANT d1
[optional] VARIANT d2
[optional] VARIANT d3
[optional] VARIANT d4
[optional] VARIANT d5
[optional] VARIANT d6
[optional] VARIANT d7
[optional] VARIANT d8
[optional] VARIANT d9
[optional] VARIANT d10

Return type: void

Function getArrayMemberAbsolute

VARIANT ModelCenter::IObjectVariable::getArrayMemberAbsolute(BSTR member)

Get values of an array member as a variant of safe array without validating the variable.

Parameters:

member: Member name.

Returns:

Array values (variant of safe array).

Parameters:

BSTR member

Return type: VARIANT

Function getArrayMember

VARIANT ModelCenter::IObjectVariable::getArrayMember(BSTR member)

Get values of an array member as a variant of safe array.

Parameters:

member: Member name.

Returns:

Array values (variant of safe array).

Parameters:

BSTR member

Return type: VARIANT

Function setArrayMember

void ModelCenter::IObjectVariable::setArrayMember(BSTR member, VARIANT array)

Set values of an array member from a safe array. Create an array member if the member does not exist or is a different type.

Parameters:

member: Member name.
array: Values to be set (Variant of a safe array).

Parameters:

BSTR member
VARIANT array

Return type: void