PCL Reference Manual > Results Postprocessing Functions > Plot Tool Creation and Modification Functions
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Plot Tool Creation and Modification Functions
This section describes the function used to create display tools in the database. The display tools that have been created in the database will exist until they are explicitly deleted with the appropriate function call. Most of the functions used to create display tools have counterparts that can be used to modify a display tool once it has been created. If the display tool that has been created is the default display tool or has an empty string or ““for its name attribute, the functions used to create the display tool can be used to modify it. The act of creating a display tool will not cause the display tool to be displayed. A separate call to a function that will post the display tool is required to make the display tool visible in a viewport.
Most display tools require that the entity types, targets and attributes be specified. Valid entity types on which to display plots are:
 
 
Freefaces
FreeEdges
 
AllFaces
AllEdges
 
Elements
Nodes
 
Corners
Isosurfaces
 
Streamlines
Path
The display tool target definition attributes are optional. The entities corresponding to the display tool entity type found in the current viewport will be used as the default target definition if the target definition is not defined. Valid target definitions on which plots can be displayed are:
 
 
Value
Description
 
 
 
 
NO
Nodes
 
EL
Elements
 
GR
Groups
 
PR
Properties
 
MA
Materials
 
ET
Element Types
 
IS
Isosurface
 
SL
Streamline
 
DF
Deformed
 
PP
Path Point
 
PC
Path Curve
 
PE
Path Edge
If specific deformation tools are targeted by a display tool, the display tool will be repeatedly displayed in the deformed state described by each of the specified posted deformation tools. Specific deformation tool targets are not required unless specific deformed states are to be used, and multiple deformed states are posted simultaneously in the same viewport. An input value to the function being called is used in most situations to control if a display tool is to be shown in a deformed, when set to TRUE, or undeformed, when set to FALSE, state.
The display tool display attributes are used to control the display settings associated with each tool type attribute. They are string values in the form keyword:value(s). If multiple values are used for a given keyword, each value is separated by a comma. Here are some definitions for common values used by multiple tool attribute keywords throughout the following PCL function definitions:
 
<onoff>
ON, OFF
 
<color>
Spectrum, Black, Red, Green, Yellow, Blue, Magenta, Cyan, White, Orange, LtOrange, DkGreen, LtGreen, DkBlue, LtBlue, DkMagenta, LtMagenta
 
<linestyle>
Solid, Dash, Dot, Cylinder
 
<percent>
0.0-1.0 (real)
 
<filltype>
None, Flat, Shade, Transparent=<percent>
 
<modelstyle>
Wireframe, FreeEdge, FreeFace, FlatFill, Shaded, Hidden Transparent=<percent>
 
<edgedef>
<color>, <linestyle>, width (integer 1-10)
 
<edgestyle>
<onoff>,[<edgedef>]
 
<scaledef>
ScreenConstant or ScreenRelative or ModelConstant or ModelRelative=<real value>
 
res_display_fringe_create
(plot_name, entity_type, ntargets, targets, nattribs, attributes, deformed_flag)
Description:
 
 
This function creates a fringe plot tool definition.
Input:
 
 
STRING
plot_name[]
This value specifies the name of the plot: either ““ or a unique name.
STRING
entity_type[]
This value specifies the entity type. Valid values are: “FreeFaces”, “AllFaces”, ”FreeEdges”, and ”AllEdges”.
INTEGER
ntargets
This value specifies the number of strings in the input value targets. If this value is set to 0, all the entities specified by the input value entity_type will be used.
STRING
targets[](ntargets)
This value specifies the target specifications. See the remarks below for more information.
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes.
STRING
attributes[](nattribs)
This value specifies the attributes. See the remarks below for more information.
LOGICAL
deformed_flag
This value is set to TRUE to enable displaying in the deformed shape if deformation tools are posted
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.
Remarks:
FringeStyle values can be “Discrete”, “Continuous”, or “ElemFill”.
Shade filltype values can be “None”, “Flat”, or “Shaded”.
ElemEdge edge styles can be “None”, “FreeEdge”, or “ElemEdge”. The color is any valid color name. The style can be “Solid”, “Dash”, or “Dot”. The thickness can be any integer between 1 and 10.
Filter methods are None, Minimum=value, Maximum=value, Range=value,value, Exclude=value,value.
LabelStyle display includes “Fixed”, “Integer”, or “Exponential”. The fontsize is any valid font size as an integer value. The color is any valid color name. The digits is the number of significant digits to retain.
The input value targets can be set as follows. The keyword should be separated from the values by a colon or “:”
 
 
Keyword
Value
Description
 
 
 
 
 
