FLDFget_points FLDFset

FLDFget_points, FLDFset_points

Synopsis

get/set the points (extents) array in a Grid_Struct Grid

INTEGER FLDFget_points (field, points, size, mode)
     INTEGER field(OIDSIZ)
     INTEGER points_ptr
     INTEGER size
     INTEGER mode

INTEGER FLDFset_points (field, points, size, mode)
     INTEGER field(OIDSIZ)
     INTEGER points(*)
     INTEGER size
     INTEGER mode

Description

These routines get/set the points array (extents) in a Grid_Struct Grid. The points array is defined as: float points = [npoints][nspace].

Grid_Structs include Grid_Unif and Grid_Rect grids.

Parameters

field

The integer of a field containing a Grid_Struct.

points_ptr

In FLDFget_points, points is an integer representing a pointer to array of points; upon return, points is filled in with the address of the points array. You must call ARRFfree() on this an integer representing a pointer when you are done with it.

To access data array you will need to use ARRFoffset function described in the OM reference pages.

On 64-bit platforms points_ptr is actually an INTEGER*8.

points

In FLDFset_points, points is an array of type float from which the points array is copied to the field.

size

In FLDFset_points, size is an integer variable in which the size of the points array is returned.

In FLDFset_points, size is an integer variable from which the size of the points array is copied to the field.

mode

An integer constant that establishes the access mode for the array subobject. Constants for the possible values are defined in avs/om.h as follows.

For FLDFget_points:

Mode	Value	Meaning
OM_GET_ARRAY_RD	0	The program reads the array, but does not write to it.
OM_GET_ARRAY_WR	1	The program writes to the array, completely replacing it.
OM_GET_ARRAY_RW	2	The program reads from and writes to the array.
OM_GET_ARRAY_RD_COPY	3	The program requires a copy of the array for its own, private use (reading or writing).

For FLDFset_points:

Mode	Value	Meaning
OM_SET_ARRAY_COPY	0	Copy the array into the Object Manager
OM_SET_ARRAY_FREE	1	If possible, do not copy the array. AVS/Express copies the array anyway if the function is running in an external process or if data type conversion is required.This mode is generally preferred to OM_SET_ARRAY_COPY AVS/Express manages the array and will determine when the array can be freed. You must allocate space for the array with a call to ARRFalloc.
OM_SET_ARRAY_STATIC	2	If possible, do not copy the array. Instead, set the object's array to an integer representing a pointer to node_data. AVS/Express copies the array anyway if the function is running in an external process or if data type conversion is required. AVS/Express does not manage the array. You must ensure that the array is valid for the life of the object or until the object replaces the array.