Tag: Result

Simulation Result.

Tree

Mandatory Attributes

Name Description Type Allowed Values
location Location of the result. ResultLocationEnum node, element, elemnode
name Name of the object. String
type Type of the result. ResultTypeEnum Scalar, Vector
version Version of the object. Int32

Optional Attributes

Name Description Type Default Value Allowed Values
averaging Averaging of the result. ResultAveragingEnum Unaverage Unaverage, Average, NodalDifference, NodalFraction, ElementalDifference, ElementalFraction, ElementalMean
BeginGroup Indicates whether the load object will have a separator before it when shown in the context menu. Boolean False True, False
caption Caption of the object. String
class Class name of the controller of the object. String
ContextGroup Indicates which group the load will be shown in the context menu. String
contextual Indicates whether the object has to be displayed in the contextual menu. Boolean True True, False
hasimaginary Indicates whether the result supports imaginary values. Boolean True True, False
icon Icon for the object. String
LazyActivateSelectProperties Determines when onActivate callback is called for the properties. Boolean False True, False
localize Indicates whether the caption and value string need to be localized by the application. Boolean False True, False
timehistory Indicates whether the time history has to be calculated. Boolean True True, False
unit Unit used by the contour display. String Dimensionless

Callbacks

Name Description
CanAdd(IDataModelObject, String) Callback that is invoked to determine whether the object can be added.
CanCreate Callback that is invoked to determine whether the object can be created via the Object Creation API.
CanDuplicate(IUserObject, IDataModelObject) Callback that is invoked to determine if the object can be duplicated.
CanRemove(IUserObject) Callback that is invoked to determine if the object can be removed.
Evaluate(IUserResult, IStepInfo, IResultCollector) 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.
GetFieldCount(IUserResult, Int32) Callback that is invoked to get the number of fields (ie components) for a given element or node ID.
GetValue(IUserResult, Int32) Callback that is invoked to get the values associated to a node or an element given by its ID.
IsValid(IUserObject) Callback that is invoked to determine if the object is valid.
OnAdd(IUserObject) Callback that is invoked when the object is newly added.
OnClearData(IUserObject) Callback that is invoked when object data are cleared.
OnDuplicate(IUserObject) Callback that is invoked when the object is duplicated.
OnEndEval(IUserResult, Int32) 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.
OnHide(IUserObject) Callback that is invoked when the object is hidden.
OnInit(IUserObject) Callback that is invoked when the object is initialized.
OnMigrate(IUserObject, IUserObject) Callback that is invoked when the object version has been changed.
OnRemove(IUserObject) Callback that is invoked when the object is removed.
OnShow(IUserObject) Callback that is invoked when the object is shown.
OnStartEval(IUserResult, Int32) 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.
OnSuppress(IUserObject) Callback that is invoked when the object is suppressed.
OnUnsuppress(IUserObject) Callback that is invoked when the object is unsuppressed.