DAResult class

This class provides access to the results objects, and enables the user to set the results that are to be displayed when the result object is selected. The DAResult is defined in the DAResults section of the XML definition file.

Table 106:  Members

Name Type Description
TreeNamestring Returns the user defined name of this result instance
XmlTypestring Returns the text string of the Type of this result instance; the Type is set in the user interface by a drop-down list (as defined in the XML definition file)
XmlSubTypestring Returns the text string of the Sub Type of this result instance; the Sub Type is set in the user interface by a drop-down list (as defined in the XML definition file)
DAResultSetCountint Total number of sets that are available for this result
CreateDAResultSet() DAResultSet class

Creates a new result set and returns it so that values can be defined within it

DisplayStyle and DisplayType will be read from values in the XML definition file, or if multiple DAResultSets are created, they’ll be read from the first set.

CreateDAResultSet(string DisplayStyle, string DisplayType) DAResultSet class

Creates a new result set and returns it so that values can be defined within it

overrides the DisplayStyle entered in the XML definition file for this result group. However, unlike the XML definition file setting, defining it here does not enable the option to choose the component in the user interface of the DA Result object. However, this option can be used to force the display to show either a Vector or Tensor result; 3 or 6 component values should be defined accordingly.

DisplayStyle strings should be set to one of the values listed for the DisplayStyle keyword in the DAResult section of the XML definition file.

DisplayType overrides the DisplayType entered in the XML definition file, and should be a valid DisplayType keyword in the DAResult section of the XML definition file.

DAResultSets() DAResultSet[] classReturns an array of DAResultSets classes from the DAResultSet collection for this DAResult
DAResultSet(int SetNumber) DAResultSet classReturns a single DAResultSet object for the given SetNumber. SetNumber is 1 based and incremented automatically with each set that is added.
AttributeCount()intTotal number of Attributes objects defined
Attributes() Attribute[] classArray of Attribute class objects; the Attribute collection for this DAResult as Attribute class type
Attribute(string XMLName) Attribute classAn Attribute class object of the name defined in the XML definition file, from the Attribute array
Attribute(int index) Attribute classAn Attribute class object at the index as defined in the AttributeIDs field in the XML definition file. Index is zero based.
DisplayStyle string Gets the type of display, as defined in the XML definition file, or as defined when creating a result set; Scalar, Vector, Tensor, or StrainTensor.
DisplayTypestringGets the type of display, as defined in the XML definition file or as defined when creating a result set; Elemental, Nodal, or ElementNodal.
DisplayUnitsstringGets or sets the DisplayUnits set programmatically. By default it’s obtained from the display units set via the XML definition file for this DAResult. If setting it, the string should be set to one of the values listed for DisplayUnits keyword in the DAResult section of the XML definition file.
IsUpToDateboolThis will return true if the DAResult is currently Up To Date, otherwise it will return false.


Note:  A DAResult that is currently Up To Date is in a read-only state, and therefore its properties and results can not be modified. In order to modify the DAResult, you will need to clear it via the User Interface before solving or evaluating.



Release 18.2 - © ANSYS, Inc. All rights reserved.