DVset_null

Synopsis

flag a specified data value as NULL in one component of a field

module DVset_null {
Node_Data+IOparam &in {
nnodes+req;
};
int+Iparam component;
int+Iparam unset;
float+Iparam null_value;
Node_Data+Oparam out;
method+notify_val+notify_inst upd_set_null<status=1>
= "DVset_null_update";
};

Description

DVset_null alters a field by defining a specified value as a NULL value and setting the flag that indicates the presence of NULL data to 1 ("has null data"). This is done on a per-component basis--one component may have NULL data while others do not. DVset_null can also turn off the NULL data flag.

Input

&in

A reference to a field with Node_Data.

component

An integer. Sets which component will be flagged as having NULL data. The components can be scalar or vector.

unset

An integer. When not equal to 0, DVset_null will turn off the selected component's NULL data flag.

null_value

A float. Specifies the data value that will be treated as a NULL value. This is converted to the data type of the field before it is used.

Output

&out

The output is a reference to the input field. The input field has been modified so that its Node_Data Data_Array null_flag =1 and null_value is set for the component's Data_Array. DVset_null is one of the few modules that actually changes its input data field.

Example

Not available.

File

v/dv.v

modules/set_null.c Utility DVM macros DVMset_null_param

See also

DVthreshold

DVthresh_null