FLDFget_cell_null_data, FLDFset_cell_null_data, FLDFset_cell_null_flag

Synopsis

get/set the NULL data flag and NULL data value in a cell data component

INTEGER FLDFget_cell_null_data (cell_set, comp, null_flag, null_value)
INTEGER cell_set(OIDSIZ)
INTEGER comp
INTEGER null_flag
INTEGER null_value

INTEGER FLDFset_cell_null_data (cell_set, comp, null_flag, null_value)
INTEGER cell_set(OIDSIZ)
INTEGER comp
INTEGER null_value
INTEGER type

INTEGER FLDFset_cell_null_flag (cell_set, comp, null_flag,)
INTEGER cell_set(OIDSIZ)
INTEGER comp
INTEGER null_flag

Description

These routines get/set the NULL data flag (null_flag) in a specified component of a cell data. null_flag indicates the presence of NULL data. They also get/set the data value (null_value) that should be interpreted as meaning "no data here" by visualization modules and the renderer.

Note: To get the null_flag, use FLDFget_cell_null_data.

Parameters

cell_set

The integer id of a cell set, such as that returned by the FLDFget_cell_set routine.

comp

An integer that sets which component [0-n] of the cell_data Data_Array to get/set.

null_flag

In FLDFget_cell_null_data, an integer in which the flag that signifies "NULL data is present" is returned.

In FLDFset_cell_null_flag, an integer that sets null_flag within the Data_Array.

By AVS/Express convention, 0 means there is no NULL data. Any other value means there is NULL data.

null_value

In FLDFget_cell_null_data, an integer representing unknown type in which the null data value this component is using will be returned.

In FLDFset_cell_null_data, an integer representing a data item of unknown type from which the null data value will be copied into the component.

Note that there must be enough storage at null_value to store one item of the actual type.

type

n integer code specifying the array's data type. AVS/Express provides the following symbolic constants, defined in <avs/dtype.h>:

Constant	Value
DTYPE_CHAR	0
DTYPE_BYTE	1
DTYPE_SHORT	2
DTYPE_INTEGER	3
DTYPE_FLOAT	4
DTYPE_DOUBLE	5
DTYPE_UNSET	DNTYPES+1

Examples

none.

Files

v/fld.v.

See Also

none.