NO
list
is for a node list.
 
EL
list
is for an element list.
 
GR
name
is for a group name.
 
PR
name
for a specific property set.
 
MA
name
for a material.
 
ET
type
for element type (point,beam, tri, ...). NULL if ntargets=0.
The input value attributes can be set as follows. The keyword should be separated from the values by a colon or “:”
 
 
Keyword
Values
 
Range
<name>
 
RangeOverwrite
<onoff>
 
FringeStyle
<style>
 
Shade
<filltype>
 
ElemEdge
<edgestyle,color,style,width>
 
Shrink
<percent>
 
TitleDisplay
<onoff>
 
MinMaxDisplay
<onoff>
 
ValueDisplay
<onoff>
 
Filter
<method>
 
ScaleFactor
<value>
 
LabelStyle
<display,fontsize,color,digits>
Example:
Please see res_display_fringe_create.
 
res_display_fringe_modify
(plot_name, new_name, entity_type, ntargets, targets, nattribs, attributes, deformed_flag)
Description:
 
 
This function modifies a fringe plot tool definition.
Input:
 
 
STRING
plot_name[]
This value specifies the name of the plot: either ““ or a unique name.
STRING
new_name[]
This value specifies a new name to give the plot.
STRING
entity_type[]
This value specifies the entity type. Valid values are: “FreeFaces”, “AllFaces”, ”FreeEdges”, and ”AllEdges”.
INTEGER
ntargets
This value specifies the number of strings in the input value targets. If this value is set to 0, all the entities specified by the input value entity_type will be used.
STRING
targets[](ntargets)
This value specifies the target specifications. See the res_display_fringe_create() function for more information.
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes.
STRING
attributes[](nattribs)
This value specifies the attributes. See the remarks below for more information.
LOGICAL
deformed_flag
This value is set to TRUE to enable displaying in the deformed shape if deformation tools are posted
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 (Ch. 11) for information on any error values returned by this function.
Remarks:
See the corresponding create function res_display_fringe_create().
Example:
Please see res_display_fringe_modify.
 
res_display_vector_create
(plot_name, entity_type, ntargets, targets, nattribs, attributes, deformed_flag)
Description:
 
 
This function creates a vector plot tool definition.
Input:
 
 
STRING
plot_name[]
This value specifies the name of the plot: either ““ or a unique name.
STRING
entity_type[]
This value specifies the entity type. Valid values are: “Nodes”, “Elements”, “Corners”, “FreeFace”, and “FreeEdge”.
INTEGER
ntargets
This value specifies the number of strings in the input value targets. If this value is set to 0, all the entities specified by the input value entity_type will be used.
STRING
targets[](ntargets)
This value specifies the target specifications.
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes. This value should be set to 16.
STRING
attributes[](nattribs)
This value specifies the attributes for the vector tool. See the remarks below for more information.
LOGICAL
deformed_flag
This value is set to TRUE to enable displaying in the deformed shape if deformation tools are posted
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.
Remarks:
VectorDisplay values can be “Resultant” or “Component”.
VectorColors, one for each component or resultant, can be any valid color name or can be mapped to the Spectrum. Use the keywork Spectrum.
VectorScale keywords can be ScreenConstant=percent, ScreenRelative=percent, ModelConstant=percent, ModelRelative=percent.
VectorAttachment can be “Head”, “Tail”, or “Middle”.
HeadStyle can be “None”, “Single”,or “Double”.
VectorStyle can be “Solid” or “Cylinder.”
Filter methods are None, Minimum=value, Maximum=value, Range=value,value, Exclude=value,value.
LabelStyle display includes “Fixed”, “Integer”, or “Exponential”. The fontsize is any valid font size as an integer value. The color is any valid color name. The digits is the number of significant digits to retain.
The input value targets can make use of the following keywords and values. The keyword and the values should be separated by a colon or “:
 
Keyword
Value
Description
 
NO
list
is for a node list
 
EL
list
is for an element list
 
GR
name
is for a group name
 
PR
name
is for a specific property set
 
MA
name
is for a material
 
ET
type
is for element type (point,beam, tri, ...). NULL if ntargets=0.
The input value attributes can make use of the following keywords and values. The keyword and the values should be separated by a colon or “:”
 
