<Load>

Class defining a simulation load or boundary.

Remarks

The <load> element and its children allow you to configure the properties of a custom load and specify the IronPython functions that are invoked based on system and user-generated events.

Examples

Example 1: The following example defines a load applicable to edges.

            <load name="DemoLoad" version="1" caption="DemoLoad" icon="tload" color="#00FFFF">
              <callbacks>
                <getnodalvaluesfordisplay>NodeValues</getnodalvaluesfordisplay>
              </callbacks>
              <property name="Geometry" caption="Geometry" control="scoping">
                <attributes selection_filter="edge" />
              </property>
            </load>
            

Table 57: 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

<GetCommands>

Callback that is invoked to collect all commands to add to the solver input file.

Callback

<GetNodalValuesForDisplay>

Callback that is invoked to get nodal values associated with the load.

Callback

<GetPostCommands>

Callback that is invoked to collect all "post" commands to add to the solver input file.

Callback

<GetPreCommands>

Callback that is invoked to collect all "pre" commands to add to the solver input file.

Callback

<GetSolveCommands>

Callback that is invoked to collect all "solve" commands to add to the solver input file.

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

<OnAfterGenerate>

Callback that is invoked after the generation is completed.

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

<OnDrawBodyViews>

Called to collect all commands to add to the solver input file.

Callback

<OnDuplicate>

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

Callback

<OnGenerate>

Callback that is invoked when the load object is generated.

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

<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

AffectsSolution=

Indicates whether the load object should affect the solution or not.

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

ClearDataOnPropertyChange=

Indicates whether the generated data should be cleared on property change.

Attribute

color=

Color of the scoped entities.

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

icon=

Icon for the object. (inherited from SimEntity)

Attribute

IsLoad=

Indicates whether the load object should be considered as a load boundary.

Attribute

IsSupport=

Indicates whether the load object should be considered as a support boundary.

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

name=

Name of the object. (inherited from SimEntity)

Attribute

unit=

Default unit used by the contour display.

Attribute

version=

Version of the object. (inherited from SimEntity)