FLDget_cell_null_data,FLDset_cell_null_data,FLDset_cell_null_flag

Synopsis

get/set the NULL data flag and NULL data value in one Cell_Data cell_set component

int FLDget_cell_null_data (
OMobj_id cell_set,
int comp,
int *null_flag,
char *null_value);

int FLDset_cell_null_data (
OMobj_id cell_set,
int comp,
char *null_value,
int type);

int FLDset_cell_null_flag (
OMobj_id cell_set,
int comp,
int null_flag);

Description

These routines get/set the NULL data flag (null_flag) in one component of a Data_Array in a cell_set 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."

Note: To get the null_flag, use FLDget_cell_null_data.

Parameters

OMobj_id cell_set

The OMobj_id of a cell_set within a Cell_Data, such as that returned by the FLDget_cell_set routine.

int comp

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

int *null_flag
int null_flag

In FLDget_cell_null_data, a pointer to an integer in which the flag that signifies "NULL data is present" is returned.

In FLDset_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.

void *null_value

In FLDget_cell_null_data, a pointer to a data item of unknown type into which the null data value this component is using will be returned.

In FLDset_cell_null_data, a pointer to 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.

int type

FLDset_cell_null_data only. An integer that specifies the type of the null_value. This should match the primitive data type of the rest of the Data_Array. The choices are (defined in avs/om.h):

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

Examples

modules/cellnode.c
modules/ext_face.c

Files

v/fld.v.

See Also

FLDget_cell_set.