OMFget_sub_farray

Synopsis

INTEGER FUNCTION OMFget_sub_farray(object_id,
      . ndim,
      . dims,
      . min,
      . max,
      . farray)
#include <avs/omf.inc>
INTEGER object_id(OIDSIZ)
INTEGER ndim
INTEGER dims(ndims), min(ndims), max(ndims)
REAL farray(1)

Description

For a complete description of this function, see OMget_sub_barray_val and set_sub_barray.fm .

Arguments

object_id

The id of an object, expressed as an integer.

ndim

The number of dimensions in the array, expressed as an integer.

dims

An array of ndim integer values specifying the dimensions of the array.

minmax

Arrays of ndim integer values specifying the the minimum and maximum indices to retrieve in each dimension of the array.

farray

The returned real subarray.

Returned value

The status code (see OMget_sub_barray_val and set_sub_barray.fm ).

Examples

none.

#include <avs/omf.inc>
      INTEGER array_id(OIDSIZ)
      INTEGER ndims
      INTEGER dims(OM_ARRAY_MAXDIM)
      INTEGER min(OM_ARRAY_MAXDIM), max(OM_ARRAY_MAXDIM)
      REAL sub(2,3,5)
      ...
      C
      C get the dimensions of object array
      IF (OMFget_array_dims(array_id,
      . ndims,
      . dims) .NE. 1)
      . PRINT*,'Error getting array dimensions of object array'
      C
      C set the subarray indices
            min(1) = 0
            max(1) = 2
            min(2) = 1
            max(2) = 4
            min(3) = 5
            max(3) = 10
      ...
      C get the subarray
IF (OMFget_sub_farray(array_id,
. ndims,
. dims,
. min,
. max,
. sub) .NE. 1)
. PRINT*,'Error getting subarray of object array'

See Also

OMFset_sub_farray