Interface ModelCenter::IReferenceArray

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

COM Instance.

Inherits from:

• ModelCenter::IArray

Members

• autoGrow
• autoSize
• createRefProp
• dependentLinks
• dependents
• directDependents
• directPrecedents
• fromString
• fromStringEx
• getDimensions
• getFullName
• getLength
• getMetadata
• getName
• getRefPropValue
• getRefPropValueAbsolute
• getSize
• getType
• getValue
• getValueAbsolute
• hasChanged
• hide
• invalidate
• isInput
• isInputToComponent
• isInputToModel
• isValid
• length
• numDimensions
• OwningComponent
• precedentLinks
• precedents
• reference
• reference
• referencedVariable
• referencedVariables
• setDimensions
• setLength
• setMetadata
• setRefPropValue
• setSize
• setValue
• size
• toString
• toStringAbsolute
• toStringAbsoluteEx
• toStringEx
• validate
• value
• value

Properties

Property hasChanged

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

boolean ModelCenter::IReferenceArray::hasChanged

Return type: boolean

Property hide

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

boolean ModelCenter::IReferenceArray::hide

Return type: boolean

Property OwningComponent

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

LPDISPATCH ModelCenter::IReferenceArray::OwningComponent

Return type: LPDISPATCH

Property size

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

long ModelCenter::IReferenceArray::size

Return type: long

Property numDimensions

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

long ModelCenter::IReferenceArray::numDimensions

Return type: long

Property autoGrow

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

boolean ModelCenter::IReferenceArray::autoGrow

Whether or not the reference array is set to automatically grow.

Return type: boolean

Property value

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

long ModelCenter::IReferenceArray::value

Value of an array element.

Parameters:

• index: Index of the array element (0-based index).

Returns:

Return type: long

Property value

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

double ModelCenter::IReferenceArray::value( long index)(long index)

Value of an array element.

Parameters:

• index: Index of the array element (0-based index).
• newValue:
  

Return type: double

Property reference

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

long ModelCenter::IReferenceArray::reference

Reference of an array element.

Parameters:

• index: Index of the array element (0-based index).

Returns:

Return type: long

Property reference

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

BSTR ModelCenter::IReferenceArray::reference( long index)(long index)

Reference of an array element.

Parameters:

• index: Index of the array element (0-based index).
• newValue:
  

Return type: BSTR

Property referencedVariables

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

long ModelCenter::IReferenceArray::referencedVariables

Gets the reference variables of the index element of the array.

Parameters:

• index: Index of the array element (0-based index).

Returns:

The references variables of the element.

Return type: long

Property referencedVariable

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

long ModelCenter::IReferenceArray::referencedVariable

Gets the reference variable of the index element of the array. Convenience method for if the indexed variable only has one reference.

Parameters:

• index: Index of the array element (0-based index).

Returns:

The reference variable of the index element.

Return type: long

Public functions

Function isValid

boolean ModelCenter::IReferenceArray::isValid()

Finds out whether or not the array is valid.

Returns:

yes(TRUE) or no(FALSE).

Return type: boolean

Reimplements: isValid

Function validate

void ModelCenter::IReferenceArray::validate()

Causes the array to validate itself.

Return type: void

Reimplements: validate

Function getName

BSTR ModelCenter::IReferenceArray::getName()

Gets the name of the array.

Returns:

The name of the array.

Return type: BSTR

Reimplements: getName

Function getFullName

BSTR ModelCenter::IReferenceArray::getFullName()

Gets the full ModelCenter path of the array.

Returns:

The full ModelCenter path of the array.

Return type: BSTR

Reimplements: getFullName

Function getType

BSTR ModelCenter::IReferenceArray::getType()

Gets the type of the array.

Returns:

The type of the array as a string.

Return type: BSTR

Reimplements: getType

Function isInput

boolean ModelCenter::IReferenceArray::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::IReferenceArray::toString()

Converts the array to a string, validating the array if necessary. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays.

Returns:

The converted string value of the array.

Return type: BSTR

Reimplements: toString

Function fromString

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

Sets the value of the array from a specified string. For 1D arrays, the specification is of the form '1,2,3'.
For nD arrays, the specification is of the form 'bounds[2,2,2] {1,2,3,4,5,6,7,8}'.
String arrays may optionally have the elements quoted in the form 'bounds[2,3] {"a", "b,c", "d", "", "e", "f"}'

Parameters:

• value: New value.

Parameters:

• BSTR value

Return type: void

Reimplements: fromString

Function toStringAbsolute

BSTR ModelCenter::IReferenceArray::toStringAbsolute()

Converts the array to a string. If the variable is an array, it will to be of the form "1, 2, 3" for one-dimensional arrays or "bounds[3,3] {1, 2, 3, 4, 5, 6, 7, 8, 9}" for multi-dimensional arrays.

Returns:

The converted string value of the array.

Return type: BSTR

Reimplements: toStringAbsolute

Function invalidate

void ModelCenter::IReferenceArray::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::IReferenceArray::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::IReferenceArray::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::IReferenceArray::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::IReferenceArray::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::IReferenceArray::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::IReferenceArray::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::IReferenceArray::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::IReferenceArray::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::IReferenceArray::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::IReferenceArray::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 toStringEx