Keyword
Values
 
 
 
 
Range
<name>
 
RangeOverwrite
<onoff>
 
VectorDisplay
<display>
 
VectorComps
<onoff>[,<onoff>, <onoff>]
 
VectorColors
<color>[,<color>,<color>]
 
VectorScale
<scaledef>
 
VectorAttachment
<location>
 
HeadStyle
<style>
 
VectorStyle
<style>
 
TailDisplay
<onoff>
 
TitleDisplay
<onoff>
 
MinMaxDisplay
<onoff>
 
LabelStyle
<display,fontsize,color,digits>
 
ValueDisplay
<onoff>
 
Filter
<method>
 
ScaleFactor
<value>
Example:
Please see res_display_vector_create.
 
res_display_vector_modify
(plot_name, new_name, entity_type, ntargets, targets, nattribs, attributes, deformed_flag)
Description:
 
 
This function modifies a vector plot tool definition.
Input:
 
 
STRING
plot_name[]
This value specifies the name of the plot: either ““ or a unique name.
STRING
new_name[]
This value specifies a new name to give the plot.
STRING
entity_type[]
This value specifies the entity type. Valid values are: “Nodes”, “Elements”, “Corners”, “FreeFace”, and “FreeEdge”.
INTEGER
ntargets
This value specifies the number of strings in the input value targets. If this value is set to 0, all the entities specified by the input value entity_type will be used.
STRING
targets[](ntargets)
This value specifies the target specifications. See the res_display_vector_create() function for more information.
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes.
STRING
attributes[](nattribs)
This value specifies the attributes. See the res_display_vector_create() function for more information.
LOGICAL
deformed_flag
This value is set to TRUE to enable displaying in the deformed shape if deformation tools are posted
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 (Ch. 11) for information on any error values returned by this function.
Remarks:
See the corresponding create function res_display_vector_create().
Example:
Please see res_display_vector_modify.
 
res_display_tensor_create
(plot_name, entity_type, ntargets, targets, nattribs, attributes, deformed_flag)
Description:
 
 
This function creates a tensor plot tool definition.
Input:
 
 
STRING
plot_name[]
This value specifies the name of the plot: either ““ or a unique name.
STRING
entity_type[]
This value specifies the entity type. Valid values are: “Nodes”, “Elements”, “Corners”, “FreeFace”, and “FreeEdge”.
INTEGER
ntargets
This value specifies the number of strings in the input value targets. If this value is set to 0, all the entities specified by the input value entity_type will be used.
STRING
targets[](ntargets)
This value specifies the target specifications. See the remarks below for more information.
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes. This value should be set to 17.
STRING
attributes[](nattribs)
This value specifies the attributes. See the remarks below for more information.
LOGICAL
deformed_flag
This value is set to TRUE to enable displaying in the deformed shape if deformation tools are posted
Output:
 
 
INTEGER
<Return Value>
his 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.
Remarks:
TensorDisplay values can be “Component”, “Principal”, “2D_Component”, “2D_Principal”.
Tensor colors, one for each component or principal, can be any valid color name or can be mapped to the Spectrum. Use the keywork Spectrum.
VectorScale and BoxScale keywords can be ScreenConstant=percent, ScreenRelative=percent, ModelConstant=percent, ModelRelative=percent.
VectorAttachment can be “Head”, “Tail”, or “Middle”.
HeadStyle can be “None”,or “Single”.
VectorStyle can be “Solid” or “Cylinder.”
BoxStyle can be “Wireframe”, “Filled”, or “None”.
BoxColor can be any valid color name.
Filter methods are None, Minimum=value, Maximum=value, Range=value,value, Exclude=value,value.
LabelStyle display includes “Fixed”, “Integer”, or “Exponential”. The fontsize is any valid font size as an integer value. The color is any valid color name. The digits is the number of significant digits to retain.
The input value target can make use of the following values. The keyword should be separated from the value by a colon or “:”
 
 
Keyword
Value
Description
 
 
 
 
 
NO
list
is for a node list
 
EL
list
is for an element list
 
GR
name
is for a group name
 
PR
name
for a specific property set
 
MA
name
for a material
 
ET
type
for element type (point,beam, tri, ...).
 
IS
name
for an Isosurface.
 
SL
name
for a Streamline.
 
