getarrayentry
getarrayentry |
Purpose
Get a single value from a named array
Synopsis
function xreflect~getarrayentry( entityname:string, indices:list of xreflect~basicvalue ):xreflect~basicvalue
Arguments
|
entityname
|
The name of the public entity to access
|
|
indices
|
A list containing one value for each index set of the given array
|
Return value
A basicvalue containing the array entry for the given index values
Example
The following:
public declarations
myvar: dynamic array(set of integer,set of integer) of real
end-declarations
myvar(1,100) := 5.0
myvar(1,101) := 5.1
myvar(2,101) := 5.2
writeln('myvar(2,101)=',getarrayentry('myvar',[basicvalue(2),basicvalue(101)]))
produces this output:
myvar(2,101)=5.2
Further information
1. If the array does not contain an entry for the given indices, the function will return the default value for the array type (e.g. false, 0 or "")
2. If the specified entity name cannot be found, the model will terminate with a runtime error.
3. If the specified entity is not an array of a supported type, the model will terminate with a runtime error.
4. If the supplied indices list does not contain one basicvalue of the correct type for each index set of the array, the model will terminate with a runtime error.
5. The array index set contents will not be modified by this function
Related topics