BSTR ModelCenter::IReferenceArray::toStringEx(long index)

Converts the value of an array element to a string, validating the array if necessary.

Parameters:

• index: Index of the array element (0-based index).

Returns:

The value of the element as a string.

Parameters:

• long index

Return type: BSTR

Reimplements: toStringEx

Function fromStringEx

void ModelCenter::IReferenceArray::fromStringEx(BSTR value, long index)

Sets the value of an array element from a specified string.

Parameters:

• value: New value.
• index: Index of the array element (0-based index).

Parameters:

• BSTR value
• long index

Return type: void

Reimplements: fromStringEx

Function toStringAbsoluteEx

BSTR ModelCenter::IReferenceArray::toStringAbsoluteEx(long index)

Converts the value of an array element to a string.

Parameters:

• index: Index of the array element (0-based index).

Returns:

The value of the element as a string.

Parameters:

• long index

Return type: BSTR

Reimplements: toStringAbsoluteEx

Function getLength

long ModelCenter::IReferenceArray::getLength([optional] VARIANT dim)

Get the length of the n'th dimension of the array.

Parameters:

• dim: Dimension of the array to query. This uses a 0 based index, so 0 will give you the first dimension, 1 the second, etc. If omitted, gives the first dimension

Returns:

Length(size) of the array.

Parameters:

• [optional] VARIANT dim

Return type: long

Reimplements: getLength

Function setLength

void ModelCenter::IReferenceArray::setLength(long length, [optional] VARIANT dim)

Sets the length of the n'th dimension of the array

Parameters:

• length: New length of the n'th dimension of the array
• dim: The dimension to set. This uses a 0 based index, so 0 will set the first dimension, 1 the second, etc. If omitted, sets the first dimension

Parameters:

• long length
• [optional] VARIANT dim

Return type: void

Reimplements: setLength

Function setDimensions

void ModelCenter::IReferenceArray::setDimensions(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)

Sets the number of dimensions of an array and the length of each dimension in one call. An array initializes to 0 length. If any dimension of the array has 0 length, the whole array contains no data. You must set the array size before filling in values unless you are using the setArray() call.

Parameters:

• d1: length of the 1st dimension of the array
• d2: length of the 2nd dimension of the array. If omitted, the array is 1 dimensional
• d3: length of the 3rd dimension of the array. If omitted, the array is 2 dimensional
• d4: length of the 4th dimension of the array. If omitted, the array is 3 dimensional
• d5: length of the 5th dimension of the array. If omitted, the array is 4 dimensional
• d6: length of the 6th dimension of the array. If omitted, the array is 5 dimensional
• d7: length of the 7th dimension of the array. If omitted, the array is 6 dimensional
• d8: length of the 8th dimension of the array. If omitted, the array is 7 dimensional
• d9: length of the 9th dimension of the array. If omitted, the array is 8 dimensional
• d10: length of the 10th dimension of the array. If omitted, the array is 9 dimensional

Parameters:

• 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

Reimplements: setDimensions

Function getValue

double ModelCenter::IReferenceArray::getValue(int index)

Gets the value of an array element.

Parameters:

• index: Index of the array element (0-based index).

Returns:

The value.

Parameters:

• int index

Return type: double

Function setValue

double ModelCenter::IReferenceArray::setValue(double value, int index)

Sets the value of an array element.

Parameters:

• value: New value.
• index: Index of the array element (0-based index).

Returns:

Parameters:

• double value
• int index

Return type: double

Function createRefProp

IDispatch * ModelCenter::IReferenceArray::createRefProp(BSTR name, BSTR type)

Creates a reference property for the array.

Parameters:

• name: Name of the reference property.
• type: Type of reference property to create.
  Allowed types are: double, long, boolean, and string.

Returns:

IDispatch* to an IRefArrayProp object.

Parameters:

• BSTR name
• BSTR type

Return type: IDispatch *

Function getRefPropValue

VARIANT ModelCenter::IReferenceArray::getRefPropValue(BSTR name, int index)

Gets the value of a specified reference property for an element in the array.

Parameters:

• name: Name of the reference property.
• index: Index of the array element (0-based index).

Returns:

The value as a variant.

Parameters:

• BSTR name
• int index

Return type: VARIANT

Function setRefPropValue

void ModelCenter::IReferenceArray::setRefPropValue(BSTR name, int index, BSTR value)

Sets the value of a specified reference property for an element in the array.

Parameters:

• name: Name of the reference property.
• index: Index of the array element (0-based index).
• value: New value.

Parameters:

• BSTR name
• int index
• BSTR value

Return type: void

Function getRefPropValueAbsolute

VARIANT ModelCenter::IReferenceArray::getRefPropValueAbsolute(BSTR name, int index)

Gets the value of a specified reference property for an element in the array without running to validate.

Parameters:

• name: Name of the reference property.
• index: Index of the array element (0-based index).

Returns:

The value as a variant.

Parameters:

• BSTR name
• int index

Return type: VARIANT

Function getValueAbsolute

double ModelCenter::IReferenceArray::getValueAbsolute(int index)

gets the value of the variable at a specific location without validating.

Parameters:

• index: The array element index (0-based index).

Returns:

The reference value.

Parameters:

• int index

Return type: double