UF_ROUTE_specify_item_plugin_s (view source)
 
Defined in: uf_route.h
 
Also known as:
 
Overview
Structure passed to the SPECIFY_ITEM plugin.

The SPECIFY_ITEM plugin selects a part, stock, elbow,
wire, cable, or shield conforming to the given
characteristics.

The SPECIFY_ITEM plugin must filter the selected part
based on the current discipline and specification by
calling the FilterOnCurrentSpecifications routine.


Data Members

mode
int
Input: Specifies the type of item (e.g. part, stock, elbow, etc.)
Valid values: (See uf_ui_route.h)
UF_UI_ROUTE_PLV_INDEX_PARTS
UF_UI_ROUTE_PLV_INDEX_STOCK,
UF_UI_ROUTE_PLV_INDEX_ELBOWS
UF_UI_ROUTE_PLV_INDEX_CUT_ELBOWS,
UF_UI_ROUTE_PLV_INDEX_REPLACE_PART
UF_UI_ROUTE_PLV_INDEX_WIRES,
UF_UI_ROUTE_PLV_INDEX_CABLES
UF_UI_ROUTE_PLV_INDEX_SHIELDS

node_id
const char*
Input: Specifies the name/ID of the node in the
Product Library View under which to look
for matching characteristics.

num_specifications
int


specifications
const char* *
Input: Specifies all of the disciplines and specifications
that are currently valid. Reserved for future use.

chosen_part
UF_ROUTE_part_lib_part_p_t
Input: Characteristics structure used to for item selection.
Represents the characteristics from a part chosen by
the user before calling the plug-in.

Output: Characteristics of the part the user selected while
running the plug-in.

placer_object
tag_t
Output: Selected placement object. A condemned point to stand in
for screen position pick. Will be a NULL_TAG in Assign
Stock (UF_UI_ROUTE_PLV_INDEX_STOCK) mode.

placer_object_pos [ 3 ]
double
Output: Placement position in Work Occurrence coordinates.

error
int
Output: Zero indicates success