Plot Tool Manipulation Functions

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">

The following function calls are used for posting, unposting, and deleting plot tools.

res_display_fringe_post	(plot_name, register_id, register_location, range_flag, spectrum_flag)

Description:
This function posts a fringe plot tool definition to the current viewport.
Input:
STRING	plot_name[]	This value specifies the name of the existing plot: either ““ or an existing name.
INTEGER	register_id	This value specifies the scalar register id (of location specified) containing data definition.
STRING	register_location[]	This value specifies the location of the data: either "C" = centroid, "N" = nodal, or "EN" = element nodal.
LOGICAL	range_flag	This value is set to TRUE to flag this tool to control the range info in the viewport.
LOGICAL	spectrum_flag	This value is set to TRUE to display the spectrum bar with this plot. Optional=TRUE.
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.

Description:

This function posts a fringe plot tool definition to the current viewport.

Input:

STRING

plot_name[]

This value specifies the name of the existing plot: either ““ or an existing name.

INTEGER

register_id

This value specifies the scalar register id (of location specified) containing data definition.

STRING

register_location[]

This value specifies the location of the data: either "C" = centroid, "N" = nodal, or "EN" = element nodal.

LOGICAL

range_flag

This value is set to TRUE to flag this tool to control the range info in the viewport.

LOGICAL

spectrum_flag

This value is set to TRUE to display the spectrum bar with this plot. Optional=TRUE.

Output:

INTEGER

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_vector_post	(plot_name, register_id, register_location, range_flag, spectrum_flag)

Description:
This function posts a vector plot tool definition to the current viewport.
Input:
STRING	plot_name[]	This value specifies the name of the existing plot: either ““ or an existing name.
INTEGER	register_id	This value specifies the vector register id (of location specified) containing data definition.
STRING	register_location[]	This value specifies the location of the data: either "C" = centroid, or "N" = nodal.
LOGICAL	range_flag	This value is set to TRUE to flag this tool to control the range info in the viewport.
LOGICAL	spectrum_flag	This value is set to TRUE to display the spectrum bar with this plot. Optional=TRUE.
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.

Description:

This function posts a vector plot tool definition to the current viewport.

Input:

STRING

plot_name[]

This value specifies the name of the existing plot: either ““ or an existing name.

INTEGER

register_id

This value specifies the vector register id (of location specified) containing data definition.

STRING

register_location[]

This value specifies the location of the data: either "C" = centroid, or "N" = nodal.

LOGICAL

range_flag

This value is set to TRUE to flag this tool to control the range info in the viewport.

LOGICAL

spectrum_flag

This value is set to TRUE to display the spectrum bar with this plot. Optional=TRUE.

Output:

INTEGER

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_tensor_post	(plot_name, register_id, register_location, range_flag, spectrum_flag)

Description:
This function posts a tensor plot tool definition to the current viewport.
Input:
STRING	plot_name[]	This value specifies the name of the existing plot: either ““ or an existing name.
INTEGER	register_id	This value specifies the tensor register id of the location specified containing the data definition.
STRING	register_location[]	This value specifies the location of the data: either "C" = centroid, or "N" = nodal.
LOGICAL	range_flag	This value is set to TRUE to flag this tool to control the range info in the viewport.
LOGICAL	spectrum_flag	This value is set to TRUE to display the spectrum bar with this plot. Optional=TRUE.
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.

Description:

This function posts a tensor plot tool definition to the current viewport.

Input:

STRING

plot_name[]

This value specifies the name of the existing plot: either ““ or an existing name.

INTEGER

register_id

This value specifies the tensor register id of the location specified containing the data definition.

STRING

register_location[]

This value specifies the location of the data: either "C" = centroid, or "N" = nodal.

LOGICAL

range_flag

This value is set to TRUE to flag this tool to control the range info in the viewport.

LOGICAL

spectrum_flag

This value is set to TRUE to display the spectrum bar with this plot. Optional=TRUE.

Output:

INTEGER

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_deformation_post	(plot_name, register_id)

Description:
This function posts a deformation plot tool definition to the current viewport.
Input:
STRING	plot_name[]	This value specifies the name of the existing plot: either ““ or an existing name.
INTEGER	register_id	This value specifies the vector register id of the location specified containing the data definition.
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.

Description:

This function posts a deformation plot tool definition to the current viewport.

Input:

STRING

plot_name[]

This value specifies the name of the existing plot: either ““ or an existing name.

INTEGER

register_id

This value specifies the vector register id of the location specified containing the data definition.

Output:

INTEGER

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_report_write	(report_name, register_id, register_type, register_location, output_method, file_name)

Description:
This function writes a report tool definition to the specified file.
Input:
STRING	report_name[]	This value specifies the name of the report: either ““ or an existing name.
INTEGER	register_id	This value specifies the nodal vector register id of the location specified containing the data definition.
STRING	register_type[]	This value specifies the register type. Valid values are: "S" = scalar, "V" = vector, and "T" = tensor.
STRING	register_location[]	This value specifies the location of the data: either "C" = centroid, "N" = nodal, "EN" = element nodal, or "EL" = element.
STRING	output_method[]	This value specifies the output method: either “STDOUT”, “NewFile”, “Overwrite”, or “Append”.
STRING	file_name[]	This value specifies the name of the file to which the report definition will be written.
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.