DF
name
for specific Deformation tool.
The input value attributes can make use of the following keywords and values. The keyword should be separated from the value by a colon or “:”
 
 
Keyword
Values
 
 
 
 
Range
<name>
 
RangeOverwrite
<onoff>
 
TensorDisplay
<display>
 
TensorComps
<onoff>,<onoff>, <onoff>,<onoff>,<onoff>, <onoff>
 
TensorColors
<color>[,<color>,<color>]
 
VectorScale
<scaledef>
 
VectorAttachment
<location>
 
HeadStyle
<style>
 
VectorStyle
<style>
 
TailDisplay
<onoff>
 
TitleDisplay
<onoff>
 
MinMaxDisplay
<onoff>
 
LabelStyle
<display,fontsize,color,digits>
 
ValueDisplay
<onoff>
 
Filter
<method>
 
ScaleFactor
<value>
Example:
Please see res_display_tensor_create.
 
res_display_tensor_modify
(plot_name, new_name, entity_type, ntargets, targets, nattribs, attributes, deformed_flag)
Description:
 
 
This function modifies a tensor plot tool definition.
Input:
 
 
STRING
plot_name[]
This value specifies the name of the plot: either ““ or a unique name.
STRING
new_name[]
This value specifies a new name to give the plot.
STRING
entity_type[]
This value specifies the entity type. Valid values are: “Nodes”, “Elements”, “Corners”, “FreeFace”, and “FreeEdge”.
INTEGER
ntargets
This value specifies the number of strings in the input value targets. If this value is set to 0, all the entities specified by the input value entity_type will be used.
STRING
targets[](ntargets)
This value specifies the target specifications. See the res_display_tensor_create() function for more information.
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes.
STRING
attributes[](nattribs)
This value specifies the attributes. See the res_display_tensor_create() function for more information.
LOGICAL
deformed_flag
This value is set to TRUE to enable displaying in the deformed shape if deformation tools are posted
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.
Remarks:
See the corresponding create function res_display_tensor_create().
Example:
Please see res_display_tensor_modify.
 
res_display_report_create
(report_name, entity_type, ntargets, targets, nattribs, attributes)
Description:
 
 
This function creates a report tool definition.
Input:
 
 
STRING
report_name[]
This value specifies the name of the report: either ““ or a unique name.
STRING
entity_type[]
This value specifies the entity type. Valid values are: “Nodes”, and “Elements”.
INTEGER
ntargets
This value specifies the number of strings in the input value targets. If this value is set to 0, all the entities specified by the input value entity_type will be used.
STRING
targets[](ntargets)
This value specifies the target specifications. See the remarks below for more information.
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes.
STRING
attributes[](nattribs)
This value specifies the attributes. See the remarks below for more information.
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.
Remarks:
ReportType is either “Full” or “Summary”.
ReportPageAlignment can be “Center”, “Left”, or “Right”.
EntitySort can be “Load Case”, or “Entity”.
ValueSort needs the column number to sort on, the order, either Ascending or Descending, and the method to sort by, either Algebraic or Absolute value.
Filter methods are None, Minimum=value, Maximum=value, Range=value,value, Exclude=value,value.
The input value attributes can make use the following values. The keyword should be separated from the value by a colon or “:”
 
 
Keyword
Value
Description
 
 
 
 
 
NO
list
is for a node list.
 
EL
list
is for an element list.
 
GR
name
is for a group name.
 
PR
name
for a specific property set.
 
MA
name
for a material.
 
ET
type
for element type (point,beam, tri, ...).
The input value attributes can make use the following values. The keyword should be separated from the value by a colon or “:”
 
 
Keyword
Values
 
 
 
 
ReportType
<type>
 
ReportTitle
<title> - repeat for all title lines
 
ReportHeader
<text> - repeat for all header lines
 
ReportFooter
<text> - repeat for all footer lines
 
ReportPage
height=<lines>, width=<characters>,TopMargin=<line>,LeftMargin=<characters>,BottomMargin=<characters>
 
ReportPagination
<onoff>
 
ReprotPageNumber
<startnumber>
 
ReportPageAlignment
<location>
 
ReportColumn
<column#>, <Heading>, <value keyword>, <format> - repeat for each column
 
EntitySort
<method>
 
ValueSort
<column>,<order>,<method>
 
Filter
<method>
 
ScaleFactor
<value>
The attributes will define the output. There can be multiple ReportHeader and ReportFooter definitions. They will be used in order as written. The following special strings can be inserted in Header and Footer definitions
 
 
$DATE
The current date will be inserted
 
