set_null_cell
Synopsis
flag a specified data value as NULL or not NULL in one component of a field
Input Port
in_field
|
Cell_Data
|
ui_parent
|
user interface parent object
|
Parameters
data component
|
UIradioBoxLabel
|
set component to flag as null or not null
|
Null Value
|
UIfieldTypein
|
value of NULL data
|
unset null
|
UItoggle
|
set to not null
|
Output Port
out_fld
|
Mesh + Cell_Data
|
out_obj
|
output renderable object
|
Description
set_null_cell 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.
set_null_cell can also unset the flag that indicates NULL data.
Input
in_field
The input must contain Cell_Data.
ui_parent
A port to connect to a user interface object that contains the macro's widgets. By default, it is connected to the default user interface object in the application in which the macro is instanced. (This default connection is not drawn.)
Parameters
data component
UIradioBoxLabel. Radio buttons to pick which component will be flagged as having NULL data (or to unflag). The components can be scalar or vector. The default is the first (0th) component. If cell data labels are present, they are displayed.
Null Value
UIfieldTypein. A float typein. Specifies the data value that is treated as a NULL value. The default is 0.
unset null
UItoggle. Unflag data component as having NULL data. The default is off.
Output Port
out_fld
The output is a merge of the input field plus the new Cell_Data that has the null_flag =1 and null_value set for the component's Data_Array.
If unset was toggled, null_flag=0.
out_obj
This is a renderable version of the output field. (The field is renderable only if it included a mesh.)
Example
Not available
File
v/modules.v
See also related modules