Description:

This function writes a report tool definition to the specified file.

Input:

STRING

report_name[]

This value specifies the name of the report: either ““ or an existing name.

INTEGER

register_id

This value specifies the nodal vector register id of the location specified containing the data definition.

STRING

register_type[]

This value specifies the register type. Valid values are: "S" = scalar, "V" = vector, and "T" = tensor.

STRING

register_location[]

This value specifies the location of the data: either "C" = centroid, "N" = nodal, "EN" = element nodal, or "EL" = element.

STRING

output_method[]

This value specifies the output method: either “STDOUT”, “NewFile”, “Overwrite”, or “Append”.

STRING

file_name[]

This value specifies the name of the file to which the report definition will be written.

Output:

INTEGER

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_graph_post	(plot_name, register_location, y_register_id, x_register_id, plot_title, append_flag)

Description:
This function posts a fringe plot tool definition to the current viewport.
Input:
STRING	plot_name[]	This value specifies the name of the plot: either ““ or an existing name.
STRING	register_location[]	This value specifies the data location: either "C" = centroid, "N" = nodal, "EN" = element nodal, or "EL" = element.
INTEGER	y_register_id	This value specifies the nodal vector register id of the location specified containing the data definition.
INTEGER	x_register_id	This value specifies the nodal vector register id of the location specified containing the data definition.
STRING	plot_title[]	This value specifies the plot title.
LOGICAL	append_flag	This value specifies, when set to TRUE, that curves are to be appended end to end. When this value is set to FALSE, curves will not be appended end to end.
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.

Description:

This function posts a fringe plot tool definition to the current viewport.

Input:

STRING

plot_name[]

This value specifies the name of the plot: either ““ or an existing name.

STRING

register_location[]

This value specifies the data location: either "C" = centroid, "N" = nodal, "EN" = element nodal, or "EL" = element.

INTEGER

y_register_id

This value specifies the nodal vector register id of the location specified containing the data definition.

INTEGER

x_register_id

This value specifies the nodal vector register id of the location specified containing the data definition.

STRING

plot_title[]

This value specifies the plot title.

LOGICAL

append_flag

This value specifies, when set to TRUE, that curves are to be appended end to end. When this value is set to FALSE, curves will not be appended end to end.

Output:

INTEGER

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_tool_unpost	(plot_type, plot_name)

Description:
This function unposts a plot tool from the current viewport.
Input:
STRING	plot_type[]	This value specifies the type of plot. See the remarks below for more information.
STRING	plot_name[]	This value specifies the name of the plot to unpost.
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.

Description:

This function unposts a plot tool from the current viewport.

Input:

STRING

plot_type[]

This value specifies the type of plot. See the remarks below for more information.

STRING

plot_name[]

This value specifies the name of the plot to unpost.

Output:

INTEGER

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”

“Fringe”

“2DContour”

“Vector”

“Tensor”

“Icon”

“3DContour”

“Deformation”

“Element”

“Cursor”

“Isosurface”

“Stream”

res_display_tool_exist	(plot_type, plot_name)

Description:
This function posts a fringe plot tool definition to the current viewport.
Input:
STRING	plot_type[]	This value specifies the type of plot. See the remarks below for more information.
STRING	plot_name[]	This value specifies the name of the plot to unpost.
Output:
LOGICAL	<Return Value>	This function returns TRUE if the plot tools exists, and FALSE otherwise.
Error Conditions:
None.

Description:

This function posts a fringe plot tool definition to the current viewport.

Input:

STRING

plot_type[]

This value specifies the type of plot. See the remarks below for more information.

STRING

plot_name[]

This value specifies the name of the plot to unpost.

Output:

LOGICAL

This function returns TRUE if the plot tools exists, and FALSE otherwise.

Error Conditions:

None.

“Fringe”	“2DContour”	“Vector”
“Tensor”	“Icon”	“3DContour”
“Deformation”	“Element”	“Cursor”
“Isosurface”	“Stream”

“Fringe”

“2DContour”

“Vector”

“Tensor”

“Icon”

“3DContour”

“Deformation”

“Element”

“Cursor”

“Isosurface”

“Stream”

res_display_tool_delete	(plot_type, plot_name)

Description:
This function deletes a plot tool definition from the database.
Input:
STRING	plot_type[]	This value specifies the type of plot. See the remarks below for more information.
STRING	plot_name[]	This value specifies the name of the plot to unpost.
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.

Description:

This function deletes a plot tool definition from the database.

Input:

STRING

plot_type[]

This value specifies the type of plot. See the remarks below for more information.

STRING

plot_name[]

This value specifies the name of the plot to unpost.

Output:

INTEGER

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”

“Fringe”

“2DContour”

“Vector”

“Tensor”

“Icon”

“3DContour”

“Deformation”

“Element”

“Cursor”

“Isosurface”

“Stream”