$PAGE
The current report page# will be inserted
 
$DATA_TITLE
The register title will be inserted
 
$PRODUCT
The Patran product/version will be inserted
 
$DB_NAME
The name of the current database will be inserted
 
$JOB_NAME
The name of the analysis job will be inserted
 
$CODE_NAME
The name of the analysis code will be inserted
The report column value keywords are scalar derivation strings defined for the registers as well as the following values:
 
 
ID
The entity identifier
 
XLOC
The X location of the node or element data position
 
YLOC
The Y location of the node or element data position
 
ZLOC
The Z location of the node or element data position
 
MID
The associated element material identifier
 
MATNAME
The associated element material name
 
PID
The associated element property identifier
 
PROPNAME
The associated element property name
 
ETYPE
The associated element type name
 
LCID
The associated Loadcase identifier (very useful for minmax of LC list)
 
SCID
The associated Subcase identifier (very useful for minmax of list)
 
LPID
The associated Layer identifier
Example:
Please see res_display_report_create.
 
res_display_report_modify
(report_name, new_name, entity_type, ntargets, targets, nattribs, attributes)
Description:
 
 
This function modifies a report tool definition.
Input:
 
 
STRING
report_name[]
This value specifies the name of the report: either ““ or a unique name.
STRING
new_name[]
This value specifies a new name to give the report.
STRING
entity_type[]
This value specifies the entity type. Valid values are: “Nodes”, or “Elements”.
INTEGER
ntargets
This value specifies the number of strings in the input value targets. If this value is set to 0, all the entities specified by the input value entity_type will be used.
STRING
targets[](ntargets)
This value specifies the target specifications. See the res_display_report_create() function description for more information.
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes.
STRING
attributes[](nattribs)
This value specifies the attributes. See the res_display_report_create() function description for more information.
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.
Remarks:
See the corresponding create function res_display_report_create.
Example:
Please see res_display_report_modify.
 
res_display_graph_create
(plot_name, graph_type, entity_type, ntargets, targets, nattribs, attributes)
Description:
 
 
This function creates a graph plot tool definition.
Input:
 
 
STRING
plot_name[]
This value specifies the name of the plot: either ““ or a unique name.
STRING
graph_type[]
This value specifies the X vs Y graph type: “GVGV” = global variable vs. global variable, “DataGV” = result vs. global variable, “DataData” = results vs. result, “DataLocation” = result vs. coordinate location, and “DataDistance” = result vs. curve or beam distance.
STRING
entity_type[]
This value specifies the entity type. Valid values are: “Nodes”, “Elements”, and “Path”.
INTEGER
ntargets
This value specifies the number of strings in the input value targets. If this value is set to 0, all the entities specified by the input value entity_type will be used.
STRING
targets[](ntargets)
This value specifies the target specifications. See the remarks below for more information.
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes.
STRING
attributes[](nattribs)
This value specifies the attributes. See the remarks below for more information.
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.
Remarks:
CurveFitMethod is either “Linear”, “Scatter”, “Spline”, or “LeastSquares”.
CurveStyle is either “Solid”, “Dash”, “Dot”, or “DotDash”
xAxisScale and yAxisScale is either “Linear” or “Log”.
xAxisLabelFormat and yAxisLabelFormat display includes “Fixed”, “Integer”, or “Exponential”. The fontsize is any valid font size as an integer value. The color is any valid color name. The digits is the number of significant digits to retain.
The input value targets can make use the following values. The keyword should be separated from the value by a colon or “:”
 
 
Keyword
Value
Description
 
 
 
 
 
NO
list
is for a node list.
 
EL
list
is for an element list.
 
GR
name
is for a group name.
 
PR
name
is for a specific property set.
 
MA
name
is for a material.
 
ET
type
is for element type (point,beam, tri, ...).
 
PP
list
is for an points on a path.
 
PC
list
is for a path defined by curves.
 
PE
list
is for path along element edges.
The input value attributes can make use the following values. The keyword should be separated from the value by a colon or “:”
 
Keyword
Values
 
 
 
 
curveFitMethod
<method>
 
curveStyle
<style>
 
symbolDisplay
<onoff.>
 
xAxisLabelDisplay
<onoff>
 
xAxisLabel
<text>
 
xAxisScale
<scale>
 
xAxisLabelFormat
<format>, <number>, < color>, <digits>
 
