res_display_get_ntools | (plot_type) |
Description: | ||
This function returns the number of tools of the specified type. | ||
Input: | ||
STRING | plot_type[] | This value specifies the tool type. If this value is set to an empty string or ““ the count of all tools is returned. See the remarks below for more information. |
Output: | ||
INTEGER | <Return Value> | This function returns the number of tools of the specified type. |
Error Conditions: | ||
See the Status Messages for information on any error values returned by this function. |
“Fringe” | “2DContour” | “Vector” | |
“Tensor” | “Icon” | “3DContour” | |
“Deformation” | “Element” | “Cursor” | |
“Isosurface” | “Stream” |
res_display_get_nposted_tools | (plot_type, view_id) |
Description: | ||
This function returns the number of posted tools of the specified type. | ||
Input: | ||
STRING | plot_type[] | This value specifies the tool type. If this value is set to an empty string or ““ the count of all tools is returned. See the remarks below for more information. |
INTEGER | view_id | This value specifies the viewport identifier. If this value is set to 0, the number of posted tools for all viewports will be returned. |
Output: | ||
INTEGER | <Return Value> | This function returns the number of posted tools of the specified type. |
Error Conditions: | ||
See the Status Messages for information on any error values returned by this function. |
“Fringe” | “2DContour” | “Vector” | |
“Tensor” | “Icon” | “3DContour” | |
“Deformation” | “Element” | “Cursor” | |
“Isosurface” | “Stream” |
res_display_get_posted_tools | (plot_type, tools, types, view_id) |
Description: | ||
This function outputs the names and types of the posted tools. | ||
Input: | ||
STRING | plot_type[] | This value specifies the tool type. If this value is set to an empty string or ““, the name and types of all tools is returned. See the remarks below for more information. |
INTEGER | view_id | This value specifies the viewport identifier. Optional=0. |
Output: | ||
STRING | tools[](VIRTUAL) | This value returns the plot tool names that are posted to the specified viewport. |
STRING | types[](VIRTUAL) | This value returns the plot types. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
See the Status Messages for information on any error values returned by this function. |
“Fringe” | “2DContour” | “Vector” | |
“Tensor” | “Icon” | “3DContour” | |
“Deformation” | “Element” | “Cursor” | |
“Isosurface” | “Stream” |
res_display_get_color_id | (color_str, color_id) |
Description: | ||
This function outputs the color identifier of the input color string as it is used with the tool attribute definitions. | ||
Input: | ||
STRING | color_str[] | This value specifies the input color. See the remarks below for more information. |
Output: | ||
INTEGER | color_id | This value returns the color identifier of the specified color. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
See the Status Messages for information on any error values returned by this function. |
“Black” | “Red” | “Green” | |
“Yellow” | “Blue” | “Magenta” | |
“Cyan” | “White” | “Orange” | |
“LtOrange” | “DkGreen” | “LtGreen” | |
“DkBlue” | “LtBlue” | “DkMagenta” | |
“LtMagenta” |
res_display_get_color_str | (color_id, color_str) |
Description: | ||
This function outputs the color string of the input color identifier as it is used with the tool attribute definitions. | ||
Input: | ||
INTEGER | color_id | This value specifies the color identifier. This value must be 0 or greater and less than 16. |
Output: | ||
STRING | color_str[] | This value returns the color associated with the given identifier. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
See the Status Messages for information on any error values returned by this function. |
res_display_get_tool_size | (plot_type, plot_name, ntargets, target_length, nattribs) |
Description: | ||
This function outputs the size of the targets and attributes of the specified plot tool. | ||
Input: | ||
STRING | plot_type[] | This value specifies the tool type. If this value is set to an empty string or ““, the target size and attributes of all tools is returned. See the remarks below for more information. |
STRING | plot_name[] | This value specifies the name of the plot tool. |
Output: | ||
INTEGER | ntargets | This value returns the number of targets defined. |
INTEGER | target_length | This value returns the maximum length of a target string. |
INTEGER | nattribs | This value returns the number of attributes defined. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
See the Status Messages for information on any error values returned by this function. |
“Fringe” | “2DContour” | “Vector” | |
“Tensor” | “Icon” | “3DContour” | |
“Deformation” | “Element” | “Cursor” | |
“Isosurface” | “Stream” |
res_display_get_tool | (plot_type, plot_name, ent_type, ntargets, targets, nattribs, attributes, deformed_flag) |
Description: | ||
This function outputs the specified plot tool definition. | ||
Input: | ||
STRING | plot_type[] | This value specifies the tool type. If this value is set to an empty string or ““, the definition of all tools is returned. See the remarks below for more information. |
STRING | plot_name[] | This value specifies the name of the plot tool. |
Output: | ||
STRING | ent_type[] | This value returns the entity type specification. |
INTEGER | ntargets | This value returns the number of target entities. |
STRING | targets[](ntargets) | This value returns the target entities. |
INTEGER | nattribs | This value returns the number of attributes associated with this plot tool |
STRING | attributes[](nattribs) | This value returns the attributes of this plot tool. |
LOGICAL | deformed_flag | This value returns the state of the deformed flag. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
See the Status Messages for information on any error values returned by this function. |
“Fringe” | “2DContour” | “Vector” | |
“Tensor” | “Icon” | “3DContour” | |
“Deformation” | “Element” | “Cursor” | |
“Isosurface” | “Stream” |
res_display_get_graph | (plot_name, graph_type, entity_type, ntargets, targets, nattribs, attributes) |
Description: | ||
This function outputs the specified graph plot tool definitions. | ||
Input: | ||
STRING | plot_name[] | This value specifies the name of the graph plot tool. |
Output: | ||
STRING | graph_type[] | This value returns the graph type. |
STRING | entity_type[] | This value returns the entity type. |
INTEGER | ntargets | This value returns the number of targets. |
STRING | targets[](ntargets) | This value returns the target values. |
INTEGER | nattribs | This value returns the number of attributes associated with this plot. |
STRING | attributes[](nattribs) | This value returns the attributes of this plot tool. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
See the Status Messages for information on any error values returned by this function. |
res_display_count_tools | (plot_type, status) |
Description: | ||
This function retrieves the number of plot tools of the specified type. | ||
Input: | ||
INTEGER | plot_type | This value specifies the tool type. If this value is set to an empty string or ““, the number of plot tools of all types is returned. See the remarks below for more information. |
INTEGER | status | This value specifies the status of the plot tool. Valid values are: 0 = unposted tools, 1 = posted tools, and 2 = all tools. |
Output: | ||
INTEGER | <Return Value> | This function returns a value specifying the number of tools of the given type. |
Error Conditions: | ||
None. |
“Fringe” | “2DContour” | “Vector” | |
“Tensor” | “Icon” | “3DContour” | |
“Deformation” | “Element” | “Cursor” | |
“Isosurface” | “Stream” |
res_display_get_tool_data | (plot_type, plot_name, location, type) |
Description: | ||
This function retrieves the location and type of data associated with a plot tool. | ||
Input: | ||
STRING | plot_type[] | This value specifies the tool type. If this value is set to an empty string or ““, the location and data type for all of the plot tools is set. See the remarks below for more information. |
STRING | plot_name[] | This value specifies the name of the plot tool. |
Output: | ||
STRING | location[] | This value returns the data location. |
STRING | type[] | This value returns the data type. |
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
See the Status Messages for information on any error values returned by this function. |
“Fringe” | “2DContour” | “Vector” | |
“Tensor” | “Icon” | “3DContour” | |
“Deformation” | “Element” | “Cursor” | |
“Isosurface” | “Stream” |
res_display_set_tool_data | (plot_type, plot_name, register_id) |
Description: | ||
This function sets the data handling descriptions to the registers for a plot tool which has previously been posted. | ||
Input: | ||
STRING | plot_type[] | This value specifies the tool type. If this value is set to an empty string or ““, the data associated to all of the plot tools is set. See the remarks below for more information. |
STRING | plot_name[] | This value specifies the name of the plot tool. |
INTEGER | register_id | This value specifies the register identifier. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
See the Status Messages for information on any error values returned by this function. |
“Fringe” | “2DContour” | “Vector” | |
“Tensor” | “Icon” | “3DContour” | |
“Deformation” | “Element” | “Cursor” | |
“Isosurface” | “Stream” |
res_display_set_graph_data | (plot_name, x_register_id, y_register_id) |
Description: | ||
This function sets the data handling descriptions to the registers for a graph tool which has previously been posted. | ||
Input: | ||
STRING | plot_name[] | This value specifies the graph plot tool name. |
INTEGER | x_register_id | This value specifies the register identifier containing the X axis data. |
INTEGER | y_register_id | This value specifies the register identifier containing the Y axis data. |
Output: | ||
INTEGER | <Return Value> | This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error. |
Error Conditions: | ||
See the Status Messages for information on any error values returned by this function. |