<Result>

Class defining a result.

Remarks

None.

Examples

None.

Table 79: XML Tag Listing

Callback

<Action>

No details provided.

Tag

<Attributes>

No details provided. (inherited from SimEntity)

Tag

<Callbacks>

No details provided. (inherited from SimEntity)

Callback

<CanAdd>

Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)

Callback

<CanCreate>

Callback that is invoked to determine whether the object can be created via the Object Creation API. (inherited from SimEntity)

Callback

<CanDuplicate>

Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)

Callback

<CanRemove>

Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)

Callback

<Evaluate>

Callback that is invoked when the step described by stepInfo is evaluated. Warning! This is invoked as part of the Mechanical evaluation pipeline. General scripting operations (such as adding new objects, modifying legends, etc.) may not be safe to do within this callback.

Callback

<GetFieldCount>

Callback that is invoked to get the number of fields (ie components) for a given element or node ID.

Callback

<GetValue>

Callback that is invoked to get the values associated to a node or an element given by its ID.

Callback

<IsValid>

Callback that is invoked to determine if the object is valid. (inherited from SimEntity)

Callback

<OnAdd>

Callback that is invoked when the object is newly added. (inherited from SimEntity)

Callback

<OnAfterGeometryUpdate>

Callback that is invoked when the geometry has been updated. (inherited from SimEntity)

Callback

<OnBodySuppressStateChange>

Callback that is invoked when the body suppress state changse. (inherited from SimEntity)

Callback

<OnClearData>

Callback that is invoked when object data are cleared. (inherited from SimEntity)

Callback

<OnDuplicate>

Callback that is invoked when the object is duplicated. (inherited from SimEntity)

Callback

<OnEndEval>

Callback that is invoked at the end of the evaluation process for a given step. Warning! This is invoked as part of the Mechanical evaluation pipeline. General scripting operations (such as adding new objects, modifying legends, etc.) may not be safe to do within this callback.

Callback

<OnEndPost>

Callback that is invoked at the end of the post process. Warning! This is invoked as part of the Mechanical evaluation pipeline. General scripting operations (such as adding new objects, modifying legends, etc.) may not be safe to do within this callback.

Callback

<OnGenerateData>

Callback that is invoked when object data are generated. (inherited from SimEntity)

Callback

<OnHide>

Callback that is invoked when the object is hidden. (inherited from SimEntity)

Callback

<OnInit>

Callback that is invoked when the object is initialized. (inherited from SimEntity)

Callback

<OnMigrate>

Callback that is invoked when the object version has been changed. (inherited from SimEntity)

Callback

<OnReady>

Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from SimEntity) (inherited from SimEntity)

Callback

<OnRemove>

Callback that is invoked when the object is removed. (inherited from SimEntity)

Callback

<OnShow>

Callback that is invoked when the object is shown. (inherited from SimEntity)

Callback

<OnStartEval>

Callback that is invoked when the evaluation process for a given step starts. Warning! This is invoked as part of the Mechanical evaluation pipeline. General scripting operations (such as adding new objects, modifying legends, etc.) may not be safe to do within this callback.

Callback

<OnStartPost>

Callback that is invoked when the post process starts. Warning! This is invoked as part of the Mechanical evaluation pipeline. General scripting operations (such as adding new objects, modifying legends, etc.) may not be safe to do within this callback.

Callback

<OnSuppress>

Callback that is invoked when the object is suppressed. (inherited from SimEntity)

Callback

<OnUnsuppress>

Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)

Tag

<Property>

No details provided. (inherited from SimEntity)

Attribute

averaging=

Averaging of the result.

Attribute

BeginGroup=

Indicates whether the load object will have a separator before it when shown in the context menu. (inherited from SimEntity)

Attribute

caption=

Caption of the object. (inherited from SimEntity)

Attribute

class=

Class name of the controller of the object. (inherited from SimEntity)

Attribute

ContextGroup=

Indicates which group the load will be shown in the context menu. (inherited from SimEntity)

Attribute

contextual=

Indicates whether the object has to be displayed in the contextual menu. (inherited from SimEntity)

Attribute

hasimaginary=

Indicates whether the result supports imaginary values.

Attribute

icon=

Icon for the object. (inherited from SimEntity)

Attribute

iscontactresult=

Indicates whether the result object should be considered as a contact result or not.

Attribute

LazyActivateSelectProperties=

Determines when onActivate callback is called for the properties. (inherited from SimEntity)

Attribute

localize=

Indicates whether the caption and value string need to be localized by the application. (inherited from SimEntity)

Attribute

location=

Location of the result.

Attribute

name=

Name of the object. (inherited from SimEntity)

Attribute

timehistory=

Indicates whether the time history has to be calculated.

Attribute

type=

Type of the result.

Attribute

unit=

Unit used by the contour display.

Attribute

version=

Version of the object. (inherited from SimEntity)