yAxisLabelDisplay
<onoff>
 
yAxisLabel
<text>
 
yAxisScale
<scale>
 
yAxisLabelFormat
<format>, <number>, < color>, <digits>
 
ScaleFactor
<factor>
Example:
Please see res_display_graph_create.
 
res_display_graph_modify
(plot_name, new_name, graph_type, entity_type, ntargets, targets, nattribs, attributes)
Description:
 
 
This function modifies a graph plot tool definition.
Input:
 
 
STRING
plot_name[]
This value specifies the name of the plot: either ““ or a unique name.
STRING
new_name[]
This value specifies a new name to give the plot.
STRING
graph_type[]
This value specifies the X vs Y graph type: “GVGV” = global variable vs. global variable, “DataGV” = result vs. global variable, “DataData” = results vs. result, “DataLocation” = result vs. coordinate location, and “DataDistance” = result vs. curve or beam distance.
STRING
entity_type[]
This value specifies the entity type. Valid values are: “Nodes”, “Elements”, and “Path”.
INTEGER
ntargets
This value specifies the number of strings in the input value targets. If this value is set to 0, all the entities specified by the input value entity_type will be used.
STRING
targets[](ntargets)
This value specifies the target specifications. See the res_display_graph_create() function description for more information.
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes.
STRING
attributes[](nattribs)
This value specifies the attributes. See the res_display_graph_create() function description for more information.
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.
Remarks:
See the corresponding create function res_display_graph_create().
Example:
Please see res_display_graph_modify.
 
res_display_deformation_create
(plot_name, entity_type, ntargets, targets, nattribs, attributes)
Description:
 
 
This function creates a deformation plot tool definition.
Input:
 
 
STRING
plot_name[]
This value specifies the name of the plot: either ““ or a unique name.
STRING
entity_type[]
This value specifies the entity type. Valid values are: “Nodes”, and “Elements”.
INTEGER
ntargets
This value specifies the number of strings in the input value targets. If this value is set to 0, all the entities specified by the input value entity_type will be used.
STRING
targets[](ntargets)
This value specifies the target specifications. Valid values are: “NO” = list is for a node list, “EL” = list is for an element list, “GR” = name is for a group name, “PR” = name for a specific property set, “MA” = name for a material, and “ET” = type for element type (point,beam, tri, ...).
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes.
STRING
attributes[](nattribs)
This value specifies the attributes. See the remarks below for more information.
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.
 
 
Remarks:
DeformedStyle keywords consist of any valid color, a line style of “Solid”, “Dash” or “Dot”, and a thickness value between 1 and 10 and a render style of either “Wireframe”, “Shaded”, “HiddenLine”, or “FreeEdge”. The same is true for UndeformedStyle.
The DeformedScale keyword is either True or Model=percentage.
LabelStyle display includes “Fixed”, “Integer”, or ”Exponential”. The fontsize is any valid font size as an integer value. The color is any valid color name. The digits is the number of significant digits to retain.
The input value attributes can make use the following values. The keyword should be separated from the value by a colon or “:
 
Keyword
Values
 
 
 
 
DeformedStyle
<color>,<style>,<thickness>,<render>
 
DeformedScale
<method>[=factor]
 
UndeformedStyle
<onoff>,<color>,<style>,<thickness>,<render>
 
TitleDisplay:
<onoff>
 
MinMaxDisplay
<onoff>
 
ScaleFactor
<value>
 
LabelStyle
<display,fontsize,color,digits>
Example:
Please see res_display_deformation_create.
 
res_display_deformation_modify
(plot_name, new_name, entity_type, ntargets, targets, nattribs, attributes)
Description:
 
 
This function specifies a fringe plot tool definition.
Input:
 
 
STRING
plot_name[]
This value specifies the name of the plot: either ““ or a unique name.
STRING
new_name[]
This value specifies a new name to give the plot.
STRING
entity_type[]
This value specifies the entity type. Valid values are: “Nodes”, or “Elements”.
INTEGER
ntargets
This value specifies the number of strings in the input value targets. If this value is set to 0, all the entities specified by the input value entity_type will be used.
STRING
targets[](ntargets)
This value specifies the target specifications. See the res_display_deformation_create() function for more information.
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes.
STRING
attributes[](nattribs)
This value specifies the attributes. See the res_display_deformation_create() function for more information.
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.
Remarks:
None.
Example:
Please see res_display_deformation_modify.