ANSYS ACT XML Reference Guide

ANSYS, Inc. Release 18.2

Southpointe August 2017
2600 ANSYS Drive
Canonsburg, PA 15317 ANSYS, Inc. and
[email protected] ANSYS Europe,
Ltd. are UL
http://www.ansys.com registered ISO
(T) 724-746-3304 9001: 2008
(F) 724-514-9494 companies.
Copyright and Trademark Information

© 2017 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.

ANSYS, ANSYS Workbench, AUTODYN, CFX, FLUENT and any and all ANSYS, Inc. brand, product, service and feature
names, logos and slogans are registered trademarks or trademarks of ANSYS, Inc. or its subsidiaries located in the
United States or other countries. ICEM CFD is a trademark used by ANSYS, Inc. under license. CFX is a trademark
of Sony Corporation in Japan. All other brand, product, service and feature names or trademarks are the property
of their respective owners. FLEXlm and FLEXnet are trademarks of Flexera Software LLC.

Disclaimer Notice

THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFID-
ENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products
and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement
that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products
and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions
of that software license agreement.

ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2008 companies.

U.S. Government Rights

For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use,
duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc.
software license agreement and FAR 12.212 (for non-DOD licenses).

Third-Party Software

See the legal information in the product help files for the complete Legal Notice for ANSYS proprietary software
and third-party software. If you are unable to access the Legal Notice, contact ANSYS, Inc.

Published in the U.S.A.

Table of Contents
I. ACT XML Reference .................................................................................................................................. 1
ACT XML Tags ........................................................................................................................................ 3
<action> .......................................................................................................................................... 6
<ConnectTo> ............................................................................................................................. 6
<InputValue> ............................................................................................................................. 7
Name= ....................................................................................................................................... 8
Type= ......................................................................................................................................... 9
<ActionCallback> ............................................................................................................................. 9
caninterrupt= ........................................................................................................................... 10
caption= .................................................................................................................................. 11
icon= ....................................................................................................................................... 12
name= ..................................................................................................................................... 13
<actions> ....................................................................................................................................... 13
<Action> .................................................................................................................................. 14
<Operator> .............................................................................................................................. 15
MainAction= ............................................................................................................................ 15
Name= ..................................................................................................................................... 16
<ActionsView> ............................................................................................................................... 17
<StandardAction> .................................................................................................................... 17
component= ............................................................................................................................ 18
name= ..................................................................................................................................... 19
<Application> ................................................................................................................................ 20
<actions> ................................................................................................................................. 21
<ApplicationWorkflow> ............................................................................................................ 22
<Callbacks> .............................................................................................................................. 22
<canstart> ............................................................................................................................... 23
<DataModel> ........................................................................................................................... 24
<Description> .......................................................................................................................... 25
<OnApplicationFinished> ......................................................................................................... 25
<OnApplicationStarted> .......................................................................................................... 26
<OnBeforeProjectClosed> ........................................................................................................ 27
<OnBeforeSave> ...................................................................................................................... 28
<OnProjectLoaded> ................................................................................................................. 29
<Panel> ................................................................................................................................... 30
<Presentations> ....................................................................................................................... 31
<ProductDataModelConverter> ................................................................................................ 32
caption= .................................................................................................................................. 32
class= ....................................................................................................................................... 33
context= .................................................................................................................................. 34
icon= ....................................................................................................................................... 35
name= ..................................................................................................................................... 36
projectExtName= ..................................................................................................................... 37
version= ................................................................................................................................... 38
WorkflowToStart= ..................................................................................................................... 38
<argument> ................................................................................................................................... 39
name= ..................................................................................................................................... 40
separator= ................................................................................................................................ 41
value= ...................................................................................................................................... 42
<assembly> .................................................................................................................................... 42
context= .................................................................................................................................. 43

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. iii
ACT XML Reference Guide

namespace= ............................................................................................................................. 44
src= .......................................................................................................................................... 45
<attributes> ................................................................................................................................... 46
<BrowserView> .............................................................................................................................. 46
name= ..................................................................................................................................... 46
<Callback> ..................................................................................................................................... 47
caninterrupt= ........................................................................................................................... 47
<CallbackGetCommands> .............................................................................................................. 48
caninterrupt= ........................................................................................................................... 49
location= .................................................................................................................................. 49
order= ...................................................................................................................................... 50
<CallbackGetPostPreSolveCommands> .......................................................................................... 51
caninterrupt= ........................................................................................................................... 52
order= ...................................................................................................................................... 53
timedependent= ...................................................................................................................... 54
<CallbackOnActiveObjectChange> ................................................................................................. 54
caninterrupt= ........................................................................................................................... 55
name= ..................................................................................................................................... 56
type= ....................................................................................................................................... 57
<Callbacks> .................................................................................................................................... 57
<Callback> ............................................................................................................................... 58
<Component> ............................................................................................................................... 58
<Attributes> ............................................................................................................................. 59
BottomAttachment= ................................................................................................................ 60
BottomOffset= ......................................................................................................................... 61
ComponentType= .................................................................................................................... 62
CustomCSSFile= ....................................................................................................................... 63
CustomHTMLFile= .................................................................................................................... 64
CustomJSFile= .......................................................................................................................... 64
Height= .................................................................................................................................... 65
HeightType= ............................................................................................................................ 66
LeftAttachment= ...................................................................................................................... 67
LeftOffset= ............................................................................................................................... 68
MaxHeight= ............................................................................................................................. 69
MaxWidth= .............................................................................................................................. 70
MinHeight= .............................................................................................................................. 71
MinWidth= ............................................................................................................................... 72
name= ..................................................................................................................................... 73
RightAttachment= .................................................................................................................... 73
RightOffset= ............................................................................................................................. 74
TopAttachment= ...................................................................................................................... 75
TopOffset= ............................................................................................................................... 76
visible= .................................................................................................................................... 77
Width= ..................................................................................................................................... 78
WidthType= ............................................................................................................................. 79
<ComponentData> ........................................................................................................................ 80
component= ............................................................................................................................ 80
<ComponentDefinition> ................................................................................................................ 81
Class= ...................................................................................................................................... 82
CSSFile= ................................................................................................................................... 82
DataModelClass= ..................................................................................................................... 83
Directory= ................................................................................................................................ 84

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
iv of ANSYS, Inc. and its subsidiaries and affiliates.
 ACT XML Reference Guide

HTMLFile= ................................................................................................................................ 85
JSFile= ...................................................................................................................................... 86
Name= ..................................................................................................................................... 87
<ComponentStyle> ........................................................................................................................ 88
component= ............................................................................................................................ 88
filter= ....................................................................................................................................... 89
<connectTo> .................................................................................................................................. 90
action= .................................................................................................................................... 90
event= ..................................................................................................................................... 91
<contextmenus> ............................................................................................................................ 92
<UIEntry> ................................................................................................................................. 93
<ControlTemplate> ........................................................................................................................ 93
<Property> ............................................................................................................................... 94
name= ..................................................................................................................................... 94
version= ................................................................................................................................... 95
<datamodel> ................................................................................................................................. 96
name= ..................................................................................................................................... 97
<DataModel> ................................................................................................................................. 98
<UserObject> ........................................................................................................................... 98
icon= ....................................................................................................................................... 99
name= ................................................................................................................................... 100
<DataModelView> ........................................................................................................................ 100
chartComponent= .................................................................................................................. 101
dataModel= ............................................................................................................................ 102
imageComponent= ................................................................................................................ 103
name= ................................................................................................................................... 104
presentation= ......................................................................................................................... 105
propertiesComponent= .......................................................................................................... 105
sceneComponent= ................................................................................................................. 106
tabularComponent= ............................................................................................................... 107
treeComponent= .................................................................................................................... 108
<DialogProgressMonitorView> ..................................................................................................... 109
<task> .................................................................................................................................... 109
name= ................................................................................................................................... 110
<entity> ....................................................................................................................................... 111
<Attributes> ........................................................................................................................... 112
<Callbacks> ............................................................................................................................ 113
<CanAdd> .............................................................................................................................. 114
<CanDuplicate> ..................................................................................................................... 115
<CanRemove> ........................................................................................................................ 116
<IsValid> ................................................................................................................................ 117
<OnAdd> ............................................................................................................................... 118
<OnAfterGeometryUpdate> ................................................................................................... 119
<OnBodySuppressStateChange> ............................................................................................ 119
<OnClearData> ...................................................................................................................... 120
<OnDuplicate> ....................................................................................................................... 121
<OnGenerateData> ................................................................................................................ 122
<OnHide> .............................................................................................................................. 123
<OnInit> ................................................................................................................................ 124
<OnMigrate> .......................................................................................................................... 125
<OnReady> ............................................................................................................................ 126
<OnRemove> ......................................................................................................................... 127

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. v
ACT XML Reference Guide

<OnShow> ............................................................................................................................. 128

<OnSuppress> ....................................................................................................................... 129
<OnUnsuppress> ................................................................................................................... 130
<Property> ............................................................................................................................. 131
caption= ................................................................................................................................ 132
class= ..................................................................................................................................... 133
contextual= ............................................................................................................................ 134
datatype= .............................................................................................................................. 135
icon= ...................................................................................................................................... 136
name= ................................................................................................................................... 136
version= ................................................................................................................................. 137
<entry> ........................................................................................................................................ 138
<Callbacks> ............................................................................................................................ 139
<onclick> ............................................................................................................................... 140
caption= ................................................................................................................................ 141
icon= ...................................................................................................................................... 141
name= ................................................................................................................................... 142
priority= ................................................................................................................................. 143
type= ..................................................................................................................................... 144
version= ................................................................................................................................. 145
<entry> ........................................................................................................................................ 146
<Callbacks> ............................................................................................................................ 147
<Entry> .................................................................................................................................. 147
<OnClick> .............................................................................................................................. 148
caption= ................................................................................................................................ 149
Icon= ...................................................................................................................................... 150
name= ................................................................................................................................... 151
userobject= ............................................................................................................................ 152
<Extension> ................................................................................................................................. 152
<Application> ........................................................................................................................ 154
<appStoreId> ......................................................................................................................... 154
<assembly> ............................................................................................................................ 155
<author> ................................................................................................................................ 156
<description> ......................................................................................................................... 156
<Guid> ................................................................................................................................... 157
<ImageDirectory> .................................................................................................................. 157
<Interface> ............................................................................................................................ 158
<Licenses> ............................................................................................................................. 159
<script> ................................................................................................................................. 159
<simdata> .............................................................................................................................. 160
<Templates> .......................................................................................................................... 161
<UIDefinition> ....................................................................................................................... 161
<Wizard> ............................................................................................................................... 162
<Workflow> ........................................................................................................................... 163
debug= .................................................................................................................................. 163
icon= ...................................................................................................................................... 164
isNative= ................................................................................................................................ 165
loadAsDefault= ....................................................................................................................... 166
masked= ................................................................................................................................ 167
minorversion= ........................................................................................................................ 168
name= ................................................................................................................................... 169
ReadPythonFiles= ................................................................................................................... 170

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
vi of ANSYS, Inc. and its subsidiaries and affiliates.
 ACT XML Reference Guide

version= ................................................................................................................................. 171

<ExtensionObject> ....................................................................................................................... 172
<Attributes> ........................................................................................................................... 173
<Callbacks> ............................................................................................................................ 174
<CanAdd> .............................................................................................................................. 174
<CanDuplicate> ..................................................................................................................... 175
<CanRemove> ........................................................................................................................ 176
<HostObjectModified> ........................................................................................................... 177
<IsValid> ................................................................................................................................ 178
<OnAdd> ............................................................................................................................... 179
<OnAfterGeometryUpdate> ................................................................................................... 180
<OnBodySuppressStateChange> ............................................................................................ 181
<OnClearData> ...................................................................................................................... 182
<OnDuplicate> ....................................................................................................................... 183
<OnGenerateData> ................................................................................................................ 184
<OnHide> .............................................................................................................................. 185
<OnInit> ................................................................................................................................ 186
<OnMigrate> .......................................................................................................................... 187
<OnReady> ............................................................................................................................ 188
<OnRemove> ......................................................................................................................... 189
<OnShow> ............................................................................................................................. 190
<OnSuppress> ....................................................................................................................... 191
<OnUnsuppress> ................................................................................................................... 192
<Property> ............................................................................................................................. 193
<Target> ................................................................................................................................ 194
caption= ................................................................................................................................ 195
class= ..................................................................................................................................... 195
contextual= ............................................................................................................................ 196
icon= ...................................................................................................................................... 197
name= ................................................................................................................................... 198
version= ................................................................................................................................. 199
<FileToolbarView> ........................................................................................................................ 200
buttonsComponent= .............................................................................................................. 200
name= ................................................................................................................................... 201
<filter> ......................................................................................................................................... 202
name= ................................................................................................................................... 203
src= ........................................................................................................................................ 204
<Geometry> ................................................................................................................................. 204
<Attributes> ........................................................................................................................... 206
<Callbacks> ............................................................................................................................ 207
<CanAdd> .............................................................................................................................. 207
<CanDuplicate> ..................................................................................................................... 208
<CanRemove> ........................................................................................................................ 209
<IsValid> ................................................................................................................................ 210
<OnAdd> ............................................................................................................................... 211
<OnAfterGenerate> ................................................................................................................ 212
<OnAfterGeometryUpdate> ................................................................................................... 213
<OnBodySuppressStateChange> ............................................................................................ 214
<OnClearData> ...................................................................................................................... 215
<OnDuplicate> ....................................................................................................................... 216
<OnEdit> ............................................................................................................................... 217
<OnGenerate> ....................................................................................................................... 218

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. vii
ACT XML Reference Guide

<OnGenerateData> ................................................................................................................ 219

<OnHide> .............................................................................................................................. 220
<OnInit> ................................................................................................................................ 221
<OnMigrate> .......................................................................................................................... 222
<OnReady> ............................................................................................................................ 223
<OnRemove> ......................................................................................................................... 224
<OnShow> ............................................................................................................................. 225
<OnSuppress> ....................................................................................................................... 226
<OnUnsuppress> ................................................................................................................... 227
<Property> ............................................................................................................................. 228
caption= ................................................................................................................................ 229
class= ..................................................................................................................................... 230
contextual= ............................................................................................................................ 231
icon= ...................................................................................................................................... 232
name= ................................................................................................................................... 233
version= ................................................................................................................................. 233
<guid> ......................................................................................................................................... 234
shortid= ................................................................................................................................. 235
<Image> ...................................................................................................................................... 236
<Callbacks> ............................................................................................................................ 236
<OnAdd> ............................................................................................................................... 237
<OnDelete> ........................................................................................................................... 238
<OnHighlight> ....................................................................................................................... 239
<OnUnhighlight> ................................................................................................................... 240
<OnUpdate> .......................................................................................................................... 241
allowHighlight= ...................................................................................................................... 242
FileNameProperty= ................................................................................................................. 243
userObject= ........................................................................................................................... 244
visibility= ................................................................................................................................ 244
<ImageDirectory> ........................................................................................................................ 245
<includegroup> ........................................................................................................................... 246
caption= ................................................................................................................................ 246
external= ................................................................................................................................ 247
name= ................................................................................................................................... 248
<includetask> .............................................................................................................................. 249
caption= ................................................................................................................................ 249
external= ................................................................................................................................ 250
name= ................................................................................................................................... 251
<input> ........................................................................................................................................ 252
count= ................................................................................................................................... 252
format= .................................................................................................................................. 253
type= ..................................................................................................................................... 254
<inputfile> ................................................................................................................................... 255
id= ......................................................................................................................................... 255
name= ................................................................................................................................... 256
<inputFromActionOutput> ........................................................................................................... 257
action= ................................................................................................................................... 257
Name= ................................................................................................................................... 258
output= .................................................................................................................................. 259
<inputFromOperator> .................................................................................................................. 260
Name= ................................................................................................................................... 260
operator= ............................................................................................................................... 261

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
viii of ANSYS, Inc. and its subsidiaries and affiliates.
 ACT XML Reference Guide

<inputgroup> .............................................................................................................................. 262

<Input> .................................................................................................................................. 263
<inputs> ...................................................................................................................................... 263
<InputGroup> ........................................................................................................................ 264
<inputValue> ............................................................................................................................... 264
Name= ................................................................................................................................... 265
<Interface> .................................................................................................................................. 265
<Callbacks> ............................................................................................................................ 267
<filter> ................................................................................................................................... 267
<GetPostCommands> ............................................................................................................ 268
<GetPreCommands> .............................................................................................................. 269
<GetSolveCommands> ........................................................................................................... 270
<images> ............................................................................................................................... 271
<IsAnalysisValid> .................................................................................................................... 271
<OnActiveObjectChange> ...................................................................................................... 272
<OnAfterGeometryUpdate> ................................................................................................... 273
<OnAfterRemove> ................................................................................................................. 274
<OnAfterSolve> ...................................................................................................................... 275
<OnBeforeGeometryUpdate> ................................................................................................. 276
<OnBeforeSolve> ................................................................................................................... 277
<OnBodySuppressStateChange> ............................................................................................ 278
<OnDraw> ............................................................................................................................. 279
<OnDraw2D> ......................................................................................................................... 280
<OnInit> ................................................................................................................................ 281
<OnLoad> .............................................................................................................................. 282
<OnMeshCleaned> ................................................................................................................. 283
<OnMeshGenerated> ............................................................................................................. 284
<OnPostFinished> .................................................................................................................. 285
<OnPostStarted> .................................................................................................................... 286
<OnReady> ............................................................................................................................ 287
<OnSave> .............................................................................................................................. 288
<OnTerminate> ...................................................................................................................... 289
<OnUnitsChanged> ................................................................................................................ 290
<Resume> .............................................................................................................................. 291
<Save> ................................................................................................................................... 292
<toolbar> ............................................................................................................................... 293
context= ................................................................................................................................ 294
<Layout> ...................................................................................................................................... 295
<Component> ........................................................................................................................ 295
name= ................................................................................................................................... 296
<Layout> ...................................................................................................................................... 297
<Component> ........................................................................................................................ 297
name= ................................................................................................................................... 298
<Layout> ...................................................................................................................................... 299
<Component> ........................................................................................................................ 299
name= ................................................................................................................................... 300
<Layout> ...................................................................................................................................... 300
<Component> ........................................................................................................................ 301
name= ................................................................................................................................... 301
<License> ..................................................................................................................................... 302
name= ................................................................................................................................... 303
<Licenses> ................................................................................................................................... 304

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. ix
ACT XML Reference Guide

<License> ............................................................................................................................... 304

<Link> .......................................................................................................................................... 305
from= ..................................................................................................................................... 305
to= ......................................................................................................................................... 306
<Load> ........................................................................................................................................ 307
<Action> ................................................................................................................................ 309
<Attributes> ........................................................................................................................... 310
<Callbacks> ............................................................................................................................ 310
<CanAdd> .............................................................................................................................. 311
<CanDuplicate> ..................................................................................................................... 312
<CanRemove> ........................................................................................................................ 313
<GetCommands> ................................................................................................................... 314
<GetNodalValuesForDisplay> ................................................................................................. 315
<GetPostCommands> ............................................................................................................ 316
<GetPreCommands> .............................................................................................................. 317
<GetSolveCommands> ........................................................................................................... 318
<IsValid> ................................................................................................................................ 318
<OnAdd> ............................................................................................................................... 319
<OnAfterGenerate> ................................................................................................................ 320
<OnAfterGeometryUpdate> ................................................................................................... 321
<OnBodySuppressStateChange> ............................................................................................ 322
<OnClearData> ...................................................................................................................... 323
<OnDuplicate> ....................................................................................................................... 324
<OnGenerate> ....................................................................................................................... 325
<OnGenerateData> ................................................................................................................ 326
<OnHide> .............................................................................................................................. 327
<OnInit> ................................................................................................................................ 328
<OnMigrate> .......................................................................................................................... 329
<OnReady> ............................................................................................................................ 330
<OnRemove> ......................................................................................................................... 331
<OnShow> ............................................................................................................................. 332
<OnSuppress> ....................................................................................................................... 333
<OnUnsuppress> ................................................................................................................... 334
<Property> ............................................................................................................................. 335
caption= ................................................................................................................................ 336
class= ..................................................................................................................................... 337
color= .................................................................................................................................... 338
contextual= ............................................................................................................................ 339
icon= ...................................................................................................................................... 340
IsLoad= .................................................................................................................................. 341
IsSupport= ............................................................................................................................. 342
name= ................................................................................................................................... 342
unit= ...................................................................................................................................... 343
version= ................................................................................................................................. 344
<Object> ...................................................................................................................................... 345
<Action> ................................................................................................................................ 347
<Attributes> ........................................................................................................................... 348
<Callbacks> ............................................................................................................................ 349
<CanAdd> .............................................................................................................................. 349
<CanDuplicate> ..................................................................................................................... 350
<CanRemove> ........................................................................................................................ 351
<GetCommands> ................................................................................................................... 352

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
x of ANSYS, Inc. and its subsidiaries and affiliates.
 ACT XML Reference Guide

<GetNodalValuesForDisplay> ................................................................................................. 353

<GetPostCommands> ............................................................................................................ 354
<GetPreCommands> .............................................................................................................. 355
<GetSolveCommands> ........................................................................................................... 356
<IsValid> ................................................................................................................................ 357
<OnAdd> ............................................................................................................................... 358
<OnAfterGenerate> ................................................................................................................ 359
<OnAfterGeometryUpdate> ................................................................................................... 360
<OnBodySuppressStateChange> ............................................................................................ 361
<OnClearData> ...................................................................................................................... 362
<OnDuplicate> ....................................................................................................................... 363
<OnGenerate> ....................................................................................................................... 364
<OnGenerateData> ................................................................................................................ 365
<OnHide> .............................................................................................................................. 366
<OnInit> ................................................................................................................................ 367
<OnMigrate> .......................................................................................................................... 368
<OnReady> ............................................................................................................................ 369
<OnRemove> ......................................................................................................................... 370
<OnShow> ............................................................................................................................. 371
<OnSuppress> ....................................................................................................................... 372
<OnUnsuppress> ................................................................................................................... 373
<Property> ............................................................................................................................. 374
<Target> ................................................................................................................................ 375
caption= ................................................................................................................................ 376
class= ..................................................................................................................................... 376
color= .................................................................................................................................... 377
contextual= ............................................................................................................................ 379
icon= ...................................................................................................................................... 379
IsLoad= .................................................................................................................................. 380
IsSupport= ............................................................................................................................. 381
name= ................................................................................................................................... 382
unit= ...................................................................................................................................... 383
version= ................................................................................................................................. 384
<operator> ................................................................................................................................... 385
<InputValue> ......................................................................................................................... 385
Name= ................................................................................................................................... 386
Type= ..................................................................................................................................... 387
<Optimizer> ................................................................................................................................. 388
<Attributes> ........................................................................................................................... 392
<Callbacks> ............................................................................................................................ 392
<CanAdd> .............................................................................................................................. 393
<CanDuplicate> ..................................................................................................................... 394
<CanRemove> ........................................................................................................................ 395
<CanRun> .............................................................................................................................. 396
<Configuration> ..................................................................................................................... 397
<ConvergenceDescription> .................................................................................................... 398
<Description> ........................................................................................................................ 399
<InputParametersEdited> ....................................................................................................... 400
<IsValid> ................................................................................................................................ 401
<MethodPropertiesEdited> .................................................................................................... 402
<ObjectivesOrConstraintsEdited> ........................................................................................... 403
<OnAdd> ............................................................................................................................... 404

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xi
ACT XML Reference Guide

<OnAfterGeometryUpdate> ................................................................................................... 404

<OnBodySuppressStateChange> ............................................................................................ 405
<OnClearData> ...................................................................................................................... 406
<OnCreate> ........................................................................................................................... 407
<OnDuplicate> ....................................................................................................................... 408
<OnGenerateData> ................................................................................................................ 409
<OnHide> .............................................................................................................................. 410
<OnInit> ................................................................................................................................ 411
<OnMigrate> .......................................................................................................................... 412
<OnReady> ............................................................................................................................ 413
<OnRelease> .......................................................................................................................... 414
<OnRemove> ......................................................................................................................... 415
<OnShow> ............................................................................................................................. 416
<OnSuppress> ....................................................................................................................... 417
<OnUnsuppress> ................................................................................................................... 418
<ParameterRelationshipsEdited> ............................................................................................ 419
<Property> ............................................................................................................................. 420
<QuickHelp> .......................................................................................................................... 421
<Status> ................................................................................................................................ 422
basedondirectoptimizationonly= ............................................................................................ 423
basedonresponsesurfaceonly= ............................................................................................... 424
caption= ................................................................................................................................ 425
class= ..................................................................................................................................... 425
constrainthandling= ............................................................................................................... 426
constraintimportance= ........................................................................................................... 427
constraintoninputparameter= ................................................................................................. 428
contextual= ............................................................................................................................ 429
convergencedata= .................................................................................................................. 430
equaltoconstraint= ................................................................................................................. 431
greaterthanconstraint= ........................................................................................................... 432
gridintervaloninputparameter= .............................................................................................. 433
historychartxaxistype= ........................................................................................................... 434
icon= ...................................................................................................................................... 435
insideboundsconstraint= ........................................................................................................ 435
lessthanconstraint= ................................................................................................................ 436
logfile= ................................................................................................................................... 437
maximizeobjective= ............................................................................................................... 438
maximumnumberofconstraints= ............................................................................................. 439
maximumnumberofdoublelistparameters= ............................................................................. 440
maximumnumberofdoubleparameters= ................................................................................. 441
maximumnumberofinputparameters= .................................................................................... 442
maximumnumberofintegerlistparameters= ............................................................................. 443
maximumnumberofobjectives= .............................................................................................. 444
minimizeobjective= ................................................................................................................ 444
minimumnumberofconstraints= ............................................................................................. 445
minimumnumberofobjectives= .............................................................................................. 446
name= ................................................................................................................................... 447
objectiveimportance= ............................................................................................................ 448
objectiveoninputparameter= .................................................................................................. 449
parameterrelationship= .......................................................................................................... 450
seekobjective= ....................................................................................................................... 451
startingpointrequired= ........................................................................................................... 452

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xii of ANSYS, Inc. and its subsidiaries and affiliates.
 ACT XML Reference Guide

version= ................................................................................................................................. 453

<OrderableCallback> .................................................................................................................... 454
caninterrupt= ......................................................................................................................... 454
order= .................................................................................................................................... 455
<output> ..................................................................................................................................... 456
format= .................................................................................................................................. 456
type= ..................................................................................................................................... 457
<outputfile> ................................................................................................................................. 458
id= ......................................................................................................................................... 458
name= ................................................................................................................................... 459
<outputs> .................................................................................................................................... 460
<Output> ............................................................................................................................... 460
<Panel> ........................................................................................................................................ 461
<Callbacks> ............................................................................................................................ 462
<DialogProgressMonitorView> ............................................................................................... 462
<OnPanelHidden> .................................................................................................................. 463
<OnPanelInitialized> .............................................................................................................. 464
<OnPanelShown> .................................................................................................................. 465
class= ..................................................................................................................................... 466
layout= ................................................................................................................................... 467
name= ................................................................................................................................... 468
<PanelComponent> ..................................................................................................................... 468
<Attributes> ........................................................................................................................... 470
<Layout> ................................................................................................................................ 470
<layoutName> ....................................................................................................................... 471
BottomAttachment= .............................................................................................................. 472
BottomOffset= ....................................................................................................................... 472
ComponentType= .................................................................................................................. 473
CustomCSSFile= ..................................................................................................................... 474
CustomHTMLFile= .................................................................................................................. 475
CustomJSFile= ........................................................................................................................ 476
Height= .................................................................................................................................. 477
HeightType= .......................................................................................................................... 478
LeftAttachment= .................................................................................................................... 479
LeftOffset= ............................................................................................................................. 480
MaxHeight= ........................................................................................................................... 481
MaxWidth= ............................................................................................................................ 481
MinHeight= ............................................................................................................................ 482
MinWidth= ............................................................................................................................. 483
name= ................................................................................................................................... 484
RightAttachment= .................................................................................................................. 485
RightOffset= ........................................................................................................................... 486
TopAttachment= .................................................................................................................... 487
TopOffset= ............................................................................................................................. 488
visible= .................................................................................................................................. 489
Width= ................................................................................................................................... 490
WidthType= ............................................................................................................................ 490
<parameter> ................................................................................................................................ 491
<Attributes> ........................................................................................................................... 493
<Callbacks> ............................................................................................................................ 493
<CanAdd> .............................................................................................................................. 494
<CanDuplicate> ..................................................................................................................... 495

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xiii
ACT XML Reference Guide

<CanRemove> ........................................................................................................................ 496

<IsValid> ................................................................................................................................ 497
<OnAdd> ............................................................................................................................... 498
<OnAfterGeometryUpdate> ................................................................................................... 499
<OnBodySuppressStateChange> ............................................................................................ 500
<OnClearData> ...................................................................................................................... 501
<OnDuplicate> ....................................................................................................................... 502
<OnGenerateData> ................................................................................................................ 503
<OnHide> .............................................................................................................................. 504
<OnInit> ................................................................................................................................ 505
<OnMigrate> .......................................................................................................................... 505
<OnReady> ............................................................................................................................ 506
<OnRemove> ......................................................................................................................... 507
<OnShow> ............................................................................................................................. 508
<OnSuppress> ....................................................................................................................... 509
<OnUnsuppress> ................................................................................................................... 510
<Property> ............................................................................................................................. 511
caption= ................................................................................................................................ 512
class= ..................................................................................................................................... 513
contextual= ............................................................................................................................ 514
control= ................................................................................................................................. 515
icon= ...................................................................................................................................... 516
name= ................................................................................................................................... 516
usage= ................................................................................................................................... 517
version= ................................................................................................................................. 518
<parameters> ............................................................................................................................... 519
<Parameter> .......................................................................................................................... 520
<platform> ................................................................................................................................... 520
name= ................................................................................................................................... 521
path= ..................................................................................................................................... 521
<Presentations> ........................................................................................................................... 522
<ScenePresentation> ............................................................................................................. 523
Name= ................................................................................................................................... 523
<ProductDataModelConverter> .................................................................................................... 524
<Callbacks> ............................................................................................................................ 525
<OnReadInput> ..................................................................................................................... 526
<OnSendBackData> ............................................................................................................... 527
<OnSendData> ...................................................................................................................... 528
<OnWriteInput> ..................................................................................................................... 529
<UserObjectConverter> .......................................................................................................... 529
dataModel= ............................................................................................................................ 530
product= ................................................................................................................................ 531
<ProductTask> ............................................................................................................................. 532
<DataModelInOut> ................................................................................................................ 532
caption= ................................................................................................................................ 533
name= ................................................................................................................................... 534
product= ................................................................................................................................ 535
<program> ................................................................................................................................... 536
<Argument> .......................................................................................................................... 536
<Platform> ............................................................................................................................. 537
<projectdata> .............................................................................................................................. 537
<DataEntity> .......................................................................................................................... 538

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xiv of ANSYS, Inc. and its subsidiaries and affiliates.
 ACT XML Reference Guide

<property> .................................................................................................................................. 538

<Attributes> ........................................................................................................................... 541
<Callbacks> ............................................................................................................................ 541
<GetValue> ............................................................................................................................ 542
<help> ................................................................................................................................... 543
<IsValid> ................................................................................................................................ 544
<IsVisible> .............................................................................................................................. 544
<OnActivate> ......................................................................................................................... 545
<OnAdd> ............................................................................................................................... 546
<OnAfterGeometryUpdate> ................................................................................................... 547
<OnApply> ............................................................................................................................ 548
<OnBodySuppressStateChange> ............................................................................................ 549
<OnButtonClick> .................................................................................................................... 550
<OnCancel> ........................................................................................................................... 551
<OnDuplicate> ....................................................................................................................... 552
<OnHide> .............................................................................................................................. 553
<OnInit> ................................................................................................................................ 554
<OnJournalExecuting> ........................................................................................................... 555
<OnJournalRecording> .......................................................................................................... 556
<OnMigrate> .......................................................................................................................... 557
<OnRemove> ......................................................................................................................... 558
<OnShow> ............................................................................................................................. 559
<OnValidate> ......................................................................................................................... 560
<SetValue> ............................................................................................................................. 561
<String2Value> ...................................................................................................................... 562
<Value2String> ...................................................................................................................... 563
caption= ................................................................................................................................ 564
class= ..................................................................................................................................... 565
control= ................................................................................................................................. 566
default= ................................................................................................................................. 567
elementtype= ......................................................................................................................... 568
isparameter= .......................................................................................................................... 569
keytype= ................................................................................................................................ 570
name= ................................................................................................................................... 571
needupdate= ......................................................................................................................... 572
parameterizable= ................................................................................................................... 572
persistent= ............................................................................................................................. 573
readonly= ............................................................................................................................... 574
unit= ...................................................................................................................................... 575
valuetype= ............................................................................................................................. 576
visible= .................................................................................................................................. 577
visibleon= .............................................................................................................................. 578
<propertygroup> ......................................................................................................................... 579
<Attributes> ........................................................................................................................... 581
<Callbacks> ............................................................................................................................ 582
<GetValue> ............................................................................................................................ 582
<help> ................................................................................................................................... 583
<IsValid> ................................................................................................................................ 584
<IsVisible> .............................................................................................................................. 585
<OnActivate> ......................................................................................................................... 586
<OnAdd> ............................................................................................................................... 587
<OnAfterGeometryUpdate> ................................................................................................... 588

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xv
ACT XML Reference Guide

<OnApply> ............................................................................................................................ 589

<OnBodySuppressStateChange> ............................................................................................ 590
<OnButtonClick> .................................................................................................................... 591
<OnCancel> ........................................................................................................................... 592
<OnDuplicate> ....................................................................................................................... 592
<OnHide> .............................................................................................................................. 593
<OnInit> ................................................................................................................................ 594
<OnJournalExecuting> ........................................................................................................... 595
<OnJournalRecording> .......................................................................................................... 596
<OnMigrate> .......................................................................................................................... 597
<OnRemove> ......................................................................................................................... 598
<OnShow> ............................................................................................................................. 599
<OnValidate> ......................................................................................................................... 600
<Property> ............................................................................................................................. 601
<SetValue> ............................................................................................................................. 602
<String2Value> ...................................................................................................................... 603
<Value2String> ...................................................................................................................... 604
caption= ................................................................................................................................ 605
class= ..................................................................................................................................... 606
control= ................................................................................................................................. 607
default= ................................................................................................................................. 608
display= ................................................................................................................................. 608
elementtype= ......................................................................................................................... 609
isparameter= .......................................................................................................................... 610
keytype= ................................................................................................................................ 611
name= ................................................................................................................................... 612
needupdate= ......................................................................................................................... 613
parameterizable= ................................................................................................................... 614
persistent= ............................................................................................................................. 615
readonly= ............................................................................................................................... 616
unit= ...................................................................................................................................... 617
valuetype= ............................................................................................................................. 618
visible= .................................................................................................................................. 618
visibleon= .............................................................................................................................. 619
<propertytable> ........................................................................................................................... 620
<Attributes> ........................................................................................................................... 623
<Callbacks> ............................................................................................................................ 623
<GetValue> ............................................................................................................................ 624
<help> ................................................................................................................................... 625
<IsValid> ................................................................................................................................ 626
<IsVisible> .............................................................................................................................. 627
<OnActivate> ......................................................................................................................... 627
<OnAdd> ............................................................................................................................... 628
<OnAfterGeometryUpdate> ................................................................................................... 629
<OnApply> ............................................................................................................................ 630
<OnBodySuppressStateChange> ............................................................................................ 631
<OnButtonClick> .................................................................................................................... 632
<OnCancel> ........................................................................................................................... 633
<OnDuplicate> ....................................................................................................................... 634
<OnHide> .............................................................................................................................. 635
<OnInit> ................................................................................................................................ 636
<OnJournalExecuting> ........................................................................................................... 637

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xvi of ANSYS, Inc. and its subsidiaries and affiliates.
 ACT XML Reference Guide

<OnJournalRecording> .......................................................................................................... 638

<OnMigrate> .......................................................................................................................... 639
<OnRemove> ......................................................................................................................... 640
<OnShow> ............................................................................................................................. 641
<OnValidate> ......................................................................................................................... 642
<Property> ............................................................................................................................. 643
<SetValue> ............................................................................................................................. 644
<String2Value> ...................................................................................................................... 645
<Value2String> ...................................................................................................................... 646
allowempty= .......................................................................................................................... 647
caption= ................................................................................................................................ 648
class= ..................................................................................................................................... 649
control= ................................................................................................................................. 650
default= ................................................................................................................................. 650
display= ................................................................................................................................. 651
elementtype= ......................................................................................................................... 652
isparameter= .......................................................................................................................... 653
keytype= ................................................................................................................................ 654
name= ................................................................................................................................... 655
needupdate= ......................................................................................................................... 656
parameterizable= ................................................................................................................... 657
persistent= ............................................................................................................................. 658
readonly= ............................................................................................................................... 659
unit= ...................................................................................................................................... 660
valuetype= ............................................................................................................................. 660
visible= .................................................................................................................................. 661
visibleon= .............................................................................................................................. 662
<Result> ....................................................................................................................................... 663
<Action> ................................................................................................................................ 665
<Attributes> ........................................................................................................................... 666
<Callbacks> ............................................................................................................................ 667
<CanAdd> .............................................................................................................................. 668
<CanDuplicate> ..................................................................................................................... 669
<CanRemove> ........................................................................................................................ 669
<Evaluate> ............................................................................................................................. 670
<GetFieldCount> .................................................................................................................... 671
<GetValue> ............................................................................................................................ 672
<IsValid> ................................................................................................................................ 673
<OnAdd> ............................................................................................................................... 674
<OnAfterGeometryUpdate> ................................................................................................... 675
<OnBodySuppressStateChange> ............................................................................................ 676
<OnClearData> ...................................................................................................................... 677
<OnDuplicate> ....................................................................................................................... 678
<OnEndEval> ......................................................................................................................... 679
<OnEndPost> ......................................................................................................................... 680
<OnGenerateData> ................................................................................................................ 681
<OnHide> .............................................................................................................................. 682
<OnInit> ................................................................................................................................ 683
<OnMigrate> .......................................................................................................................... 684
<OnReady> ............................................................................................................................ 685
<OnRemove> ......................................................................................................................... 686
<OnShow> ............................................................................................................................. 687

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xvii
ACT XML Reference Guide

<OnStartEval> ........................................................................................................................ 688

<OnStartPost> ........................................................................................................................ 689
<OnSuppress> ....................................................................................................................... 690
<OnUnsuppress> ................................................................................................................... 691
<Property> ............................................................................................................................. 692
averaging= ............................................................................................................................. 693
caption= ................................................................................................................................ 694
class= ..................................................................................................................................... 695
contextual= ............................................................................................................................ 696
hasimaginary= ....................................................................................................................... 697
icon= ...................................................................................................................................... 697
iscontactresult= ...................................................................................................................... 698
location= ................................................................................................................................ 699
name= ................................................................................................................................... 700
timehistory= ........................................................................................................................... 701
type= ..................................................................................................................................... 702
unit= ...................................................................................................................................... 703
version= ................................................................................................................................. 704
<rsmjob> ..................................................................................................................................... 705
<Attributes> ........................................................................................................................... 706
<Callbacks> ............................................................................................................................ 707
<CanAdd> .............................................................................................................................. 708
<CanDuplicate> ..................................................................................................................... 709
<CanRemove> ........................................................................................................................ 710
<InputFile> ............................................................................................................................ 711
<IsValid> ................................................................................................................................ 711
<OnAdd> ............................................................................................................................... 712
<OnAfterGeometryUpdate> ................................................................................................... 713
<OnBodySuppressStateChange> ............................................................................................ 714
<OnClearData> ...................................................................................................................... 715
<oncreatejobinput> ............................................................................................................... 716
<OnDuplicate> ....................................................................................................................... 717
<OnGenerateData> ................................................................................................................ 718
<OnHide> .............................................................................................................................. 719
<OnInit> ................................................................................................................................ 720
<onjobcancellation> .............................................................................................................. 721
<onjobreconnect> ................................................................................................................. 722
<onjobstatus> ........................................................................................................................ 723
<OnMigrate> .......................................................................................................................... 724
<OnReady> ............................................................................................................................ 725
<OnRemove> ......................................................................................................................... 726
<OnShow> ............................................................................................................................. 727
<OnSuppress> ....................................................................................................................... 728
<OnUnsuppress> ................................................................................................................... 729
<OutputFile> .......................................................................................................................... 730
<Program> ............................................................................................................................. 731
<Property> ............................................................................................................................. 732
caption= ................................................................................................................................ 732
class= ..................................................................................................................................... 733
contextual= ............................................................................................................................ 734
deletefiles= ............................................................................................................................ 735
icon= ...................................................................................................................................... 736

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xviii of ANSYS, Inc. and its subsidiaries and affiliates.
 ACT XML Reference Guide

name= ................................................................................................................................... 737

version= ................................................................................................................................. 738
<Sampling> ................................................................................................................................. 739
<Attributes> ........................................................................................................................... 742
<Callbacks> ............................................................................................................................ 742
<CanAdd> .............................................................................................................................. 743
<CanDuplicate> ..................................................................................................................... 744
<CanRemove> ........................................................................................................................ 745
<CanRun> .............................................................................................................................. 746
<Configuration> ..................................................................................................................... 747
<Description> ........................................................................................................................ 748
<InputParametersEdited> ....................................................................................................... 749
<IsValid> ................................................................................................................................ 750
<MethodPropertiesEdited> .................................................................................................... 751
<OnAdd> ............................................................................................................................... 752
<OnAfterGeometryUpdate> ................................................................................................... 752
<OnBodySuppressStateChange> ............................................................................................ 753
<OnClearData> ...................................................................................................................... 754
<OnCreate> ........................................................................................................................... 755
<OnDuplicate> ....................................................................................................................... 756
<OnGenerateData> ................................................................................................................ 757
<OnHide> .............................................................................................................................. 758
<OnInit> ................................................................................................................................ 759
<OnMigrate> .......................................................................................................................... 760
<OnReady> ............................................................................................................................ 761
<OnRelease> .......................................................................................................................... 762
<OnRemove> ......................................................................................................................... 763
<OnShow> ............................................................................................................................. 764
<OnSuppress> ....................................................................................................................... 765
<OnUnsuppress> ................................................................................................................... 766
<Property> ............................................................................................................................. 767
<QuickHelp> .......................................................................................................................... 768
<Status> ................................................................................................................................ 769
caption= ................................................................................................................................ 770
class= ..................................................................................................................................... 771
contextual= ............................................................................................................................ 772
CustomTable= ........................................................................................................................ 773
icon= ...................................................................................................................................... 773
logfile= ................................................................................................................................... 774
maximumnumberofdoublelistparameters= ............................................................................. 775
maximumnumberofdoubleparameters= ................................................................................. 776
maximumnumberofinputparameters= .................................................................................... 777
maximumnumberofintegerlistparameters= ............................................................................. 778
name= ................................................................................................................................... 779
version= ................................................................................................................................. 780
<Scene> ....................................................................................................................................... 781
<Callbacks> ............................................................................................................................ 781
<OnAdd> ............................................................................................................................... 782
<OnDelete> ........................................................................................................................... 783
<OnHighlight> ....................................................................................................................... 784
<OnUnhighlight> ................................................................................................................... 785
<OnUpdate> .......................................................................................................................... 786

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xix
ACT XML Reference Guide

allowHighlight= ...................................................................................................................... 787

userObject= ........................................................................................................................... 788
visibility= ................................................................................................................................ 788
<script> ....................................................................................................................................... 789
compiled= .............................................................................................................................. 790
src= ........................................................................................................................................ 791
<separator> ................................................................................................................................. 791
<simdata> .................................................................................................................................... 792
<Load> .................................................................................................................................. 792
context= ................................................................................................................................ 793
<Solver> ...................................................................................................................................... 794
<Attributes> ........................................................................................................................... 795
<Callbacks> ............................................................................................................................ 796
<CanAdd> .............................................................................................................................. 797
<CanDuplicate> ..................................................................................................................... 798
<CanRemove> ........................................................................................................................ 799
<GetFiles> .............................................................................................................................. 800
<GetReader> .......................................................................................................................... 800
<GetSteps> ............................................................................................................................ 801
<IsAnalysisValid> .................................................................................................................... 802
<IsValid> ................................................................................................................................ 803
<OnAdd> ............................................................................................................................... 804
<OnAfterGeometryUpdate> ................................................................................................... 805
<OnBeforeSolve> ................................................................................................................... 806
<OnBodySuppressStateChange> ............................................................................................ 807
<OnCheckResults> ................................................................................................................. 808
<OnClearData> ...................................................................................................................... 809
<OnDuplicate> ....................................................................................................................... 810
<OnGenerateData> ................................................................................................................ 811
<OnHide> .............................................................................................................................. 812
<OnInit> ................................................................................................................................ 813
<OnMigrate> .......................................................................................................................... 814
<OnReady> ............................................................................................................................ 815
<OnRemove> ......................................................................................................................... 816
<OnShow> ............................................................................................................................. 817
<OnSolve> ............................................................................................................................. 818
<OnSuppress> ....................................................................................................................... 819
<OnUnsuppress> ................................................................................................................... 820
<OnWriteInputFile> ................................................................................................................ 821
<Property> ............................................................................................................................. 822
analysis= ................................................................................................................................ 823
caption= ................................................................................................................................ 824
class= ..................................................................................................................................... 825
contextual= ............................................................................................................................ 826
icon= ...................................................................................................................................... 827
name= ................................................................................................................................... 827
physics= ................................................................................................................................. 828
toolbox= ................................................................................................................................ 829
version= ................................................................................................................................. 830
<StandardAction> ........................................................................................................................ 831
actionId= ................................................................................................................................ 832
caption= ................................................................................................................................ 832

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xx of ANSYS, Inc. and its subsidiaries and affiliates.
 ACT XML Reference Guide

name= ................................................................................................................................... 833

<Step> ......................................................................................................................................... 834
<Attributes> ........................................................................................................................... 836
<Callbacks> ............................................................................................................................ 837
<CanAdd> .............................................................................................................................. 837
<CanDuplicate> ..................................................................................................................... 838
<CanRemove> ........................................................................................................................ 839
<ComponentData> ................................................................................................................ 840
<ComponentStyle> ................................................................................................................ 841
<Description> ........................................................................................................................ 842
<IsValid> ................................................................................................................................ 842
<OnAdd> ............................................................................................................................... 843
<OnAfterGeometryUpdate> ................................................................................................... 844
<OnBodySuppressStateChange> ............................................................................................ 845
<OnClearData> ...................................................................................................................... 846
<oncreate> ............................................................................................................................ 847
<OnDuplicate> ....................................................................................................................... 848
<OnGenerateData> ................................................................................................................ 849
<OnHide> .............................................................................................................................. 850
<OnInit> ................................................................................................................................ 851
<OnMigrate> .......................................................................................................................... 852
<OnReady> ............................................................................................................................ 853
<onrefresh> ........................................................................................................................... 854
<OnRemove> ......................................................................................................................... 855
<onreset> .............................................................................................................................. 856
<OnShow> ............................................................................................................................. 857
<OnSuppress> ....................................................................................................................... 858
<OnUnsuppress> ................................................................................................................... 859
<onupdate> ........................................................................................................................... 860
<Property> ............................................................................................................................. 861
caption= ................................................................................................................................ 862
class= ..................................................................................................................................... 863
Context= ................................................................................................................................ 864
contextual= ............................................................................................................................ 865
Enabled= ................................................................................................................................ 866
helpFile= ................................................................................................................................ 866
icon= ...................................................................................................................................... 867
Layout= .................................................................................................................................. 868
name= ................................................................................................................................... 869
version= ................................................................................................................................. 870
<Target> ...................................................................................................................................... 871
location= ................................................................................................................................ 871
name= ................................................................................................................................... 872
type= ..................................................................................................................................... 873
<task> .......................................................................................................................................... 874
<Attributes> ........................................................................................................................... 876
<Callbacks> ............................................................................................................................ 877
<CanAdd> .............................................................................................................................. 877
<canconsumedata> ................................................................................................................ 878
<CanDuplicate> ..................................................................................................................... 879
<CanRemove> ........................................................................................................................ 880
<ContextMenus> .................................................................................................................... 881

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxi
ACT XML Reference Guide

<Inputs> ................................................................................................................................ 882

<IsValid> ................................................................................................................................ 883
<OnAdd> ............................................................................................................................... 884
<OnAfterGeometryUpdate> ................................................................................................... 884
<OnBodySuppressStateChange> ............................................................................................ 885
<OnClearData> ...................................................................................................................... 886
<ondelete> ............................................................................................................................ 887
<OnDuplicate> ....................................................................................................................... 888
<onedit> ................................................................................................................................ 889
<OnGenerateData> ................................................................................................................ 890
<OnHide> .............................................................................................................................. 891
<OnInit> ................................................................................................................................ 892
<oninitialize> ......................................................................................................................... 893
<onload> ............................................................................................................................... 894
<OnMigrate> .......................................................................................................................... 895
<OnReady> ............................................................................................................................ 896
<onrefresh> ........................................................................................................................... 897
<OnRemove> ......................................................................................................................... 898
<onreport> ............................................................................................................................ 899
<onreset> .............................................................................................................................. 900
<OnShow> ............................................................................................................................. 901
<onstatus> ............................................................................................................................. 902
<OnSuppress> ....................................................................................................................... 903
<OnUnsuppress> ................................................................................................................... 904
<onupdate> ........................................................................................................................... 905
<Outputs> ............................................................................................................................. 906
<Parameters> ......................................................................................................................... 907
<Property> ............................................................................................................................. 908
<RsmJob> .............................................................................................................................. 908
caption= ................................................................................................................................ 909
class= ..................................................................................................................................... 910
contextual= ............................................................................................................................ 911
enableGenericTransfer= .......................................................................................................... 912
icon= ...................................................................................................................................... 913
name= ................................................................................................................................... 913
version= ................................................................................................................................. 914
<task> .......................................................................................................................................... 915
Message= ............................................................................................................................... 916
Name= ................................................................................................................................... 917
Pct= ....................................................................................................................................... 918
<taskgroup> ................................................................................................................................ 918
<Attributes> ........................................................................................................................... 920
<Callbacks> ............................................................................................................................ 921
<CanAdd> .............................................................................................................................. 921
<CanDuplicate> ..................................................................................................................... 922
<CanRemove> ........................................................................................................................ 923
<IncludeGroup> ..................................................................................................................... 924
<IncludeTask> ........................................................................................................................ 925
<IsValid> ................................................................................................................................ 926
<OnAdd> ............................................................................................................................... 927
<OnAfterGeometryUpdate> ................................................................................................... 927
<OnBodySuppressStateChange> ............................................................................................ 928

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxii of ANSYS, Inc. and its subsidiaries and affiliates.
 ACT XML Reference Guide

<OnClearData> ...................................................................................................................... 929

<OnDuplicate> ....................................................................................................................... 930
<OnGenerateData> ................................................................................................................ 931
<OnHide> .............................................................................................................................. 932
<OnInit> ................................................................................................................................ 933
<OnMigrate> .......................................................................................................................... 934
<OnReady> ............................................................................................................................ 935
<OnRemove> ......................................................................................................................... 936
<OnShow> ............................................................................................................................. 937
<OnSuppress> ....................................................................................................................... 938
<OnUnsuppress> ................................................................................................................... 939
<Property> ............................................................................................................................. 940
abbreviation= ......................................................................................................................... 941
caption= ................................................................................................................................ 942
category= ............................................................................................................................... 943
class= ..................................................................................................................................... 944
contextual= ............................................................................................................................ 945
headertext= ........................................................................................................................... 945
icon= ...................................................................................................................................... 946
isparametricgroup= ................................................................................................................ 947
name= ................................................................................................................................... 948
version= ................................................................................................................................. 949
<taskgroups> ............................................................................................................................... 950
<TaskGroup> .......................................................................................................................... 950
<tasks> ........................................................................................................................................ 951
<Task> ................................................................................................................................... 951
<Templates> ................................................................................................................................ 952
<ControlTemplate> ................................................................................................................ 952
<toolbar> ..................................................................................................................................... 953
<Separator> ........................................................................................................................... 953
caption= ................................................................................................................................ 954
name= ................................................................................................................................... 955
<UIDefinition> ............................................................................................................................. 956
<ComponentDefinition> ........................................................................................................ 956
<Layout> ................................................................................................................................ 957
<UserDefinedTask> ...................................................................................................................... 958
<Callbacks> ............................................................................................................................ 958
<onUpdate> ........................................................................................................................... 959
caption= ................................................................................................................................ 960
name= ................................................................................................................................... 961
<UserInputTask> .......................................................................................................................... 961
<DataModelInOut> ................................................................................................................ 962
caption= ................................................................................................................................ 963
name= ................................................................................................................................... 963
panel= .................................................................................................................................... 964
<UserObject> ............................................................................................................................... 965
<Attributes> ........................................................................................................................... 967
<Callbacks> ............................................................................................................................ 968
<CanAdd> .............................................................................................................................. 968
<CanDuplicate> ..................................................................................................................... 969
<CanRemove> ........................................................................................................................ 970
<IsValid> ................................................................................................................................ 971

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxiii
ACT XML Reference Guide

<OnAdd> ............................................................................................................................... 972

<OnAfterGeometryUpdate> ................................................................................................... 973
<OnBodySuppressStateChange> ............................................................................................ 974
<OnClearData> ...................................................................................................................... 975
<OnDuplicate> ....................................................................................................................... 976
<OnGenerateData> ................................................................................................................ 977
<OnHide> .............................................................................................................................. 978
<OnInit> ................................................................................................................................ 979
<OnMigrate> .......................................................................................................................... 980
<OnReady> ............................................................................................................................ 981
<OnRemove> ......................................................................................................................... 982
<OnShow> ............................................................................................................................. 983
<OnSuppress> ....................................................................................................................... 984
<OnUnsuppress> ................................................................................................................... 985
<Property> ............................................................................................................................. 986
basedonxmldefinition= .......................................................................................................... 987
caption= ................................................................................................................................ 988
cardinality= ............................................................................................................................ 989
class= ..................................................................................................................................... 990
contextual= ............................................................................................................................ 991
icon= ...................................................................................................................................... 991
name= ................................................................................................................................... 992
parent= .................................................................................................................................. 993
version= ................................................................................................................................. 994
<UserObjectConverter> ................................................................................................................ 995
<Callbacks> ............................................................................................................................ 996
<OnReadInput> ..................................................................................................................... 996
<OnSendBackData> ............................................................................................................... 997
<OnSendData> ...................................................................................................................... 998
<OnWriteInput> ..................................................................................................................... 999
userObject= ......................................................................................................................... 1000
<Wizard> .................................................................................................................................... 1001
<Callbacks> .......................................................................................................................... 1002
<canstart> ............................................................................................................................ 1003
<Description> ...................................................................................................................... 1004
<Step> ................................................................................................................................. 1004
allowNavigation= ................................................................................................................. 1005
caption= ............................................................................................................................... 1006
context= ............................................................................................................................... 1007
hidden= ............................................................................................................................... 1007
icon= .................................................................................................................................... 1008
layout= ................................................................................................................................. 1009
name= .................................................................................................................................. 1010
persistent= ........................................................................................................................... 1011
subContext= ......................................................................................................................... 1012
version= ............................................................................................................................... 1013
<Workflow> ................................................................................................................................ 1014
<Attributes> ......................................................................................................................... 1016
<Callbacks> .......................................................................................................................... 1017
<CanAdd> ............................................................................................................................ 1018
<CanDuplicate> ................................................................................................................... 1019
<CanRemove> ...................................................................................................................... 1019

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxiv of ANSYS, Inc. and its subsidiaries and affiliates.
 ACT XML Reference Guide

<IsValid> .............................................................................................................................. 1020

<OnAdd> ............................................................................................................................. 1021
<onafterdesignpointchanged> ............................................................................................. 1022
<OnAfterGeometryUpdate> ................................................................................................. 1023
<onaftertaskcanduplicate> ................................................................................................... 1024
<onaftertaskcanusetransfer> ................................................................................................ 1025
<onaftertaskcreation> .......................................................................................................... 1026
<onaftertaskdeletion> .......................................................................................................... 1027
<onaftertaskduplicate> ........................................................................................................ 1028
<onaftertaskpropertyretrieval> ............................................................................................. 1029
<onaftertaskrefresh> ............................................................................................................ 1030
<onaftertaskreset> ............................................................................................................... 1031
<onaftertasksourceschanged> .............................................................................................. 1032
<onaftertaskstatus> .............................................................................................................. 1033
<onaftertaskupdate> ............................................................................................................ 1034
<onbeforedesignpointchanged> .......................................................................................... 1035
<onbeforetaskcanduplicate> ................................................................................................ 1036
<onbeforetaskcanusetransfer> ............................................................................................. 1037
<onbeforetaskcreation> ....................................................................................................... 1038
<onbeforetaskdeletion> ....................................................................................................... 1039
<onbeforetaskduplicate> ...................................................................................................... 1040
<onbeforetaskpropertyretrieval> .......................................................................................... 1041
<onbeforetaskrefresh> ......................................................................................................... 1042
<onbeforetaskreset> ............................................................................................................ 1043
<onbeforetasksourceschanged> ........................................................................................... 1044
<onbeforetaskstatus> ........................................................................................................... 1045
<onbeforetaskupdate> ......................................................................................................... 1046
<OnBodySuppressStateChange> .......................................................................................... 1047
<OnClearData> ..................................................................................................................... 1048
<OnDuplicate> ..................................................................................................................... 1049
<OnGenerateData> .............................................................................................................. 1050
<OnHide> ............................................................................................................................ 1051
<OnInit> ............................................................................................................................... 1052
<OnMigrate> ........................................................................................................................ 1053
<OnReady> .......................................................................................................................... 1054
<OnRemove> ....................................................................................................................... 1055
<OnShow> ........................................................................................................................... 1056
<OnSuppress> ...................................................................................................................... 1057
<OnUnsuppress> .................................................................................................................. 1058
<Property> ........................................................................................................................... 1059
<TaskGroups> ...................................................................................................................... 1060
<Tasks> ................................................................................................................................ 1061
caption= ............................................................................................................................... 1061
class= ................................................................................................................................... 1062
context= ............................................................................................................................... 1063
contextual= .......................................................................................................................... 1064
icon= .................................................................................................................................... 1065
name= .................................................................................................................................. 1066
version= ............................................................................................................................... 1067
<Workflow> ................................................................................................................................ 1068
<ApplicationTaskLink> .......................................................................................................... 1068
<UserDefinedTask> ............................................................................................................... 1069

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxv
 Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxvi of ANSYS, Inc. and its subsidiaries and affiliates.
Part I: ACT XML Reference
ACT XML Tags
Table 1: XML Tag Listing

<action> (p. 6) No details provided.

<ActionCallback> (p. 9) Class defining the action callback.
<actions> (p. 13) No details provided.
<ActionsView> (p. 17) Class defining a panel to be displayed in the
application.
<Application> (p. 20) Class defining a new application.
<argument> (p. 39) This class defines the Argument XML Tag.
<assembly> (p. 42) Class defining the assembly to be loaded.
<attributes> (p. 46) Class defining the set of attributes for the object.
<BrowserView> (p. 46) Class defining a panel to be displayed in the
application.
<Callback> (p. 47) No details provided.
<CallbackGetCommands> (p. 48) Class providing the commands to add to the solver
input file.
<CallbackGetPostPreSolveCommands> (p. 51) Class collecting all commands to add to the solver
input file.
<CallbackOnActiveObjectChange> (p. 54) Callback that is invoked when the active object
changes.
<Callbacks> (p. 57) Class specifying the callbacks that will invoke
functions from the IronPython extension script.
<Component> (p. 58) Class defining a new component in a layout.
<ComponentData> (p. 80) Class defining the data for the component.
<ComponentDefinition> (p. 81) Class defining the display of the component.
<ComponentStyle> (p. 88) Class defining the styles for the component.
<connectTo> (p. 90) No details provided.
<contextmenus> (p. 92) No details provided.
<ControlTemplate> (p. 93) Class defining a control template for the creation of
groups of properties.
<datamodel> (p. 96) No details provided.
<DataModel> (p. 98) Class defining a data model.
<DataModelView> (p. 100) Class defining a panel to be displayed in the
application.
<DialogProgressMonitorView> (p. 109) No details provided.
<entity> (p. 111) Class defining a custom data entity definition based
on an ACT XML Extension file.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 3
ACT XML Tags

<entry> (p. 138) Class defining a user-interface GUI operatio.

<entry> (p. 146) Class defining a drop-down menu within a toolbar.
<Extension> (p. 152) Class defining an ACT extension.
<ExtensionObject> (p. 172) Class extending the extension object definition.
(Inherited from DesignXplorer SimEntity)
<FileToolbarView> (p. 200) Class defining a panel to be displayed in the
application.
<filter> (p. 202) Class defining a filter for the object.
<Geometry> (p. 204) Class defining a geometry feature.
<guid> (p. 234) Class defining a unique identifier for the extension.
<Image> (p. 236) No details provided.
<ImageDirectory> (p. 245) No details provided.
<includegroup> (p. 246) Class defining the include group tag (used by task
groups).
<includetask> (p. 249) Class defining the include task tag (used by task
groups).
<input> (p. 252) Class defining an input-level data connection
definition.
<inputfile> (p. 255) This class difines the InputFile XML Tag.
<inputFromActionOutput> (p. 257) No details provided.
<inputFromOperator> (p. 260) No details provided.
<inputgroup> (p. 262) Class defining the input group collections for a task.
<inputs> (p. 263) Class defining the inputs collection for a task.
<inputValue> (p. 264) No details provided.
<Interface> (p. 265) Class defining the user interface for the extension.
<Layout> (p. 295) No details provided.
<Layout> (p. 297) Class defining the a new panel layout.
<Layout> (p. 299) No details provided.
<Layout> (p. 300) No details provided.
<License> (p. 302) Class defining a license to be used in the execution
of an extension.
<Licenses> (p. 304) Class defining a licenses collection for the extension.
<Link> (p. 305) Class defining a new application task link.
<Load> (p. 307) Class defining a simulation load or boundary.
<Object> (p. 345) Class defining an object.
<operator> (p. 385) No details provided.
<Optimizer> (p. 388) Class defining an optimizer.
<OrderableCallback> (p. 454) A callback that supports an order specification. Used
when multiple callbacks could apply to the same
entity, allowing a proper "sorting" of execution.
<output> (p. 456) Class defining an output-level data connection
definition.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
4 of ANSYS, Inc. and its subsidiaries and affiliates.
<outputfile> (p. 458) This class defines the OutputFile XML Tag.
<outputs> (p. 460) Class defining the outputs collection for a task.
<Panel> (p. 461) Class defining a panel to be displayed in the
application.
<PanelComponent> (p. 468) No details provided.
<parameter> (p. 491) Class defining a single parameter definition for a task.
<parameters> (p. 519) Class defining the collection of task parameters.
<platform> (p. 520) This class defines the Platform XML Tag.
<Presentations> (p. 522) No details provided.
<ProductDataModelConverter> (p. 524) No details provided.
<ProductTask> (p. 532) Class defining a new user input application task.
<program> (p. 536) This class defines the Program XML Tag.
<projectdata> (p. 537) No details provided.
<property> (p. 538) Class defining a property of any user object.
<propertygroup> (p. 579) Class defining a collection of properties.
<propertytable> (p. 620) Class encapsulateing a list of child properties under
one table.
<Result> (p. 663) Class defining a result.
<rsmjob> (p. 705) This class defines an rsm job.
<Sampling> (p. 739) Class defining a DesignXplorer Sampling.
<Scene> (p. 781) No details provided.
<script> (p. 789) Specifies the IronPython script referenced by the
extension.
<separator> (p. 791) Class defining the separator for items in a toolbar.
<simdata> (p. 792) Class defining a general section that stores all user
object definitions.
<Solver> (p. 794) Class specifying a third-party solver to be used in the
simulation.
<StandardAction> (p. 831) No details provided.
<Step> (p. 834) Class defining a step in a guided process a (wizard or
AIM custom template).
<Target> (p. 871) Class defining the target location for the object.
<task> (p. 874) Class defining a task that encapsulates a single
process or application.
<task> (p. 915) No details provided.
<taskgroup> (p. 918) Class defining a collection of tasks.
<taskgroups> (p. 950) Class defining the task groups collection.
<tasks> (p. 951) Class defining the tasks collection.
<Templates> (p. 952) Class defining a collection of control templates.
<toolbar> (p. 953) Class defining a toolbar in the UI of the application.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 5
ACT XML Tags

<UIDefinition> (p. 956) Class defining a set of interface layouts that can be
used for guided processes (wizards).
<UserDefinedTask> (p. 958) Class defining a new application task.
<UserInputTask> (p. 961) Class defining a new user input application task.
<UserObject> (p. 965) Class defining a user object of the data model.
<UserObjectConverter> (p. 995) No details provided.
<Wizard> (p. 1001) Class defining a guided process (a wizard or AIM
custom template) within the extension.
<Workflow> (p. 1014) Class defining the top-level workflow tag within an
ACT app.
<Workflow> (p. 1068) Class defining a new application workflow.

<action>
No details provided.

Remarks
None.

Examples
None.

Table 2: XML Tag Listing

Tag <ConnectTo> (p. 6) No details

provided.
Tag <InputValue> (p. 7) No details
provided.
Attribute Name= (p. 8) No details
provided.
Attribute Type= (p. 9) No details
provided.

<ConnectTo>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Language_ConnectTo (p. 90)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
6 of ANSYS, Inc. and its subsidiaries and affiliates.
 <action>

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_ConnectTo

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<InputValue>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Language_InputValue (p. 264)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_InputValue

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 7
ACT XML Tags

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

Name=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
Name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Name of the variable associated to this action.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
8 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ActionCallback>

Type=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
Type

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Type of the action.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<ActionCallback>
Class defining the action callback.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 9
ACT XML Tags

Remarks
None.

Examples
None.

Table 3: XML Tag Listing

Attribute caninterrupt= (p. 10) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute caption= (p. 11) No details provided.
Attribute icon= (p. 12) No details provided.
Attribute name= (p. 13) Name of the action callback.

caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
False

Name
caninterrupt

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
10 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ActionCallback>

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

caption=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
caption

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 11
ACT XML Tags

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
icon

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
12 of ANSYS, Inc. and its subsidiaries and affiliates.
 <actions>

name=
Name of the action callback.

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
name

Mandatory
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<actions>
No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 13
ACT XML Tags

Remarks
None.

Examples
None.

Table 4: XML Tag Listing

Tag <Action> (p. 14) No details

provided.
Tag <Operator> (p. 15) No details
provided.
Attribute MainAction= (p. 15) No details
provided.
Attribute Name= (p. 16) No details
provided.

<Action>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Language_Action (p. 6)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_Action

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
14 of ANSYS, Inc. and its subsidiaries and affiliates.
 <actions>

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Operator>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Language_Operator (p. 385)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_Operator

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

MainAction=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 15
ACT XML Tags

Details
Name
MainAction

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Action to execute when the workflow is executed.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Name=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
Name

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
16 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ActionsView>

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Name of the workflow.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<ActionsView>
Class defining a panel to be displayed in the application.

Remarks
None.

Examples
None.

Table 5: XML Tag Listing

Tag <StandardAction> (p. 17) No details provided.

Attribute component= (p. 18) No details provided.
Attribute name= (p. 19) Name of the view. (inherited from
View)

<StandardAction>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Application_StandardAction (p. 831)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 17
ACT XML Tags

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

component=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
component

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
18 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ActionsView>

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the view. (inherited from View)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 19
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Application>
Class defining a new application.

Remarks
The name of the application will be a new context available for customization.

Examples
None.

Table 6: XML Tag Listing

Tag <actions> (p. 21) No details provided.

Tag <ApplicationWorkflow> (p. 22) Defines the workflow to be used by the application.
Tag <Callbacks> (p. 22) Specifies the callbacks that will invoke functions
from the IronPython extension script. (inherited
from BaseApplication)
Callback <canstart> (p. 23) Callback that is invoked to determine whether the
application can be started. (inherited from
BaseApplication)
Tag <DataModel> (p. 24) No details provided.
Tag <Description> (p. 25) Description of the application. (inherited from
BaseApplication)
Callback <OnApplicationFinished> (p. 25) Callback that is invoked after the application
finishes.
Callback <OnApplicationStarted> (p. 26) Callback that is invoked when the application starts.
Callback <OnBeforeProjectClosed> (p. 27) Callback that is invoked before a project is closed.
Callback <OnBeforeSave> (p. 28) Callback that is invoked before a project is saved.
Callback <OnProjectLoaded> (p. 29) Callback that is invoked when a project is loaded
or a new project started.
Tag <Panel> (p. 30) Defines one or more panels to be displayed in the
application.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
20 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Application>

Tag <Presentations> (p. 31) No details provided.

Tag <ProductDataModelConverter> (p. 32) No details provided.
Attribute caption= (p. 32) Caption of the application. (inherited from
BaseApplication)
Attribute class= (p. 33) Class name of the controller of the object.
Attribute context= (p. 34) Context or combination of contexts (separated
using '|'). (inherited from BaseApplication)
Attribute icon= (p. 35) Icon for the application. (inherited from
BaseApplication)
Attribute name= (p. 36) Name of the application. (inherited from
BaseApplication)
Attribute projectExtName= (p. 37) Project extension name for associated project files.
Attribute version= (p. 38) Major version of the application. (inherited from
BaseApplication)
Attribute WorkflowToStart= (p. 38) No details provided.

<actions>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Language_Workflow (p. 13)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 21
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<ApplicationWorkflow>
Defines the workflow to be used by the application.

Type
Ansys_ACT_Core_XmlDataModel_Application_ApplicationWorkflow (p. 1068)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (inherited from
BaseApplication)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
22 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Application>

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<canstart>
Callback that is invoked to determine whether the application can be started. (inherited from BaseApplic-
ation)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_string__bool_

Name
canstart

Public
True

Obsolete
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 23
ACT XML Tags

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<DataModel>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Application_DataModel (p. 98)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_DataModel

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
24 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Application>

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Description>
Description of the application. (inherited from BaseApplication)

Type
System_String

Remarks
None.

Examples
None.

Details
Description
Description of the wizard.

ValueName
description

Name
Description

Public
True

TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

<OnApplicationFinished>
Callback that is invoked after the application finishes.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 25
ACT XML Tags

Details
CallbackType
ActionCallback_Application_

Name
OnApplicationFinished

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnApplicationStarted>
Callback that is invoked when the application starts.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
26 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Application>

Details
CallbackType
ActionCallback_Application_

Name
OnApplicationStarted

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnBeforeProjectClosed>
Callback that is invoked before a project is closed.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 27
ACT XML Tags

Details
CallbackType
ActionCallback_Application_

Name
OnBeforeProjectClosed

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnBeforeSave>
Callback that is invoked before a project is saved.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
28 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Application>

Details
CallbackType
ActionCallback_Application_

Name
OnBeforeSave

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnProjectLoaded>
Callback that is invoked when a project is loaded or a new project started.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 29
ACT XML Tags

Details
CallbackType
ActionCallback_Application_

Name
OnProjectLoaded

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Panel>
Defines one or more panels to be displayed in the application.

Type
Ansys_ACT_Core_XmlDataModel_Application_Panel (p. 461)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
30 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Application>

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Presentations>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Application_Presentations (p. 522)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 31
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<ProductDataModelConverter>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Application_ProductDataModelConverter (p. 524)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the application. (inherited from BaseApplication)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
32 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Application>

Details
Mandatory
False

Name
caption

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

class=
Class name of the controller of the object.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 33
ACT XML Tags

Name
class

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

context=
Context or combination of contexts (separated using '|'). (inherited from BaseApplication)

Type
System_String_ARRAY_

Remarks
This block will be taken into account only for the specified context(s).

Examples
None.

Details
Mandatory
True

Name
context

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
34 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Application>

DataDefinition
False

AllowedValues
None.

MultipleValue
True

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the application. (inherited from BaseApplication)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
icon

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 35
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the application. (inherited from BaseApplication)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
36 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Application>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

projectExtName=
Project extension name for associated project files.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
projectExtName

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 37
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Major version of the application. (inherited from BaseApplication)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
version

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

WorkflowToStart=
No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
38 of ANSYS, Inc. and its subsidiaries and affiliates.
 <argument>

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
WorkflowToStart

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<argument>
This class defines the Argument XML Tag.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 39
ACT XML Tags

Examples
None.

Table 7: XML Tag Listing

Attribute name= (p. 40) The argument name.

Attribute separator= (p. 41) The argument-value
separator.
Attribute value= (p. 42) The argument value.

name=
The argument name.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
40 of ANSYS, Inc. and its subsidiaries and affiliates.
 <argument>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

separator=
The argument-value separator.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
separator

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 41
ACT XML Tags

value=
The argument value.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
value

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<assembly>
Class defining the assembly to be loaded.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
42 of ANSYS, Inc. and its subsidiaries and affiliates.
 <assembly>

Remarks
This tag is typically used to import a specific namespace from a C# dll.

Examples
Example 1:

<assembly src="CSharp.dll" namespace="CSharp" />

Table 8: XML Tag Listing

Attribute context= (p. 43) Context or combination of contexts (separated using '|') for the
import.
Attribute namespace= (p. 44) Namespace to import.
Attribute src= (p. 45) Name of the dll file to import.

context=
Context or combination of contexts (separated using '|') for the import.

Type
System_String

Remarks
This block will be taken into account only for specified context(s).

Examples
None.

Details
Mandatory
False

Name
context

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 43
ACT XML Tags

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

namespace=
Namespace to import.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
namespace

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
44 of ANSYS, Inc. and its subsidiaries and affiliates.
 <assembly>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

src=
Name of the dll file to import.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
src

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 45
ACT XML Tags

<attributes>
Class defining the set of attributes for the object.

Remarks
None.

Examples
None.

<BrowserView>
Class defining a panel to be displayed in the application.

Remarks
None.

Examples
None.

Table 9: XML Tag Listing

Attribute name= (p. 46) Name of the view. (inherited from

View)

name=
Name of the view. (inherited from View)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
46 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Callback>

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Callback>
No details provided.

Remarks
None.

Examples
None.

Table 10: XML Tag Listing

Attribute caninterrupt= (p. 47) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)

caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)

Type
System_Boolean

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 47
ACT XML Tags

Examples
None.

Details
DefaultValue
False

Name
caninterrupt

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<CallbackGetCommands>
Class providing the commands to add to the solver input file.

Remarks
None.

Examples
None.

Table 11: XML Tag Listing

Attribute caninterrupt= (p. 49) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute location= (p. 49) Location of the call.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
48 of ANSYS, Inc. and its subsidiaries and affiliates.
 <CallbackGetCommands>

Attribute order= (p. 50) Order of the call.

caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
caninterrupt

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

location=
Location of the call.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 49
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Name
location

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

order=
Order of the call.

Type
System_Int32

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
50 of ANSYS, Inc. and its subsidiaries and affiliates.
 <CallbackGetPostPreSolveCommands>

Remarks
None.

Examples
None.

Details
Name
order

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<CallbackGetPostPreSolveCommands>
Class collecting all commands to add to the solver input file.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 51
ACT XML Tags

Examples
None.

Table 12: XML Tag Listing

Attribute caninterrupt= (p. 52) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute order= (p. 53) Order of the call.
Attribute timedependent= (p. 54) Specifies if the callback will be called for each step.

caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
caninterrupt

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
52 of ANSYS, Inc. and its subsidiaries and affiliates.
 <CallbackGetPostPreSolveCommands>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

order=
Order of the call.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
order

Mandatory
False

DefaultValue
1

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 53
ACT XML Tags

timedependent=
Specifies if the callback will be called for each step.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
timedependent

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<CallbackOnActiveObjectChange>
Callback that is invoked when the active object changes.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
54 of ANSYS, Inc. and its subsidiaries and affiliates.
 <CallbackOnActiveObjectChange>

Remarks
None.

Examples
None.

Table 13: XML Tag Listing

Attribute caninterrupt= (p. 55) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute name= (p. 56) The name filter.
Attribute type= (p. 57) The type filter.

caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
caninterrupt

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 55
ACT XML Tags

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
The name filter.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
56 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Callbacks>

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

type=
The type filter.

Type
Ansys_ACT_Interfaces_UserObject_ObjectTypeEnum

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
type

DefaultValue
Unknown

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Callbacks>
Class specifying the callbacks that will invoke functions from the IronPython extension script.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 57
ACT XML Tags

Remarks
The <callbacks> element and its children specify the Python functions that are invoked based on system-
and user-generated events.

Examples
None.

Table 14: XML Tag Listing

Tag <Callback> (p. 58) No details

provided.

<Callback>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Callback

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Component>
Class defining a new component in a layout.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
58 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Component>

Remarks
None.

Examples
None.

Table 15: XML Tag Listing

Tag <Attributes> (p. 59) Defines the set of attributes for the
component.
Attribute BottomAttachment= (p. 60) Bottom attachment of the layout.
Attribute BottomOffset= (p. 61) Bottom offset related to the bottom
attachment.
Attribute ComponentType= (p. 62) Type of the component for the component.
Attribute CustomCSSFile= (p. 63) Custom css file for the component layout.
Attribute CustomHTMLFile= (p. 64) Custom html file for the component layout.
Attribute CustomJSFile= (p. 64) Custom jscript file for the component
layout.
Attribute Height= (p. 65) Height value for the component.
Attribute HeightType= (p. 66) Height type for the component.
Attribute LeftAttachment= (p. 67) Left attachment of the layout.
Attribute LeftOffset= (p. 68) Left offset related to the left attachment.
Attribute MaxHeight= (p. 69) Maximum height for the component.
Attribute MaxWidth= (p. 70) Maximum width for the component.
Attribute MinHeight= (p. 71) Minimum height for the component.
Attribute MinWidth= (p. 72) Minimum width for the component.
Attribute name= (p. 73) Name of the component.
Attribute RightAttachment= (p. 73) Right attachment of the layout.
Attribute RightOffset= (p. 74) Right offset related to the right
attachment.
Attribute TopAttachment= (p. 75) Top attachment of the layout.
Attribute TopOffset= (p. 76) Top offset related to the top attachment.
Attribute visible= (p. 77) Initial visibility of the component.
Attribute Width= (p. 78) Width value for the component.
Attribute WidthType= (p. 79) Width type for the component.

<Attributes>
Defines the set of attributes for the component.

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 59
ACT XML Tags

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

BottomAttachment=
Bottom attachment of the layout.

Type
System_String

Remarks
The value can be the name of a component or "" for the border.

Examples
None.

Details
Name
BottomAttachment

Mandatory
False

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
60 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Component>

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

BottomOffset=
Bottom offset related to the bottom attachment.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
BottomOffset

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 61
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

ComponentType=
Type of the component for the component.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
ComponentType

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
62 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Component>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

CustomCSSFile=
Custom css file for the component layout.

Type
System_String

Remarks
This file will be taken in place of the standard one associated to the component.

Examples
None.

Details
Name
CustomCSSFile

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 63
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

CustomHTMLFile=
Custom html file for the component layout.

Type
System_String

Remarks
This file will be taken in place of the standard one associated to the component.

Examples
None.

Details
Name
CustomHTMLFile

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

CustomJSFile=
Custom jscript file for the component layout.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
64 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Component>

Type
System_String

Remarks
This file will be taken in place of the standard one associated to the component.

Examples
None.

Details
Name
CustomJSFile

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Height=
Height value for the component.

Type
System_Single

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 65
ACT XML Tags

Remarks
None.

Examples
None.

Details
Name
Height

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

HeightType=
Height type for the component.

Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
66 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Component>

Examples
None.

Details
Name
HeightType

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

LeftAttachment=
Left attachment of the layout.

Type
System_String

Remarks
The value can be the name of a component or "" for the border.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 67
ACT XML Tags

Details
Name
LeftAttachment

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

LeftOffset=
Left offset related to the left attachment.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
LeftOffset

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
68 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Component>

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

MaxHeight=
Maximum height for the component.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
MaxHeight

Mandatory
False

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 69
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

MaxWidth=
Maximum width for the component.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
MaxWidth

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
70 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Component>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

MinHeight=
Minimum height for the component.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
MinHeight

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 71
ACT XML Tags

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

MinWidth=
Minimum width for the component.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
MinWidth

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
72 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Component>

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the component.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

RightAttachment=
Right attachment of the layout.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 73
ACT XML Tags

Type
System_String

Remarks
The value can be the name of a component or "" for the border.

Examples
None.

Details
Name
RightAttachment

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

RightOffset=
Right offset related to the right attachment.

Type
System_Int32

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
74 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Component>

Remarks
None.

Examples
None.

Details
Name
RightOffset

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

TopAttachment=
Top attachment of the layout.

Type
System_String

Remarks
The value can be the name of a component or "" for the border.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 75
ACT XML Tags

Examples
None.

Details
Name
TopAttachment

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

TopOffset=
Top offset related to the top attachment.

Type
System_Int32

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
76 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Component>

Details
Name
TopOffset

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

visible=
Initial visibility of the component.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
visible

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 77
ACT XML Tags

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
False

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Width=
Width value for the component.

Type
System_Single

Remarks
None.

Examples
None.

Details
Name
Width

Mandatory
True

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
78 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Component>

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

WidthType=
Width type for the component.

Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType

Remarks
None.

Examples
None.

Details
Name
WidthType

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 79
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<ComponentData>
Class defining the data for the component.

Remarks
None.

Examples
None.

Table 16: XML Tag Listing

Attribute component= (p. 80) No details

provided.

component=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
80 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ComponentDefinition>

Name
component

Mandatory
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<ComponentDefinition>
Class defining the display of the component.

Remarks
None.

Examples
None.

Table 17: XML Tag Listing

Attribute Class= (p. 82) Class to control this component.

Attribute CSSFile= (p. 82) Default CSS file to use for this component.
Attribute DataModelClass= (p. 83) Class type that describes the data model of the
component
Attribute Directory= (p. 84) Directory where are located HTML, CSS and JS files
Attribute HTMLFile= (p. 85) Default HTML file to use for this component.
Attribute JSFile= (p. 86) Default JS file to use for this component.
Attribute Name= (p. 87) Name of the component definition.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 81
ACT XML Tags

Class=
Class to control this component.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
Class

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

CSSFile=
Default CSS file to use for this component.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
82 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ComponentDefinition>

Type
System_String

Remarks
None.

Examples
None.

Details
Name
CSSFile

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

DataModelClass=
Class type that describes the data model of the component

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 83
ACT XML Tags

Remarks
None.

Examples
None.

Details
Name
DataModelClass

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Directory=
Directory where are located HTML, CSS and JS files

Type
System_String

Remarks
By default it is the directory of the extension if defined in an extension and "...ACT/html" if not.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
84 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ComponentDefinition>

Examples
None.

Details
Name
Directory

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

HTMLFile=
Default HTML file to use for this component.

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 85
ACT XML Tags

Details
Name
HTMLFile

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

JSFile=
Default JS file to use for this component.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
JSFile

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
86 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ComponentDefinition>

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Name=
Name of the component definition.

Type
System_String

Remarks
This will identify the component type.

Examples
None.

Details
Name
Name

Mandatory
True

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 87
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<ComponentStyle>
Class defining the styles for the component.

Remarks
None.

Examples
None.

Table 18: XML Tag Listing

Attribute component= (p. 88) Name of the component for which styles are being
defined.
Attribute filter= (p. 89) Filter for the component styles.

component=
Name of the component for which styles are being defined.

Type
System_String

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
88 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ComponentStyle>

Examples
None.

Details
Name
component

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

filter=
Filter for the component styles.

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 89
ACT XML Tags

Details
Name
filter

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<connectTo>
No details provided.

Remarks
None.

Examples
None.

Table 19: XML Tag Listing

Attribute action= (p. 90) No details

provided.
Attribute event= (p. 91) No details
provided.

action=
No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
90 of ANSYS, Inc. and its subsidiaries and affiliates.
 <connectTo>

Type
System_String

Remarks
None.

Examples
None.

Details
Name
action

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Action to connect to.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

event=
No details provided.

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 91
ACT XML Tags

Remarks
None.

Examples
None.

Details
Name
event

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Event to connect to.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<contextmenus>
No details provided.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
92 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ControlTemplate>

Examples
None.

Table 20: XML Tag Listing

Tag <UIEntry> (p. 93) No details

provided.

<UIEntry>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_UIEntry (p. 138)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_UIEntry

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<ControlTemplate>
Class defining a control template for the creation of groups of properties.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 93
ACT XML Tags

Examples
None.

Table 21: XML Tag Listing

Tag <Property> (p. 94) No details provided.

Attribute name= (p. 94) Name of the control
template.
Attribute version= (p. 95) Version of the control
template.

<Property>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

name=
Name of the control template.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
94 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ControlTemplate>

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the control template.

Type
System_Int32

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 95
ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
version

DefaultValue
1

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<datamodel>
No details provided.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
96 of ANSYS, Inc. and its subsidiaries and affiliates.
 <datamodel>

Examples
None.

Table 22: XML Tag Listing

Attribute name= (p. 97) The name of the data

model.

name=
The name of the data model.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 97
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<DataModel>
Class defining a data model.

Remarks
None.

Examples
None.

Table 23: XML Tag Listing

Tag <UserObject> (p. 98) No details

provided.
Attribute icon= (p. 99) Icon of the data
model.
Attribute name= (p. 100) Name of the data
model.

<UserObject>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Application_UserObject (p. 965)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_UserObject

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
98 of ANSYS, Inc. and its subsidiaries and affiliates.
 <DataModel>

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

icon=
Icon of the data model.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
icon

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 99
ACT XML Tags

name=
Name of the data model.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<DataModelView>
Class defining a panel to be displayed in the application.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
100 of ANSYS, Inc. and its subsidiaries and affiliates.
 <DataModelView>

Remarks
None.

Examples
None.

Table 24: XML Tag Listing

Attribute chartComponent= (p. 101) No details provided.

Attribute dataModel= (p. 102) No details provided.
Attribute imageComponent= (p. 103) No details provided.
Attribute name= (p. 104) Name of the view. (inherited from
View)
Attribute presentation= (p. 105) No details provided.
Attribute propertiesComponent= (p. 105) No details provided.
Attribute sceneComponent= (p. 106) No details provided.
Attribute tabularComponent= (p. 107) No details provided.
Attribute treeComponent= (p. 108) No details provided.

chartComponent=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
chartComponent

DefaultValue
None.

DataDefinition
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 101
ACT XML Tags

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

dataModel=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
dataModel

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
102 of ANSYS, Inc. and its subsidiaries and affiliates.
 <DataModelView>

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

imageComponent=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
imageComponent

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 103
ACT XML Tags

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the view. (inherited from View)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
104 of ANSYS, Inc. and its subsidiaries and affiliates.
 <DataModelView>

presentation=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
presentation

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

propertiesComponent=
No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 105
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
propertiesComponent

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

sceneComponent=
No details provided.

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
106 of ANSYS, Inc. and its subsidiaries and affiliates.
 <DataModelView>

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
sceneComponent

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

tabularComponent=
No details provided.

Type
System_String

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 107
ACT XML Tags

Examples
None.

Details
Mandatory
False

Name
tabularComponent

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

treeComponent=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
108 of ANSYS, Inc. and its subsidiaries and affiliates.
 <DialogProgressMonitorView>

Details
Mandatory
False

Name
treeComponent

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<DialogProgressMonitorView>
No details provided.

Remarks
None.

Examples
None.

Table 25: XML Tag Listing

Tag <task> (p. 109) No details provided.

Attribute name= (p. 110) Name of the view. (inherited from
View)

<task>
No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 109
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Application_ProgressMonitorTask (p. 915)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

name=
Name of the view. (inherited from View)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
110 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<entity>
Class defining a custom data entity definition based on an ACT XML Extension file.

Remarks
None.

Examples
None.

Table 26: XML Tag Listing

Tag <Attributes> (p. 112) No details provided. (inherited from SimEntity)

Tag <Callbacks> (p. 113) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 114) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 115) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 116) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Callback <IsValid> (p. 117) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 111
ACT XML Tags

Callback <OnAdd> (p. 118) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 119) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 119) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 120) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 121) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 122) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 123) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 124) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 125) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 126) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 127) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 128) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 129) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 130) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 131) No details provided. (inherited from SimEntity)
Attribute caption= (p. 132) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 133) Class name of the controller of the object.
(inherited from SimEntity)
Attribute contextual= (p. 134) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute datatype= (p. 135) Data type representing the schematic-exposed
type for which this data entity represents.
Attribute icon= (p. 136) Icon for the object. (inherited from SimEntity)
Attribute name= (p. 136) Name of the object. (inherited from SimEntity)
Attribute version= (p. 137) Version of the object. (inherited from SimEntity)

<Attributes>
No details provided. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
112 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 113
ACT XML Tags

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
114 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 115
ACT XML Tags

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
116 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 117
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
118 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 119
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
120 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 121
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
122 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 123
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
124 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 125
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
126 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 127
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
128 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 129
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
130 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 131
ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
caption

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
132 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
Mandatory
False

Name
class

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 133
ACT XML Tags

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
Mandatory
False

Name
contextual

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
134 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

datatype=
Data type representing the schematic-exposed type for which this data entity represents.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
datatype

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 135
ACT XML Tags

icon=
Icon for the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
icon

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
136 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entity>

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 137
ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
version

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<entry>
Class defining a user-interface GUI operatio.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
138 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entry>

Examples
None.

Table 27: XML Tag Listing

Tag <Callbacks> (p. 139) Callbacks

Callback <onclick> (p. 140) Callback that is invoked on click.
Attribute caption= (p. 141) Display text of GUI operation.
Attribute icon= (p. 141) Icon for the object.
Attribute name= (p. 142) Name of GUI operation.
Attribute priority= (p. 143) UI-level priority (for grouping and ordering
purposes)
Attribute type= (p. 144) Type of GUI operation.
Attribute version= (p. 145) Version of GUI operation...for backwards
compatiblity

<Callbacks>
Callbacks

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 139
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<onclick>
Callback that is invoked on click.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_

Name
onclick

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
140 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entry>

caption=
Display text of GUI operation.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
caption

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 141
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Name
icon

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of GUI operation.

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
142 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entry>

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

priority=
UI-level priority (for grouping and ordering purposes)

Type
System_Single

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 143
ACT XML Tags

Examples
None.

Details
Name
priority

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

type=
Type of GUI operation.

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
144 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entry>

Details
Name
type

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of GUI operation...for backwards compatiblity

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
version

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 145
ACT XML Tags

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<entry>
Class defining a drop-down menu within a toolbar.

Remarks
To create a drop-down menu inside a toolbar, an entry has to be created inside another entry.

Examples
None.

Table 28: XML Tag Listing

Tag <Callbacks> (p. 147) Specifies the callbacks that will invoke functions from the IronPython
extension script.
Tag <Entry> (p. 147) No details provided.
Callback <OnClick> (p. 148) Callback that is invoked to return when the object is clicked.
Attribute caption= (p. 149) Caption of the entry.
Attribute Icon= (p. 150) Icon of the entry.
Attribute name= (p. 151) Name of the entry.
Attribute userobject= (p. 152) Related user object name.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
146 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entry>

<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script.

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Entry>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Entry (p. 146)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 147
ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Entry

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<OnClick>
Callback that is invoked to return when the object is clicked.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IDataModelObject_

Name
OnClick

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
148 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entry>

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

caption=
Caption of the entry.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
caption

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 149
ACT XML Tags

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Icon=
Icon of the entry.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
Icon

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
150 of ANSYS, Inc. and its subsidiaries and affiliates.
 <entry>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the entry.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 151
ACT XML Tags

userobject=
Related user object name.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
userobject

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Extension>
Class defining an ACT extension.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
152 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Extension>

Remarks
This is the base tag or "root" element under which all other tags/elements fall.

Examples
None.

Table 29: XML Tag Listing

Tag <Application> (p. 154) Defines one or more ACT applications that will be posted to
the ANSYS App Store.
Tag <appStoreId> (p. 154) Defines a unique identifier for the ACT application, to be used
in the ANSYS App Store.
Tag <assembly> (p. 155) Defines one or more assemblies to be loaded.
Tag <author> (p. 156) Defines the author of the extension.
Tag <description> (p. 156) Defines the description of the extension.
Tag <Guid> (p. 157) Defines a unique identifier for the extension.
Tag <ImageDirectory> (p. 157) Add a folder to find images.
Tag <Interface> (p. 158) Defines one or more the user interfaces for the extension.
Tag <Licenses> (p. 159) Defines a licenses collection for the extension.
Tag <script> (p. 159) Specifies one or more IronPython scripts referenced by the
extension.
Tag <simdata> (p. 160) Defines one or more general sections that store all user object
definitions.
Tag <Templates> (p. 161) Defines a collection of control templates for the extension.
Tag <UIDefinition> (p. 161) Defines one or more user interfaces for the extension.
Tag <Wizard> (p. 162) Defines one or more wizards within the extension.
Tag <Workflow> (p. 163) Defines one or more user-defined custom workflows composed
of tasks and task groups.
Attribute debug= (p. 163) To start this extension in debug mode if in scripted mode.
Attribute icon= (p. 164) Icon for the extension.
Attribute isNative= (p. 165) Specifies if the extension is native, in that case migration
messages are ignored.
Attribute loadAsDefault= (p. 166) Specifies if the extension should be loaded automatically.
Attribute masked= (p. 167) Specifies if the extension should be loaded automatically, but
hidden in the Extension Manager.
Attribute minorversion= (p. 168) Minor version of the extension.
Attribute name= (p. 169) Name of the extension.
Attribute ReadPythonFiles= (p. 170) Primarly used by the AppBuilder to not read the python file
but used file that are already read and modified. ! Not Public !
Attribute version= (p. 171) Major version of the extension.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 153
ACT XML Tags

<Application>
Defines one or more ACT applications that will be posted to the ANSYS App Store.

Type
Ansys_ACT_Core_XmlDataModel_Application_CustomApplication (p. 20)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<appStoreId>
Defines a unique identifier for the ACT application, to be used in the ANSYS App Store.

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
154 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Extension>

Details
Description
Unique identifier of the application for the ANSYS App Store. The format must be: author_shortname.

Name
appStoreId

ValueName
appStoreId

Public
True

TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

<assembly>
Defines one or more assemblies to be loaded.

Type
Ansys_ACT_Core_XmlDataModel_Assembly (p. 42)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 155
ACT XML Tags

<author>
Defines the author of the extension.

Type
System_String

Remarks
None.

Examples
None.

Details
Description
Author of the extension.

Name
author

ValueName
authorName

Public
True

TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

<description>
Defines the description of the extension.

Type
System_String

Remarks
None.

Examples
None.

Details
Description
Description of the extension.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
156 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Extension>

Name
description

ValueName
description

Public
True

TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

<Guid>
Defines a unique identifier for the extension.

Type
Ansys_ACT_Core_XmlDataModel_Guid (p. 234)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<ImageDirectory>
Add a folder to find images.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 157
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_ImageDirectory (p. 245)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Interface>
Defines one or more the user interfaces for the extension.

Type
Ansys_ACT_Core_XmlDataModel_Interface (p. 265)

Remarks
None.

Examples
None.

Details
ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
158 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Extension>

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Licenses>
Defines a licenses collection for the extension.

Type
Ansys_ACT_Core_XmlDataModel_Licenses (p. 304)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<script>
Specifies one or more IronPython scripts referenced by the extension.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 159
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Script (p. 789)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<simdata>
Defines one or more general sections that store all user object definitions.

Type
Ansys_ACT_Core_XmlDataModel_SimData (p. 792)

Remarks
None.

Examples
None.

Details
ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
160 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Extension>

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Templates>
Defines a collection of control templates for the extension.

Type
Ansys_ACT_Core_XmlDataModel_Templates (p. 952)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<UIDefinition>
Defines one or more user interfaces for the extension.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 161
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_UI_UIDefinition (p. 956)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Wizard>
Defines one or more wizards within the extension.

Type
Ansys_ACT_Core_XmlDataModel_Wizard (p. 1001)

Remarks
None.

Examples
None.

Details
ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
162 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Extension>

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Workflow>
Defines one or more user-defined custom workflows composed of tasks and task groups.

Type
Ansys_ACT_Core_XmlDataModel_Workflow (p. 1014)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

debug=
To start this extension in debug mode if in scripted mode.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 163
ACT XML Tags

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
debug

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the extension.

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
164 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Extension>

Remarks
None.

Examples
None.

Details
Name
icon

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

isNative=
Specifies if the extension is native, in that case migration messages are ignored.

Type
System_Boolean

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 165
ACT XML Tags

Examples
None.

Details
Name
isNative

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
False

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

loadAsDefault=
Specifies if the extension should be loaded automatically.

Type
System_Boolean

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
166 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Extension>

Details
Name
loadAsDefault

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
False

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

masked=
Specifies if the extension should be loaded automatically, but hidden in the Extension Manager.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
masked

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 167
ACT XML Tags

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
False

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

minorversion=
Minor version of the extension.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
minorversion

Mandatory
False

DefaultValue
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
168 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Extension>

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the extension.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 169
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

ReadPythonFiles=
Primarly used by the AppBuilder to not read the python file but used file that are already read and
modified. ! Not Public !

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
ReadPythonFiles

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
170 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Extension>

Public
False

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Major version of the extension.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
version

Mandatory
False

DefaultValue
1

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 171
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<ExtensionObject>
Class extending the extension object definition. (Inherited from DesignXplorer SimEntity)

Remarks
None.

Examples
None.

Table 30: XML Tag Listing

Tag <Attributes> (p. 173) No details provided. (inherited from SimEntity)

Tag <Callbacks> (p. 174) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 174) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 175) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 176) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Callback <HostObjectModified> (p. 177) Callback that is invoked to return when the
properties of host object have changed.
Callback <IsValid> (p. 178) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 179) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 180) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 181) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 182) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 183) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 184) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 185) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 186) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 187) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
172 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Callback <OnReady> (p. 188) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 189) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 190) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 191) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 192) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 193) No details provided. (inherited from SimEntity)
Tag <Target> (p. 194) Defines the target location for the object.
Attribute caption= (p. 195) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 195) Class name of the controller of the object.
(inherited from SimEntity)
Attribute contextual= (p. 196) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 197) Icon for the object. (inherited from SimEntity)
Attribute name= (p. 198) Name of the object. (inherited from SimEntity)
Attribute version= (p. 199) Version of the object. (inherited from SimEntity)

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 173
ACT XML Tags

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
174 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 175
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
176 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<HostObjectModified>
Callback that is invoked to return when the properties of host object have changed.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 177
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
HostObjectModified

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
178 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 179
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
180 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 181
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
182 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 183
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
184 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 185
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
186 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 187
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
188 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 189
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
190 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 191
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
192 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 193
ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Target>
Defines the target location for the object.

Type
Ansys_ACT_Core_XmlDataModel_Target (p. 871)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
194 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
caption

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 195
ACT XML Tags

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
Mandatory
False

Name
class

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
196 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
Mandatory
False

Name
contextual

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object. (inherited from SimEntity)

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 197
ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
icon

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
198 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ExtensionObject>

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 199
ACT XML Tags

Details
Mandatory
True

Name
version

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<FileToolbarView>
Class defining a panel to be displayed in the application.

Remarks
None.

Examples
None.

Table 31: XML Tag Listing

Attribute buttonsComponent= (p. 200) No details provided.

Attribute name= (p. 201) Name of the view. (inherited from
View)

buttonsComponent=
No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
200 of ANSYS, Inc. and its subsidiaries and affiliates.
 <FileToolbarView>

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
buttonsComponent

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the view. (inherited from View)

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 201
ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<filter>
Class defining a filter for the object.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
202 of ANSYS, Inc. and its subsidiaries and affiliates.
 <filter>

Examples
None.

Table 32: XML Tag Listing

Attribute name= (p. 203) Name of the filter.

Attribute src= (p. 204) Specifies the path of the reference IronPython
script.

name=
Name of the filter.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 203
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

src=
Specifies the path of the reference IronPython script.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
src

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Geometry>
Class defining a geometry feature.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
204 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

Remarks
None.

Examples
None.

Table 33: XML Tag Listing

Tag <Attributes> (p. 206) No details provided. (inherited from SimEntity)

Tag <Callbacks> (p. 207) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 207) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 208) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 209) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Callback <IsValid> (p. 210) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 211) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGenerate> (p. 212) Callback that is invoked at the end of the
generation process.
Callback <OnAfterGeometryUpdate> (p. 213) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 214) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 215) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 216) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnEdit> (p. 217) Callback that is invoked when the object is edited.
Callback <OnGenerate> (p. 218) Callback that is invoked when the object is
generated.
Callback <OnGenerateData> (p. 219) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 220) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 221) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 222) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 223) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 205
ACT XML Tags

Callback <OnRemove> (p. 224) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 225) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 226) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 227) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 228) No details provided. (inherited from SimEntity)
Attribute caption= (p. 229) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 230) Class name of the controller of the object.
(inherited from SimEntity)
Attribute contextual= (p. 231) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 232) Icon for the object. (inherited from SimEntity)
Attribute name= (p. 233) Name of the object. (inherited from SimEntity)
Attribute version= (p. 233) Version of the object. (inherited from SimEntity)

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
206 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 207
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
208 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 209
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
210 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 211
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAfterGenerate>
Callback that is invoked at the end of the generation process.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
212 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

Details
CallbackType
ActionCallback_IUserObject_

Name
OnAfterGenerate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 213
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
214 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 215
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
216 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnEdit>
Callback that is invoked when the object is edited.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 217
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
OnEdit

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnGenerate>
Callback that is invoked when the object is generated.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
218 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnGenerate

Name
OnGenerate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 219
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
220 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 221
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
222 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 223
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
224 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 225
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
226 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 227
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
228 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
caption

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 229
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
Mandatory
False

Name
class

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
230 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
Mandatory
False

Name
contextual

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 231
ACT XML Tags

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
icon

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
232 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Geometry>

name=
Name of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 233
ACT XML Tags

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
version

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<guid>
Class defining a unique identifier for the extension.

Remarks
The GUID is he unique identifier of the extension. Two extensions with the same GUID will be considered
by ACT as the same extension.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
234 of ANSYS, Inc. and its subsidiaries and affiliates.
 <guid>

This is very important when the extension is deployed to ensure that two different extensions will
never be in conflict (have the same name, for example).

This identifier must be added at least before the first build of the extension and must never changed
after that. When the extension is updated, a new version created, or features added... the GUID must
be kept unchanged.

Examples
Example 1: A GUID can be generated from the project's page command window using the following
code:

import System
System.Guid.NewGuid().ToString()

Table 34: XML Tag Listing

Attribute shortid= (p. 235) Short identifier for backward

compatibility.

shortid=
Short identifier for backward compatibility.

Type
System_String

Remarks
Must be the same as the extension name for all extensions created before R15.

Examples
None.

Details
Name
shortid

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 235
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Image>
No details provided.

Remarks
None.

Examples
None.

Table 35: XML Tag Listing

Tag <Callbacks> (p. 236) Specifies the callbacks that will invoke functions from the
IronPython extension script. (inherited from Presentation)
Callback <OnAdd> (p. 237) No details provided. (inherited from Presentation)
Callback <OnDelete> (p. 238) No details provided. (inherited from Presentation)
Callback <OnHighlight> (p. 239) No details provided. (inherited from Presentation)
Callback <OnUnhighlight> (p. 240) No details provided. (inherited from Presentation)
Callback <OnUpdate> (p. 241) No details provided. (inherited from Presentation)
Attribute allowHighlight= (p. 242) No details provided. (inherited from Presentation)
Attribute FileNameProperty= (p. 243) No details provided.
Attribute userObject= (p. 244) No details provided. (inherited from Presentation)
Attribute visibility= (p. 244) No details provided. (inherited from Presentation)

<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (inherited from
Presentation)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
236 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Image>

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<OnAdd>
No details provided. (inherited from Presentation)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPresentation_

Name
OnAdd

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 237
ACT XML Tags

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnDelete>
No details provided. (inherited from Presentation)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPresentation_

Name
OnDelete

Public
True

Obsolete
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
238 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Image>

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnHighlight>
No details provided. (inherited from Presentation)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPresentation_

Name
OnHighlight

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 239
ACT XML Tags

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnUnhighlight>
No details provided. (inherited from Presentation)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPresentation_

Name
OnUnhighlight

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
240 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Image>

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnUpdate>
No details provided. (inherited from Presentation)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPresentation_

Name
OnUpdate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 241
ACT XML Tags

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

allowHighlight=
No details provided. (inherited from Presentation)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
allowHighlight

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
242 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Image>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

FileNameProperty=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
FileNameProperty

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 243
ACT XML Tags

userObject=
No details provided. (inherited from Presentation)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
userObject

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

visibility=
No details provided. (inherited from Presentation)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
244 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ImageDirectory>

Type
Ansys_ACT_Interfaces_Presentations_VisibilityOptions

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
visibility

DefaultValue
Always

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<ImageDirectory>
No details provided.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 245
ACT XML Tags

Examples
None.

<includegroup>
Class defining the include group tag (used by task groups).

Remarks
None.

Examples
None.

Table 36: XML Tag Listing

Attribute caption= (p. 246) The caption of the item to include. (inherited from IncludeTag)
Attribute external= (p. 247) Indicates whether the included item is defined outside of the extension
file. (inherited from IncludeTag)
Attribute name= (p. 248) Name of the item to include. (inherited from IncludeTag)

caption=
The caption of the item to include. (inherited from IncludeTag)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
caption

DefaultValue
None.

DataDefinition
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
246 of ANSYS, Inc. and its subsidiaries and affiliates.
 <includegroup>

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

external=
Indicates whether the included item is defined outside of the extension file. (inherited from IncludeTag)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
external

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 247
ACT XML Tags

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the item to include. (inherited from IncludeTag)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
248 of ANSYS, Inc. and its subsidiaries and affiliates.
 <includetask>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<includetask>
Class defining the include task tag (used by task groups).

Remarks
None.

Examples
None.

Table 37: XML Tag Listing

Attribute caption= (p. 249) The caption of the item to include. (inherited from IncludeTag)
Attribute external= (p. 250) Indicates whether the included item is defined outside of the extension
file. (inherited from IncludeTag)
Attribute name= (p. 251) Name of the item to include. (inherited from IncludeTag)

caption=
The caption of the item to include. (inherited from IncludeTag)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
caption

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 249
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

external=
Indicates whether the included item is defined outside of the extension file. (inherited from IncludeTag)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
external

DefaultValue
False

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
250 of ANSYS, Inc. and its subsidiaries and affiliates.
 <includetask>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the item to include. (inherited from IncludeTag)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 251
ACT XML Tags

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<input>
Class defining an input-level data connection definition.

Remarks
None.

Examples
None.

Table 38: XML Tag Listing

Attribute count= (p. 252) Maximum number of simultaneous input

instances.
Attribute format= (p. 253) Connection format type. (inherited from
IOItem)
Attribute type= (p. 254) Connection data type. (inherited from IOItem)

count=
Maximum number of simultaneous input instances.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
count

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
252 of ANSYS, Inc. and its subsidiaries and affiliates.
 <input>

DefaultValue
-1

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

format=
Connection format type. (inherited from IOItem)

Type
System_String

Remarks
This is used by upstream tasks or your task to determine what "specialized" format should be produced
for the more general "Type" property.

Examples
None.

Details
Mandatory
False

Name
format

DefaultValue
None.

DataDefinition
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 253
ACT XML Tags

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

type=
Connection data type. (inherited from IOItem)

Type
System_String

Remarks
Used to specify the input and output exposed object types for a task.

Examples
None.

Details
Mandatory
False

Name
type

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
254 of ANSYS, Inc. and its subsidiaries and affiliates.
 <inputfile>

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<inputfile>
This class difines the InputFile XML Tag.

Remarks
None.

Examples
None.

Table 39: XML Tag Listing

Attribute id= (p. 255) The unique file id. (inherited

from File)
Attribute name= (p. 256) The file name. (inherited from
File)

id=
The unique file id. (inherited from File)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 255
ACT XML Tags

Name
id

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
The file name. (inherited from File)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
256 of ANSYS, Inc. and its subsidiaries and affiliates.
 <inputFromActionOutput>

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<inputFromActionOutput>
No details provided.

Remarks
None.

Examples
None.

Table 40: XML Tag Listing

Attribute action= (p. 257) No details provided.

Attribute Name= (p. 258) No details provided. (inherited from
Input)
Attribute output= (p. 259) No details provided.

action=
No details provided.

Type
System_String

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 257
ACT XML Tags

Examples
None.

Details
Name
action

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Name of action.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Name=
No details provided. (inherited from Input)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
258 of ANSYS, Inc. and its subsidiaries and affiliates.
 <inputFromActionOutput>

Details
Name
Name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Name of the input.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

output=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
output

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 259
ACT XML Tags

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Name of the output.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<inputFromOperator>
No details provided.

Remarks
None.

Examples
None.

Table 41: XML Tag Listing

Attribute Name= (p. 260) No details provided. (inherited from

Input)
Attribute operator= (p. 261) No details provided.

Name=
No details provided. (inherited from Input)

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
260 of ANSYS, Inc. and its subsidiaries and affiliates.
 <inputFromOperator>

Remarks
None.

Examples
None.

Details
Name
Name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Name of the input.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

operator=
No details provided.

Type
System_String

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 261
ACT XML Tags

Examples
None.

Details
Name
operator

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Name of the operator.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<inputgroup>
Class defining the input group collections for a task.

Remarks
None.

Examples
None.

Table 42: XML Tag Listing

Tag <Input> (p. 263) No details

provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
262 of ANSYS, Inc. and its subsidiaries and affiliates.
 <inputs>

<Input>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Input (p. 252)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Input

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<inputs>
Class defining the inputs collection for a task.

Remarks
None.

Examples
None.

Table 43: XML Tag Listing

Tag <InputGroup> (p. 264) No details

provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 263
ACT XML Tags

<InputGroup>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_InputGroup (p. 262)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_InputGroup

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<inputValue>
No details provided.

Remarks
None.

Examples
None.

Table 44: XML Tag Listing

Attribute Name= (p. 265) No details provided. (inherited from

Input)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
264 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Name=
No details provided. (inherited from Input)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
Name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Name of the input.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Interface>
Class defining the user interface for the extension.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 265
ACT XML Tags

Remarks
This interface element information pertains specifically to the GUI.

Examples
None.

Table 45: XML Tag Listing

Tag <Callbacks> (p. 267) No details provided.

Tag <filter> (p. 267) Defines one or more filters.
Callback <GetPostCommands> (p. 268) Called to collect all "post" commands to add to
the solver input file.
Callback <GetPreCommands> (p. 269) Called to collect all "pre" commands to add to the
solver input file.
Callback <GetSolveCommands> (p. 270) Called to collect all "solve" commands to add to
the solver input file.
Tag <images> (p. 271) Defines the default folder where images to be
used by the extension are stored.
Callback <IsAnalysisValid> (p. 271) Called to know if an analysis is valid.
Callback <OnActiveObjectChange> (p. 272) Called when the active object change.
Callback <OnAfterGeometryUpdate> (p. 273) OnAfterGeometryUpdate.
Callback <OnAfterRemove> (p. 274) OnAfterRemove.
Callback <OnAfterSolve> (p. 275) Called when an analysis has been solved.
Callback <OnBeforeGeometryUpdate> (p. 276) OnBeforeGeometryUpdate.
Callback <OnBeforeSolve> (p. 277) Called when an analysis starts to solve.
Callback <OnBodySuppressStateChange> (p. 278) Called when the body suppress state change.
Callback <OnDraw> (p. 279) Called when the application is drawn.
Callback <OnDraw2D> (p. 280) Called when the application is drawn.
Callback <OnInit> (p. 281) Called when the given context is initialized.
Callback <OnLoad> (p. 282) Called when a project is loaded.
Callback <OnMeshCleaned> (p. 283) Called when the mesh is cleaned.
Callback <OnMeshGenerated> (p. 284) Called when the mesh is generated.
Callback <OnPostFinished> (p. 285) Called when the post process end for a given
analysis.
Callback <OnPostStarted> (p. 286) Called when the post process start for a given
analysis.
Callback <OnReady> (p. 287) OnReady.
Callback <OnSave> (p. 288) Called when a project is saved.
Callback <OnTerminate> (p. 289) Called when the given context is terminated.
Callback <OnUnitsChanged> (p. 290) OnUnitsChanged. Called when the unit system
changes.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
266 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Callback <Resume> (p. 291) Called when a project is loaded. Usefull to retreive
aditional data.
Callback <Save> (p. 292) Called when a project is saved. Usefull to save
aditional data.
Tag <toolbar> (p. 293) Defines one or more toolbars.
Attribute context= (p. 294) Context or combination of contexts (separated
using '|') for the interface.

<Callbacks>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<filter>
Defines one or more filters.

Type
Ansys_ACT_Core_XmlDataModel_Filter (p. 202)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 267
ACT XML Tags

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<GetPostCommands>
Called to collect all "post" commands to add to the solver input file.

Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 51)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetAnalysisSolveCommands

Name
GetPostCommands

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
268 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Obsolete
True

ObsoleteMessage
Use 'getcommands' callback with location="post".

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<GetPreCommands>
Called to collect all "pre" commands to add to the solver input file.

Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 51)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetAnalysisSolveCommands

Name
GetPreCommands

Public
True

Obsolete
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 269
ACT XML Tags

ObsoleteMessage
Use 'getcommands' callback with location="pre".

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<GetSolveCommands>
Called to collect all "solve" commands to add to the solver input file.

Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 51)

Remarks
If timeDependent is true, the callback take as argument : analysis, step, stream

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetAnalysisSolveCommands

Name
GetSolveCommands

Public
True

Obsolete
True

ObsoleteMessage
Use 'getcommands' callback with location="solve".

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
270 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<images>
Defines the default folder where images to be used by the extension are stored.

Type
System_String

Remarks
By default, all folders referenced by this tag are relatives to the folder of the extension.

Examples
None.

Details
Description
Add a folder to find images.

Name
images

ValueName
None.

Public
True

TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

<IsAnalysisValid>
Called to know if an analysis is valid.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 271
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsAnalysisValid

Name
IsAnalysisValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnActiveObjectChange>
Called when the active object change.

Type
Ansys_ACT_Core_XmlDataModel_CallbackOnActiveObjectChange (p. 54)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
272 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActiveObjectChanged

Name
OnActiveObjectChange

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAfterGeometryUpdate>
OnAfterGeometryUpdate.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 273
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAfterRemove>
OnAfterRemove.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
274 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterRemove

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAfterSolve>
Called when an analysis has been solved.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 275
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolveAnalysis

Name
OnAfterSolve

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnBeforeGeometryUpdate>
OnBeforeGeometryUpdate.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
276 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnBeforeGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnBeforeSolve>
Called when an analysis starts to solve.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 277
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolveAnalysis

Name
OnBeforeSolve

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnBodySuppressStateChange>
Called when the body suppress state change.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
278 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnDraw>
Called when the application is drawn.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 279
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDraw

Name
OnDraw

Public
False

Obsolete
True

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnDraw2D>
Called when the application is drawn.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
280 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDraw

Name
OnDraw2D

Public
False

Obsolete
True

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnInit>
Called when the given context is initialized.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 281
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInit

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnLoad>
Called when a project is loaded.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
282 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnLoadSave

Name
OnLoad

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnMeshCleaned>
Called when the mesh is cleaned.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 283
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnMeshCleaned

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnMeshGenerated>
Called when the mesh is generated.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
284 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnMeshGenerated

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnPostFinished>
Called when the post process end for a given analysis.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 285
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolveAnalysis

Name
OnPostFinished

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnPostStarted>
Called when the post process start for a given analysis.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
286 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolveAnalysis

Name
OnPostStarted

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
OnReady.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 287
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnSave>
Called when a project is saved.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
288 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnLoadSave

Name
OnSave

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnTerminate>
Called when the given context is terminated.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 289
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInit

Name
OnTerminate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnUnitsChanged>
OnUnitsChanged. Called when the unit system changes.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
290 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnUnitsChanged

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Resume>
Called when a project is loaded. Usefull to retreive aditional data.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 291
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ResumeExt

Name
Resume

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Save>
Called when a project is saved. Usefull to save aditional data.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
292 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Interface>

Details
CallbackType
Ansys_ACT_Core_Callbacks_SaveExt

Name
Save

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<toolbar>
Defines one or more toolbars.

Type
Ansys_ACT_Core_XmlDataModel_Toolbar (p. 953)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 293
ACT XML Tags

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

context=
Context or combination of contexts (separated using '|') for the interface.

Type
System_String_ARRAY_

Remarks
This interface block will be taken into account only for specified context(s).

Examples
None.

Details
Name
context

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
294 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Layout>

MultipleValue
True

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Layout>
No details provided.

Remarks
None.

Examples
None.

Table 46: XML Tag Listing

Tag <Component> (p. 295) Defines the component for which the panel layout is being defined.
(inherited from Layout)
Attribute name= (p. 296) Name of the layout. (inherited from Layout)

<Component>
Defines the component for which the panel layout is being defined. (inherited from Layout)

Type
Ansys_ACT_Core_XmlDataModel_UI_Component (p. 58)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_UI_Component

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 295
ACT XML Tags

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

name=
Name of the layout. (inherited from Layout)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
296 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Layout>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Layout>
Class defining the a new panel layout.

Remarks
None.

Examples
None.

Table 47: XML Tag Listing

Tag <Component> (p. 297) Defines the component for which the panel layout is being
defined.
Attribute name= (p. 298) Name of the layout.

<Component>
Defines the component for which the panel layout is being defined.

Type
Ansys_ACT_Core_XmlDataModel_UI_Component (p. 58)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_UI_Component

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 297
ACT XML Tags

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

name=
Name of the layout.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
298 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Layout>

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Layout>
No details provided.

Remarks
None.

Examples
None.

Table 48: XML Tag Listing

Tag <Component> (p. 299) Defines the component for which the panel layout is being defined.
(inherited from Layout)
Attribute name= (p. 300) Name of the layout. (inherited from Layout)

<Component>
Defines the component for which the panel layout is being defined. (inherited from Layout)

Type
Ansys_ACT_Core_XmlDataModel_UI_Component (p. 58)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_UI_Component

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 299
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

name=
Name of the layout. (inherited from Layout)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Layout>
No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
300 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Layout>

Remarks
None.

Examples
None.

Table 49: XML Tag Listing

Tag <Component> (p. 301) Defines the component for which the panel layout is being defined.
(inherited from Layout)
Attribute name= (p. 301) Name of the layout. (inherited from Layout)

<Component>
Defines the component for which the panel layout is being defined. (inherited from Layout)

Type
Ansys_ACT_Core_XmlDataModel_UI_Component (p. 58)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_UI_Component

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

name=
Name of the layout. (inherited from Layout)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 301
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<License>
Class defining a license to be used in the execution of an extension.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
302 of ANSYS, Inc. and its subsidiaries and affiliates.
 <License>

Examples
None.

Table 50: XML Tag Listing

Attribute name= (p. 303) Name of the

license.

name=
Name of the license.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 303
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Licenses>
Class defining a licenses collection for the extension.

Remarks
None.

Examples
None.

Table 51: XML Tag Listing

Tag <License> (p. 304) A license collection defined for the

extension.

<License>
A license collection defined for the extension.

Type
Ansys_ACT_Core_XmlDataModel_License (p. 302)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
304 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Link>

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Link>
Class defining a new application task link.

Remarks
None.

Examples
None.

Table 52: XML Tag Listing

Attribute from= (p. 305) The name of the task where the link come
from.
Attribute to= (p. 306) The name of the task where the link go
to.

from=
The name of the task where the link come from.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
from

Mandatory
True

DefaultValue
None.

DataDefinition
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 305
ACT XML Tags

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

to=
The name of the task where the link go to.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
to

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
306 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<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
None.

Table 53: XML Tag Listing

Callback <Action> (p. 309) No details provided.

Tag <Attributes> (p. 310) No details provided. (inherited from SimEntity)
Tag <Callbacks> (p. 310) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 311) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 312) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 313) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Callback <GetCommands> (p. 314) Callback that is invoked to collect all commands
to add to the solver input file.
Callback <GetNodalValuesForDisplay> (p. 315) Callback that is invoked to get nodal values
associated with the load.
Callback <GetPostCommands> (p. 316) Callback that is invoked to collect all "post"
commands to add to the solver input file.
Callback <GetPreCommands> (p. 317) Callback that is invoked to collect all "pre"
commands to add to the solver input file.
Callback <GetSolveCommands> (p. 318) Callback that is invoked to collect all "solve"
commands to add to the solver input file.
Callback <IsValid> (p. 318) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 307
ACT XML Tags

Callback <OnAdd> (p. 319) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGenerate> (p. 320) Callback that is invoked after the generation is
completed.
Callback <OnAfterGeometryUpdate> (p. 321) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 322) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 323) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 324) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerate> (p. 325) Callback that is invoked when the load object is
generated.
Callback <OnGenerateData> (p. 326) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 327) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 328) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 329) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 330) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 331) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 332) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 333) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 334) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 335) No details provided. (inherited from SimEntity)
Attribute caption= (p. 336) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 337) Class name of the controller of the object.
(inherited from SimEntity)
Attribute color= (p. 338) Color of the scoped entities.
Attribute contextual= (p. 339) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 340) Icon for the object. (inherited from SimEntity)
Attribute IsLoad= (p. 341) Indicates whether the load object should be
considered as a load boundary.
Attribute IsSupport= (p. 342) Indicates whether the load object should be
considered as a support boundary.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
308 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Attribute name= (p. 342) Name of the object. (inherited from SimEntity)
Attribute unit= (p. 343) Default unit used by the contour display.
Attribute version= (p. 344) Version of the object. (inherited from SimEntity)

<Action>
No details provided.

Type
List_Action_

Remarks
None.

Examples
None.

Details
CallbackType
None.

Name
Action

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 309
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
310 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 311
ACT XML Tags

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
312 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 313
ACT XML Tags

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
List_CallbackGetCommands_

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetCommands

Name
GetCommands

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
314 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetNodeValues

Name
GetNodalValuesForDisplay

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 315
ACT XML Tags

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 51)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands

Name
GetPostCommands

Public
True

Obsolete
True

ObsoleteMessage
Use 'getcommands' callback with location="post".

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
316 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 51)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands

Name
GetPreCommands

Public
True

Obsolete
True

ObsoleteMessage
Use 'getcommands' callback with location="pre".

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 317
ACT XML Tags

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

Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 51)

Remarks
If timeDependent is true, the callback take as argument : analysis, step, stream

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands

Name
GetSolveCommands

Public
True

Obsolete
True

ObsoleteMessage
Use 'getcommands' callback with location="solve".

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
318 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 319
ACT XML Tags

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAfterGenerate>
Callback that is invoked after the generation is completed.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
320 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnAfterGenerate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 321
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
322 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 323
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
324 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnGenerate>
Callback that is invoked when the load object is generated.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 325
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnGenerate

Name
OnGenerate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
326 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 327
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
328 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 329
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
330 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 331
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
332 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 333
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
334 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 335
ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
caption

Mandatory
False

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
336 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
DefaultValue
None.

Name
class

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 337
ACT XML Tags

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

color=
Color of the scoped entities.

Type
System_String

Remarks
The format of the color is the same as for an HTML page. It's #rrggbb where rr is a 2-digit integer in
hexadecimal for the red part, gg is a 2-digit integer in hexadecimal for the green part, and bb is a 2-
digit integer in hexadecimal for the blue part.

Examples
Example 1: For example:

White: #FFFFFF

Black: #000000

Red: #FF0000

Green: #00FF00

Blue: #0000FF

Details
DefaultValue
#00ff00

Name
color

Mandatory
False

DataDefinition
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
338 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
DefaultValue
True

Name
contextual

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 339
ACT XML Tags

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
icon

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
340 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
False

Name
IsLoad

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
False

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 341
ACT XML Tags

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

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
False

Name
IsSupport

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
False

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
342 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Load>

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
name

Mandatory
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

unit=
Default unit used by the contour display.

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 343
ACT XML Tags

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
unit

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
344 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Examples
None.

Details
DefaultValue
None.

Name
version

Mandatory
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Object>
Class defining an object.

Remarks
None.

Examples
None.

Table 54: XML Tag Listing

Callback <Action> (p. 347) No details provided.

Tag <Attributes> (p. 348) No details provided. (inherited from SimEntity)
Tag <Callbacks> (p. 349) No details provided. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 345
ACT XML Tags

Callback <CanAdd> (p. 349) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 350) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 351) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Callback <GetCommands> (p. 352) Called to collect all commands to add to the solver
input file.
Callback <GetNodalValuesForDisplay> (p. 353) Called to get nodal values associated to the load.
Callback <GetPostCommands> (p. 354) Called to collect all "post" commands to add to
the solver input file.
Callback <GetPreCommands> (p. 355) Called to collect all "pre" commands to add to the
solver input file.
Callback <GetSolveCommands> (p. 356) Called to collect all "solve" commands to add to
the solver input file.
Callback <IsValid> (p. 357) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 358) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGenerate> (p. 359) Called when the generation is completed.
Callback <OnAfterGeometryUpdate> (p. 360) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 361) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 362) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 363) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerate> (p. 364) Called when the load object is generated.
Callback <OnGenerateData> (p. 365) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 366) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 367) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 368) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 369) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 370) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 371) Callback that is invoked when the object is shown.
(inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
346 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Callback <OnSuppress> (p. 372) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 373) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 374) No details provided. (inherited from SimEntity)
Tag <Target> (p. 375) Defines the target location for the object.
Attribute caption= (p. 376) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 376) Class name of the controller of the object.
(inherited from SimEntity)
Attribute color= (p. 377) Color of scoped entities.
Attribute contextual= (p. 379) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 379) Icon for the object. (inherited from SimEntity)
Attribute IsLoad= (p. 380) Indicates whether the load object should be
considered as a load boundary.
Attribute IsSupport= (p. 381) Indicates whether the load object should be
considered as a support boundary.
Attribute name= (p. 382) Name of the object. (inherited from SimEntity)
Attribute unit= (p. 383) Default unit used by the contour display.
Attribute version= (p. 384) Version of the object. (inherited from SimEntity)

<Action>
No details provided.

Type
List_Action_

Remarks
None.

Examples
None.

Details
CallbackType
None.

Name
Action

Public
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 347
ACT XML Tags

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
348 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 349
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
350 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 351
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<GetCommands>
Called to collect all commands to add to the solver input file.

Type
List_CallbackGetCommands_

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
352 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetCommands

Name
GetCommands

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<GetNodalValuesForDisplay>
Called to get nodal values associated to the load.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 353
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetNodeValues

Name
GetNodalValuesForDisplay

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<GetPostCommands>
Called to collect all "post" commands to add to the solver input file.

Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 51)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
354 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands

Name
GetPostCommands

Public
True

Obsolete
True

ObsoleteMessage
Use 'getcommands' callback with location="post".

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<GetPreCommands>
Called to collect all "pre" commands to add to the solver input file.

Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 51)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 355
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands

Name
GetPreCommands

Public
True

Obsolete
True

ObsoleteMessage
Use 'getcommands' callback with location="pre".

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<GetSolveCommands>
Called to collect all "solve" commands to add to the solver input file.

Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 51)

Remarks
If timeDependent is true, the callback take as argument : analysis, step, stream

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
356 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands

Name
GetSolveCommands

Public
True

Obsolete
True

ObsoleteMessage
Use 'getcommands' callback with location="solve".

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 357
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
358 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAfterGenerate>
Called when the generation is completed.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 359
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnAfterGenerate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
360 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 361
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
362 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 363
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnGenerate>
Called when the load object is generated.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
364 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnGenerate

Name
OnGenerate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 365
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
366 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 367
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
368 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 369
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
370 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 371
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
372 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 373
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
374 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Target>
Defines the target location for the object.

Type
Ansys_ACT_Core_XmlDataModel_Target (p. 871)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 375
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
caption

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
376 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
DefaultValue
None.

Name
class

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

color=
Color of scoped entities.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 377
ACT XML Tags

Type
System_String

Remarks
The format of the color is the same as for an HTML page. It's #rrggbb where rr is a 2-digit integer in
hexadecimal for the red part, gg is a 2-digit integer in hexadecimal for the green part, and bb is a 2-
digit integer in hexadecimal for the blue part.

Examples
Example 1: For example:

White: #FFFFFF

Black: #000000

Red: #FF0000

Green: #00FF00

Blue: #0000FF

Details
DefaultValue
#00ff00

Name
color

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
378 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
DefaultValue
True

Name
contextual

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 379
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
icon

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
380 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Remarks
None.

Examples
None.

Details
DefaultValue
False

Name
IsLoad

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
False

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 381
ACT XML Tags

Examples
None.

Details
DefaultValue
False

Name
IsSupport

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
False

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
382 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Object>

Details
DefaultValue
None.

Name
name

Mandatory
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

unit=
Default unit used by the contour display.

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 383
ACT XML Tags

Name
unit

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
version

Mandatory
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
384 of ANSYS, Inc. and its subsidiaries and affiliates.
 <operator>

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<operator>
No details provided.

Remarks
None.

Examples
None.

Table 55: XML Tag Listing

Tag <InputValue> (p. 385) No details

provided.
Attribute Name= (p. 386) No details
provided.
Attribute Type= (p. 387) No details
provided.

<InputValue>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Language_InputValue (p. 264)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 385
ACT XML Tags

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_InputValue

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

Name=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
Name

Mandatory
True

DefaultValue
None.

DataDefinition
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
386 of ANSYS, Inc. and its subsidiaries and affiliates.
 <operator>

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
Name of the variable associated to this operator.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Type=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
Type

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 387
ACT XML Tags

MappedValues
None.

Public
True

Description
Type of the operator.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Optimizer>
Class defining an optimizer.

Remarks
None.

Examples
None.

Table 56: XML Tag Listing

Tag <Attributes> (p. 392) No details provided. (inherited from

SimEntity)
Tag <Callbacks> (p. 392) No details provided. (inherited from
SimEntity)
Callback <CanAdd> (p. 393) Callback that is invoked to determine
whether the object can be added.
(inherited from SimEntity)
Callback <CanDuplicate> (p. 394) Callback that is invoked to determine if
the object can be duplicated. (inherited
from SimEntity)
Callback <CanRemove> (p. 395) Callback that is invoked to determine if
the object can be removed. (inherited
from SimEntity)
Callback <CanRun> (p. 396) Callback that is invoked to indicate
whether the optimizer (or sampling) is
able to process the optimization (design
of experiments) study with its current
configuration. (inherited from
DesignExplorer)
Callback <Configuration> (p. 397) Callback that is invoked to return a
userreadable string summarizing the
current configuration of the optimizer
(or the sampling). (inherited from
DesignExplorer)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
388 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Callback <ConvergenceDescription> (p. 398) Callback that is invoked to return a

DXConvergenceDescription object
describing the convergence data
provided.
Callback <Description> (p. 399) Callback that is invoked to return a
user-readable string describing the
optimizer and its specific capabilities.
(inherited from DesignExplorer)
Callback <InputParametersEdited> (p. 400) Callback that is invoked when the
properties of input parameters have
changed. (inherited from
DesignExplorer)
Callback <IsValid> (p. 401) Callback that is invoked to determine if
the object is valid. (inherited from
SimEntity)
Callback <MethodPropertiesEdited> (p. 402) Callback that is invoked when the
properties of the optimization method
have changed. (inherited from
DesignExplorer)
Callback <ObjectivesOrConstraintsEdited> (p. 403) Callback that is invoked when the
definition of objectives or constraints
have changed.
Callback <OnAdd> (p. 404) Callback that is invoked when the object
is newly added. (inherited from
SimEntity)
Callback <OnAfterGeometryUpdate> (p. 404) Callback that is invoked when the
geometry has been updated. (inherited
from SimEntity)
Callback <OnBodySuppressStateChange> (p. 405) Callback that is invoked when the body
suppress state changse. (inherited from
SimEntity)
Callback <OnClearData> (p. 406) Callback that is invoked when object
data are cleared. (inherited from
SimEntity)
Callback <OnCreate> (p. 407) Callback that is invoked to provide an
instance of IOptimizationMethod (or
ISamplingMethod). (inherited from
DesignExplorer)
Callback <OnDuplicate> (p. 408) Callback that is invoked when the object
is duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 409) Callback that is invoked when object
data are generated. (inherited from
SimEntity)
Callback <OnHide> (p. 410) Callback that is invoked when the object
is hidden. (inherited from SimEntity)
Callback <OnInit> (p. 411) Callback that is invoked when the object
is initialized. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 389
ACT XML Tags

Callback <OnMigrate> (p. 412) Callback that is invoked when the object
version has been changed. (inherited
from SimEntity)
Callback <OnReady> (p. 413) Callback that is invoked when the
application is fully loaded and in a
"ready" state. (Inherited from SimEntity)
(inherited from SimEntity)
Callback <OnRelease> (p. 414) Callback that is invoked to release the
IOptimizationMethod (or the
ISamplingMethod) instance. (inherited
from DesignExplorer)
Callback <OnRemove> (p. 415) Callback that is invoked when the object
is removed. (inherited from SimEntity)
Callback <OnShow> (p. 416) Callback that is invoked when the object
is shown. (inherited from SimEntity)
Callback <OnSuppress> (p. 417) Callback that is invoked when the object
is suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 418) Callback that is invoked when the object
is unsuppressed. (inherited from
SimEntity)
Callback <ParameterRelationshipsEdited> (p. 419) Callback that is invoked when the
definition of parameter relationships
have changed.
Tag <Property> (p. 420) No details provided. (inherited from
SimEntity)
Callback <QuickHelp> (p. 421) Callback that is invoked to return a
user-readable string helping to
understand the state of the optimizer
(or the sampling) when CanRun is false.
(inherited from DesignExplorer)
Callback <Status> (p. 422) Callback that is invoked to return a
user-readable string describing the
status of the optimization (or the
sampling) resolution. (inherited from
DesignExplorer)
Attribute basedondirectoptimizationonly= (p. 423) True if the optimizer is only available in
the context of a Direct Optimization
component; false otherwise.
Attribute basedonresponsesurfaceonly= (p. 424) True if the optimizer is only available in
the context of a Response Surface
component; false otherwise.
Attribute caption= (p. 425) Caption of the object. (inherited from
SimEntity)
Attribute class= (p. 425) Class name of the controller of the
object. (inherited from SimEntity)
Attribute constrainthandling= (p. 426) Supports constraint handling.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
390 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Attribute constraintimportance= (p. 427) Supports the Importance property of a

constraint.
Attribute constraintoninputparameter= (p. 428) Supports constraints defined on an
input parameter.
Attribute contextual= (p. 429) Indicates whether the object has to be
displayed in the contextual menu.
(inherited from SimEntity)
Attribute convergencedata= (p. 430) Provides convergence data.
Attribute equaltoconstraint= (p. 431) Supports the Equal To constraint type.
Attribute greaterthanconstraint= (p. 432) Supports the Greater Than constraint
type.
Attribute gridintervaloninputparameter= (p. 433) Supports grid interval defined on an
Input Parameter.
Attribute historychartxaxistype= (p. 434) Defines the X axis type for history charts.
Attribute icon= (p. 435) Icon for the object. (inherited from
SimEntity)
Attribute insideboundsconstraint= (p. 435) Supports the Inside Bounds constraint
type.
Attribute lessthanconstraint= (p. 436) Supports the Less Than constraint type.
Attribute logfile= (p. 437) Provides messages to generate a log file.
(inherited from DesignExplorer)
Attribute maximizeobjective= (p. 438) Supports the Maximize objective type.
Attribute maximumnumberofconstraints= (p. 439) Defines the maximum number of
constraints supported by the optimizer.
Attribute maximumnumberofdoublelistparameters= (p. 440) Indicates the maximum number of
double list parameters supported.
(inherited from DesignExplorer)
Attribute maximumnumberofdoubleparameters= (p. 441) Indicates the maximum number of
double parameters supported. (inherited
from DesignExplorer)
Attribute maximumnumberofinputparameters= (p. 442) Indicates the maximum number of input
parameters supported. (inherited from
DesignExplorer)
Attribute maximumnumberofintegerlistparameters= (p. 443) Indicates the maximum number of
integer list parameters supported.
(inherited from DesignExplorer)
Attribute maximumnumberofobjectives= (p. 444) Defines the maximum number of
objectives supported by the optimizer.
Attribute minimizeobjective= (p. 444) Supports the Minimize objective type.
Attribute minimumnumberofconstraints= (p. 445) Defines the minimum number of
constraints required.
Attribute minimumnumberofobjectives= (p. 446) Defines the minimum number of
objectives required.
Attribute name= (p. 447) Name of the object. (inherited from
SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 391
ACT XML Tags

Attribute objectiveimportance= (p. 448) Supports the Importance property of an

objective.
Attribute objectiveoninputparameter= (p. 449) Supports objectives defined on an Input
Parameter.
Attribute parameterrelationship= (p. 450) Supports parameter relationships.
Attribute seekobjective= (p. 451) Supports the Seek objective type.
Attribute startingpointrequired= (p. 452) Requires a Starting Point.
Attribute version= (p. 453) Version of the object. (inherited from
SimEntity)

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
392 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 393
ACT XML Tags

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
394 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 395
ACT XML Tags

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<CanRun>
Callback that is invoked to indicate whether the optimizer (or sampling) is able to process the optimiz-
ation (design of experiments) study with its current configuration. (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__bool_

Name
CanRun

Public
True

Obsolete
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
396 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Configuration>
Callback that is invoked to return a userreadable string summarizing the current configuration of the
optimizer (or the sampling). (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_

Name
Configuration

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 397
ACT XML Tags

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<ConvergenceDescription>
Callback that is invoked to return a DXConvergenceDescription object describing the convergence data
provided.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__object_

Name
ConvergenceDescription

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
398 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Description>
Callback that is invoked to return a user-readable string describing the optimizer and its specific capab-
ilities. (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_

Name
Description

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 399
ACT XML Tags

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<InputParametersEdited>
Callback that is invoked when the properties of input parameters have changed. (inherited from De-
signExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_

Name
InputParametersEdited

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
400 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 401
ACT XML Tags

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<MethodPropertiesEdited>
Callback that is invoked when the properties of the optimization method have changed. (inherited from
DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_

Name
MethodPropertiesEdited

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
402 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<ObjectivesOrConstraintsEdited>
Callback that is invoked when the definition of objectives or constraints have changed.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_

Name
ObjectivesOrConstraintsEdited

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 403
ACT XML Tags

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
404 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 405
ACT XML Tags

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
406 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnCreate>
Callback that is invoked to provide an instance of IOptimizationMethod (or ISamplingMethod). (inherited
from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 407
ACT XML Tags

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__object_

Name
OnCreate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
408 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 409
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
410 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 411
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
412 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 413
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnRelease>
Callback that is invoked to release the IOptimizationMethod (or the ISamplingMethod) instance. (inherited
from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
414 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Details
CallbackType
ActionCallback_IUserObject_

Name
OnRelease

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 415
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
416 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 417
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
418 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<ParameterRelationshipsEdited>
Callback that is invoked when the definition of parameter relationships have changed.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 419
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
ParameterRelationshipsEdited

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
420 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<QuickHelp>
Callback that is invoked to return a user-readable string helping to understand the state of the optimizer
(or the sampling) when CanRun is false. (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_

Name
QuickHelp

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 421
ACT XML Tags

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Status>
Callback that is invoked to return a user-readable string describing the status of the optimization (or
the sampling) resolution. (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_

Name
Status

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
422 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

basedondirectoptimizationonly=
True if the optimizer is only available in the context of a Direct Optimization component; false otherwise.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
False

Name
basedondirectoptimizationonly

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 423
ACT XML Tags

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

basedonresponsesurfaceonly=
True if the optimizer is only available in the context of a Response Surface component; false otherwise.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
False

Name
basedonresponsesurfaceonly

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
424 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
caption

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 425
ACT XML Tags

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
Name
class

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

constrainthandling=
Supports constraint handling.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
426 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
False

Name
constrainthandling

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

constraintimportance=
Supports the Importance property of a constraint.

Type
System_Boolean

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 427
ACT XML Tags

Remarks
None.

Examples
None.

Details
DefaultValue
False

Name
constraintimportance

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

constraintoninputparameter=
Supports constraints defined on an input parameter.

Type
System_Boolean

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
428 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Examples
None.

Details
DefaultValue
True

Name
constraintoninputparameter

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 429
ACT XML Tags

Details
Name
contextual

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

convergencedata=
Provides convergence data.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
430 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Name
convergencedata

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

equaltoconstraint=
Supports the Equal To constraint type.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
True

Name
equaltoconstraint

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 431
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

greaterthanconstraint=
Supports the Greater Than constraint type.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
greaterthanconstraint

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
432 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

gridintervaloninputparameter=
Supports grid interval defined on an Input Parameter.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
gridintervaloninputparameter

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 433
ACT XML Tags

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

historychartxaxistype=
Defines the X axis type for history charts.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
historychartxaxistype

Mandatory
False

DefaultValue
bypoint

DataDefinition
False

AllowedValues
System.String[]

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
434 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
icon

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

insideboundsconstraint=
Supports the Inside Bounds constraint type.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 435
ACT XML Tags

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
insideboundsconstraint

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

lessthanconstraint=
Supports the Less Than constraint type.

Type
System_Boolean

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
436 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Remarks
None.

Examples
None.

Details
Name
lessthanconstraint

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

logfile=
Provides messages to generate a log file. (inherited from DesignExplorer)

Type
System_Boolean

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 437
ACT XML Tags

Examples
None.

Details
Name
logfile

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

maximizeobjective=
Supports the Maximize objective type.

Type
System_Boolean

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
438 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Details
Name
maximizeobjective

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

maximumnumberofconstraints=
Defines the maximum number of constraints supported by the optimizer.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
maximumnumberofconstraints

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 439
ACT XML Tags

Mandatory
False

DefaultValue
100

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

maximumnumberofdoublelistparameters=
Indicates the maximum number of double list parameters supported. (inherited from DesignExplorer)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
maximumnumberofdoublelistparameters

Mandatory
False

DefaultValue
100

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
440 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

maximumnumberofdoubleparameters=
Indicates the maximum number of double parameters supported. (inherited from DesignExplorer)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
maximumnumberofdoubleparameters

Mandatory
False

DefaultValue
100

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 441
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

maximumnumberofinputparameters=
Indicates the maximum number of input parameters supported. (inherited from DesignExplorer)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
maximumnumberofinputparameters

Mandatory
False

DefaultValue
100

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
442 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

maximumnumberofintegerlistparameters=
Indicates the maximum number of integer list parameters supported. (inherited from DesignExplorer)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
maximumnumberofintegerlistparameters

Mandatory
False

DefaultValue
100

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 443
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

maximumnumberofobjectives=
Defines the maximum number of objectives supported by the optimizer.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
maximumnumberofobjectives

Mandatory
False

DefaultValue
100

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

minimizeobjective=
Supports the Minimize objective type.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
444 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
minimizeobjective

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

minimumnumberofconstraints=
Defines the minimum number of constraints required.

Type
System_Int32

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 445
ACT XML Tags

Remarks
None.

Examples
None.

Details
Name
minimumnumberofconstraints

Mandatory
False

DefaultValue
0

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

minimumnumberofobjectives=
Defines the minimum number of objectives required.

Type
System_Int32

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
446 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Examples
None.

Details
Name
minimumnumberofobjectives

Mandatory
False

DefaultValue
1

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 447
ACT XML Tags

Details
Name
name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

objectiveimportance=
Supports the Importance property of an objective.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
objectiveimportance

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
448 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

objectiveoninputparameter=
Supports objectives defined on an Input Parameter.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
objectiveoninputparameter

Mandatory
False

DefaultValue
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 449
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

parameterrelationship=
Supports parameter relationships.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
parameterrelationship

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
450 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

seekobjective=
Supports the Seek objective type.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
seekobjective

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 451
ACT XML Tags

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

startingpointrequired=
Requires a Starting Point.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
startingpointrequired

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
452 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Optimizer>

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
version

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 453
ACT XML Tags

<OrderableCallback>
A callback that supports an order specification. Used when multiple callbacks could apply to the same
entity, allowing a proper "sorting" of execution.

Remarks
None.

Examples
None.

Table 57: XML Tag Listing

Attribute caninterrupt= (p. 454) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute order= (p. 455) The order "priority". The lower the order, the earlier the execution.

caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
False

Name
caninterrupt

Mandatory
False

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
454 of ANSYS, Inc. and its subsidiaries and affiliates.
 <OrderableCallback>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

order=
The order "priority". The lower the order, the earlier the execution.

Type
System_Int32

Remarks
None.

Examples
None.

Details
DefaultValue
0

Name
order

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 455
ACT XML Tags

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<output>
Class defining an output-level data connection definition.

Remarks
None.

Examples
None.

Table 58: XML Tag Listing

Attribute format= (p. 456) Connection format type. (inherited from

IOItem)
Attribute type= (p. 457) Connection data type. (inherited from
IOItem)

format=
Connection format type. (inherited from IOItem)

Type
System_String

Remarks
This is used by upstream tasks or your task to determine what "specialized" format should be produced
for the more general "Type" property.

Examples
None.

Details
Mandatory
False

Name
format

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
456 of ANSYS, Inc. and its subsidiaries and affiliates.
 <output>

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

type=
Connection data type. (inherited from IOItem)

Type
System_String

Remarks
Used to specify the input and output exposed object types for a task.

Examples
None.

Details
Mandatory
False

Name
type

DefaultValue
None.

DataDefinition
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 457
ACT XML Tags

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<outputfile>
This class defines the OutputFile XML Tag.

Remarks
None.

Examples
None.

Table 59: XML Tag Listing

Attribute id= (p. 458) The unique file id. (inherited

from File)
Attribute name= (p. 459) The file name. (inherited from
File)

id=
The unique file id. (inherited from File)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
458 of ANSYS, Inc. and its subsidiaries and affiliates.
 <outputfile>

Details
Mandatory
True

Name
id

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
The file name. (inherited from File)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 459
ACT XML Tags

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<outputs>
Class defining the outputs collection for a task.

Remarks
None.

Examples
None.

Table 60: XML Tag Listing

Tag <Output> (p. 460) No details

provided.

<Output>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Output (p. 456)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
460 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Panel>

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Output

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Panel>
Class defining a panel to be displayed in the application.

Remarks
None.

Examples
None.

Table 61: XML Tag Listing

Tag <Callbacks> (p. 462) Specifies the callbacks that will invoke functions
from the IronPython extension script. (Inherited from
SimEntity)
Tag <DialogProgressMonitorView> (p. 462) No details provided.
Callback <OnPanelHidden> (p. 463) Callback that is invoked when the panel is hidden.
Callback <OnPanelInitialized> (p. 464) Callback that is invoked when the panel is initialized.
Callback <OnPanelShown> (p. 465) Callback that is invoked when the panel is shown.
Attribute class= (p. 466) Class name of the controller of the object.
Attribute layout= (p. 467) Layout of the panel.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 461
ACT XML Tags

Attribute name= (p. 468) Name of the panel.

<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (Inherited from
SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<DialogProgressMonitorView>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Application_DialogProgressMonitorView (p. 109)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
462 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Panel>

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_DialogProgressMonitorView

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<OnPanelHidden>
Callback that is invoked when the panel is hidden.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPanelComponent_

Name
OnPanelHidden

Public
True

Obsolete
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 463
ACT XML Tags

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnPanelInitialized>
Callback that is invoked when the panel is initialized.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPanelComponent_

Name
OnPanelInitialized

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
464 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Panel>

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnPanelShown>
Callback that is invoked when the panel is shown.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPanelComponent_

Name
OnPanelShown

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 465
ACT XML Tags

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

class=
Class name of the controller of the object.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
class

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
466 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Panel>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

layout=
Layout of the panel.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
layout

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 467
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the panel.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<PanelComponent>
No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
468 of ANSYS, Inc. and its subsidiaries and affiliates.
 <PanelComponent>

Remarks
None.

Examples
None.

Table 62: XML Tag Listing

Tag <Attributes> (p. 470) Defines the set of attributes for the component. (inherited
from Component)
Tag <Layout> (p. 470) No details provided.
Tag <layoutName> (p. 471) No details provided.
Attribute BottomAttachment= (p. 472) Bottom attachment of the layout. (inherited from Component)
Attribute BottomOffset= (p. 472) Bottom offset related to the bottom attachment. (inherited
from Component)
Attribute ComponentType= (p. 473) Type of the component for the component. (inherited from
Component)
Attribute CustomCSSFile= (p. 474) Custom css file for the component layout. (inherited from
Component)
Attribute CustomHTMLFile= (p. 475) Custom html file for the component layout. (inherited from
Component)
Attribute CustomJSFile= (p. 476) Custom jscript file for the component layout. (inherited from
Component)
Attribute Height= (p. 477) Height value for the component. (inherited from Component)
Attribute HeightType= (p. 478) Height type for the component. (inherited from Component)
Attribute LeftAttachment= (p. 479) Left attachment of the layout. (inherited from Component)
Attribute LeftOffset= (p. 480) Left offset related to the left attachment. (inherited from
Component)
Attribute MaxHeight= (p. 481) Maximum height for the component. (inherited from
Component)
Attribute MaxWidth= (p. 481) Maximum width for the component. (inherited from
Component)
Attribute MinHeight= (p. 482) Minimum height for the component. (inherited from
Component)
Attribute MinWidth= (p. 483) Minimum width for the component. (inherited from
Component)
Attribute name= (p. 484) Name of the component. (inherited from Component)
Attribute RightAttachment= (p. 485) Right attachment of the layout. (inherited from Component)
Attribute RightOffset= (p. 486) Right offset related to the right attachment. (inherited from
Component)
Attribute TopAttachment= (p. 487) Top attachment of the layout. (inherited from Component)
Attribute TopOffset= (p. 488) Top offset related to the top attachment. (inherited from
Component)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 469
ACT XML Tags

Attribute visible= (p. 489) Initial visibility of the component. (inherited from Component)
Attribute Width= (p. 490) Width value for the component. (inherited from Component)
Attribute WidthType= (p. 490) Width type for the component. (inherited from Component)

<Attributes>
Defines the set of attributes for the component. (inherited from Component)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Layout>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_UI_Layout (p. 297)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
470 of ANSYS, Inc. and its subsidiaries and affiliates.
 <PanelComponent>

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_UI_Layout

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<layoutName>
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Description
None.

Name
layoutName

ValueName
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 471
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

BottomAttachment=
Bottom attachment of the layout. (inherited from Component)

Type
System_String

Remarks
The value can be the name of a component or "" for the border.

Examples
None.

Details
Name
BottomAttachment

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

BottomOffset=
Bottom offset related to the bottom attachment. (inherited from Component)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
472 of ANSYS, Inc. and its subsidiaries and affiliates.
 <PanelComponent>

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
BottomOffset

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

ComponentType=
Type of the component for the component. (inherited from Component)

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 473
ACT XML Tags

Remarks
None.

Examples
None.

Details
Name
ComponentType

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

CustomCSSFile=
Custom css file for the component layout. (inherited from Component)

Type
System_String

Remarks
This file will be taken in place of the standard one associated to the component.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
474 of ANSYS, Inc. and its subsidiaries and affiliates.
 <PanelComponent>

Examples
None.

Details
Name
CustomCSSFile

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

CustomHTMLFile=
Custom html file for the component layout. (inherited from Component)

Type
System_String

Remarks
This file will be taken in place of the standard one associated to the component.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 475
ACT XML Tags

Details
Name
CustomHTMLFile

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

CustomJSFile=
Custom jscript file for the component layout. (inherited from Component)

Type
System_String

Remarks
This file will be taken in place of the standard one associated to the component.

Examples
None.

Details
Name
CustomJSFile

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
476 of ANSYS, Inc. and its subsidiaries and affiliates.
 <PanelComponent>

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Height=
Height value for the component. (inherited from Component)

Type
System_Single

Remarks
None.

Examples
None.

Details
Name
Height

Mandatory
True

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 477
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

HeightType=
Height type for the component. (inherited from Component)

Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType

Remarks
None.

Examples
None.

Details
Name
HeightType

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
478 of ANSYS, Inc. and its subsidiaries and affiliates.
 <PanelComponent>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

LeftAttachment=
Left attachment of the layout. (inherited from Component)

Type
System_String

Remarks
The value can be the name of a component or "" for the border.

Examples
None.

Details
Name
LeftAttachment

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 479
ACT XML Tags

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

LeftOffset=
Left offset related to the left attachment. (inherited from Component)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
LeftOffset

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
480 of ANSYS, Inc. and its subsidiaries and affiliates.
 <PanelComponent>

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

MaxHeight=
Maximum height for the component. (inherited from Component)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
MaxHeight

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

MaxWidth=
Maximum width for the component. (inherited from Component)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 481
ACT XML Tags

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
MaxWidth

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

MinHeight=
Minimum height for the component. (inherited from Component)

Type
System_Int32

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
482 of ANSYS, Inc. and its subsidiaries and affiliates.
 <PanelComponent>

Remarks
None.

Examples
None.

Details
Name
MinHeight

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

MinWidth=
Minimum width for the component. (inherited from Component)

Type
System_Int32

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 483
ACT XML Tags

Examples
None.

Details
Name
MinWidth

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the component. (inherited from Component)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
484 of ANSYS, Inc. and its subsidiaries and affiliates.
 <PanelComponent>

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

RightAttachment=
Right attachment of the layout. (inherited from Component)

Type
System_String

Remarks
The value can be the name of a component or "" for the border.

Examples
None.

Details
Name
RightAttachment

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 485
ACT XML Tags

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

RightOffset=
Right offset related to the right attachment. (inherited from Component)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
RightOffset

Mandatory
False

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
486 of ANSYS, Inc. and its subsidiaries and affiliates.
 <PanelComponent>

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

TopAttachment=
Top attachment of the layout. (inherited from Component)

Type
System_String

Remarks
The value can be the name of a component or "" for the border.

Examples
None.

Details
Name
TopAttachment

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 487
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

TopOffset=
Top offset related to the top attachment. (inherited from Component)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
TopOffset

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
488 of ANSYS, Inc. and its subsidiaries and affiliates.
 <PanelComponent>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

visible=
Initial visibility of the component. (inherited from Component)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
visible

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
False

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 489
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Width=
Width value for the component. (inherited from Component)

Type
System_Single

Remarks
None.

Examples
None.

Details
Name
Width

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

WidthType=
Width type for the component. (inherited from Component)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
490 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType

Remarks
None.

Examples
None.

Details
Name
WidthType

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<parameter>
Class defining a single parameter definition for a task.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 491
ACT XML Tags

Examples
None.

Table 63: XML Tag Listing

Tag <Attributes> (p. 493) No details provided. (inherited from SimEntity)

Tag <Callbacks> (p. 493) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 494) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 495) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 496) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Callback <IsValid> (p. 497) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 498) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 499) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 500) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 501) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 502) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 503) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 504) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 505) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 505) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 506) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 507) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 508) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 509) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 510) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 511) No details provided. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
492 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

Attribute caption= (p. 512) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 513) Class name of the controller of the object.
(inherited from SimEntity)
Attribute contextual= (p. 514) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute control= (p. 515) Underlying data type of the parameter.
Attribute icon= (p. 516) Icon for the object. (inherited from SimEntity)
Attribute name= (p. 516) Name of the object. (inherited from SimEntity)
Attribute usage= (p. 517) Usage of the parameter.
Attribute version= (p. 518) Version of the object. (inherited from SimEntity)

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 493
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
494 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 495
ACT XML Tags

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
496 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 497
ACT XML Tags

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
498 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 499
ACT XML Tags

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
500 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 501
ACT XML Tags

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
502 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 503
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
504 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 505
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
506 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 507
ACT XML Tags

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
508 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 509
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
510 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 511
ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
caption

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
512 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
Name
class

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 513
ACT XML Tags

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
Mandatory
False

Name
contextual

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
514 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

control=
Underlying data type of the parameter.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
control

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 515
ACT XML Tags

icon=
Icon for the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
icon

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
516 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameter>

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

usage=
Usage of the parameter.

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 517
ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
usage

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
518 of ANSYS, Inc. and its subsidiaries and affiliates.
 <parameters>

Examples
None.

Details
Mandatory
True

Name
version

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<parameters>
Class defining the collection of task parameters.

Remarks
None.

Examples
None.

Table 64: XML Tag Listing

Tag <Parameter> (p. 520) No details

provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 519
ACT XML Tags

<Parameter>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Parameter (p. 491)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Parameter

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<platform>
This class defines the Platform XML Tag.

Remarks
None.

Examples
None.

Table 65: XML Tag Listing

Attribute name= (p. 521) The platform name. May be "Win64" or

"Linux64"

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
520 of ANSYS, Inc. and its subsidiaries and affiliates.
 <platform>

Attribute path= (p. 521) The platform-supported path (e.g., to an

exe)

name=
The platform name. May be "Win64" or "Linux64"

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

path=
The platform-supported path (e.g., to an exe)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 521
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
path

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Presentations>
No details provided.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
522 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Presentations>

Examples
None.

Table 66: XML Tag Listing

Tag <ScenePresentation> (p. 523) No details

provided.
Attribute Name= (p. 523) No details
provided.

<ScenePresentation>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Application_ScenePresentation (p. 781)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_ScenePresentation

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

Name=
No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 523
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
Name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<ProductDataModelConverter>
No details provided.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
524 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ProductDataModelConverter>

Examples
None.

Table 67: XML Tag Listing

Tag <Callbacks> (p. 525) No details

provided.
Callback <OnReadInput> (p. 526) No details
provided.
Callback <OnSendBackData> (p. 527) No details
provided.
Callback <OnSendData> (p. 528) No details
provided.
Callback <OnWriteInput> (p. 529) No details
provided.
Tag <UserObjectConverter> (p. 529) No details
provided.
Attribute dataModel= (p. 530) No details
provided.
Attribute product= (p. 531) No details
provided.

<Callbacks>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 525
ACT XML Tags

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<OnReadInput>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IApplicationDataModel__StreamReader_

Name
OnReadInput

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
526 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ProductDataModelConverter>

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnSendBackData>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_object__IExtAPI_

Name
OnSendBackData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 527
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnSendData>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_object__IExtAPI_

Name
OnSendData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
528 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ProductDataModelConverter>

<OnWriteInput>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IApplicationDataModel__StreamWriter_

Name
OnWriteInput

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<UserObjectConverter>
No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 529
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Application_UserObjectConverter (p. 995)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

dataModel=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
530 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ProductDataModelConverter>

Name
dataModel

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

product=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
product

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 531
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<ProductTask>
Class defining a new user input application task.

Remarks
None.

Examples
None.

Table 68: XML Tag Listing

Tag <DataModelInOut> (p. 532) The panel associated to the task.

Attribute caption= (p. 533) The caption of the task. (inherited from
BaseTaskTag)
Attribute name= (p. 534) The name of the task. (inherited from
BaseTaskTag)
Attribute product= (p. 535) The panel associated to the task.

<DataModelInOut>
The panel associated to the task.

Type
Ansys_ACT_Core_XmlDataModel_Application_DataModelInOut (p. 96)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
532 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ProductTask>

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_DataModelInOut

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
The caption of the task. (inherited from BaseTaskTag)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
caption

Mandatory
False

DefaultValue
None.

DataDefinition
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 533
ACT XML Tags

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
The name of the task. (inherited from BaseTaskTag)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
534 of ANSYS, Inc. and its subsidiaries and affiliates.
 <ProductTask>

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

product=
The panel associated to the task.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
product

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 535
ACT XML Tags

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<program>
This class defines the Program XML Tag.

Remarks
None.

Examples
None.

Table 69: XML Tag Listing

Tag <Argument> (p. 536) The program's command-line

arguments.
Tag <Platform> (p. 537) The program's supported platforms.

<Argument>
The program's command-line arguments.

Type
Ansys_ACT_Core_XmlDataModel_Argument (p. 39)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Argument

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
536 of ANSYS, Inc. and its subsidiaries and affiliates.
 <projectdata>

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Platform>
The program's supported platforms.

Type
Ansys_ACT_Core_XmlDataModel_Platform (p. 520)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Platform

MinOccurence
1

MaxOccurence
-1

RealParent
None.

Mandatory
True

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<projectdata>
No details provided.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 537
ACT XML Tags

Examples
None.

Table 70: XML Tag Listing

Tag <DataEntity> (p. 538) No details

provided.

<DataEntity>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_DataEntity (p. 111)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_DataEntity

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<property>
Class defining a property of any user object.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
538 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Examples
None.

Table 71: XML Tag Listing

Tag <Attributes> (p. 541) No details provided. (inherited from PropertyBase)

Tag <Callbacks> (p. 541) No details provided. (inherited from PropertyBase)
Callback <GetValue> (p. 542) Callback that is invoked when the property value
is acquired. (inherited from PropertyBase)
Tag <help> (p. 543) No details provided. (inherited from PropertyBase)
Callback <IsValid> (p. 544) Callback that is invoked to determine whether the
property is valid. (inherited from PropertyBase)
Callback <IsVisible> (p. 544) Callback that is invoked to determine whether the
property is visible. (inherited from PropertyBase)
Callback <OnActivate> (p. 545) Callback that is invoked when the property is
activated. (inherited from PropertyBase)
Callback <OnAdd> (p. 546) Callback that is invoked when the property is
added. (inherited from PropertyBase)
Callback <OnAfterGeometryUpdate> (p. 547) Callback that is invoked after the geometry has
been updated. (inherited from PropertyBase)
Callback <OnApply> (p. 548) Callback that is invoked when the property apply
button is clicked. (inherited from PropertyBase)
Callback <OnBodySuppressStateChange> (p. 549) Callback that is invoked when the body suppress
state change. (inherited from PropertyBase)
Callback <OnButtonClick> (p. 550) Callback that is invoked when click on a property's
button (inherited from PropertyBase)
Callback <OnCancel> (p. 551) Callback that is invoked when the property cancel
button is clicked. (inherited from PropertyBase)
Callback <OnDuplicate> (p. 552) Callback that is invoked when the property is
duplicated. (inherited from PropertyBase)
Callback <OnHide> (p. 553) Callback that is invoked when the property is
hidden. (inherited from PropertyBase)
Callback <OnInit> (p. 554) Callback that is invoked when the property is
initialized. (inherited from PropertyBase)
Callback <OnJournalExecuting> (p. 555) Callback that is invoked before executing an action
written in the journal. (inherited from
PropertyBase)
Callback <OnJournalRecording> (p. 556) Callback that is invoked before writting the journal
for an action. (inherited from PropertyBase)
Callback <OnMigrate> (p. 557) Callback that is invoked when the property version
has been changed. (inherited from PropertyBase)
Callback <OnRemove> (p. 558) Callback that is invoked when the property is
removed. (inherited from PropertyBase)
Callback <OnShow> (p. 559) Callback that is invoked when the property is
shown. (inherited from PropertyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 539
ACT XML Tags

Callback <OnValidate> (p. 560) Callback that is invoked when the property is
validated. (inherited from PropertyBase)
Callback <SetValue> (p. 561) Callback that is invoked when the property value
is set. (inherited from PropertyBase)
Callback <String2Value> (p. 562) Callback that is invoked to convert a string to the
property value. (inherited from PropertyBase)
Callback <Value2String> (p. 563) Callback that is invoked to convert the value
stored by the property into a string. (inherited
from PropertyBase)
Attribute caption= (p. 564) Caption of the property. (inherited from
PropertyBase)
Attribute class= (p. 565) Class name of the property's controller. (inherited
from PropertyBase)
Attribute control= (p. 566) Control type of the object.
Attribute default= (p. 567) Default value of the property. (inherited from
PropertyBase)
Attribute elementtype= (p. 568) Property list element type (workflow). (inherited
from PropertyBase)
Attribute isparameter= (p. 569) Indicates whether the property is a parameter.
(inherited from PropertyBase)
Attribute keytype= (p. 570) Property dictionary key type (workflow). (inherited
from PropertyBase)
Attribute name= (p. 571) Name of the property. (inherited from
PropertyBase)
Attribute needupdate= (p. 572) Indicates whether the context must be refreshed
when the property value changes. (inherited from
PropertyBase)
Attribute parameterizable= (p. 572) Specifies the property parameterization (workflow).
Indicates whether the property should be a
candidate for parameterization (in the schematic
property view, a check-box will appear). (inherited
from PropertyBase)
Attribute persistent= (p. 573) Specifies the property persistence (workflow).
Indicates whether the property data should be
saved within the project. (inherited from
PropertyBase)
Attribute readonly= (p. 574) Indicates whether the property is read-only.
(inherited from PropertyBase)
Attribute unit= (p. 575) Unit type of the property (for 'control' equals to
'float' only). (inherited from PropertyBase)
Attribute valuetype= (p. 576) Property dictionary value type (workflow).
(inherited from PropertyBase)
Attribute visible= (p. 577) Indicates whether the property is visible. (inherited
from PropertyBase)
Attribute visibleon= (p. 578) Specifies property visibility. With a PropertyGroup
parent of control type "select", indicates the select

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
540 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

values for this property to be visible (separate with

'|'). (inherited from PropertyBase)

<Attributes>
No details provided. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 541
ACT XML Tags

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<GetValue>
Callback that is invoked when the property value is acquired. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is useful for transforming the stored property value.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue

Name
GetValue

Public
True

Obsolete
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
542 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<help>
No details provided. (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
Description
Indicate the help that will be shown for the property. (Wizard only)

Name
help

ValueName
None.

Public
True

TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 543
ACT XML Tags

<IsValid>
Callback that is invoked to determine whether the property is valid. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<IsVisible>
Callback that is invoked to determine whether the property is visible. (inherited from PropertyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
544 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible

Name
IsVisible

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnActivate>
Callback that is invoked when the property is activated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 545
ACT XML Tags

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate

Name
OnActivate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAdd>
Callback that is invoked when the property is added. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
546 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAfterGeometryUpdate>
Callback that is invoked after the geometry has been updated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 547
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnApply>
Callback that is invoked when the property apply button is clicked. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
548 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate

Name
OnApply

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state change. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 549
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnButtonClick>
Callback that is invoked when click on a property's button (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
550 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnButtonClick

Name
OnButtonClick

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnCancel>
Callback that is invoked when the property cancel button is clicked. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 551
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate

Name
OnCancel

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnDuplicate>
Callback that is invoked when the property is duplicated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
552 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnHide>
Callback that is invoked when the property is hidden. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 553
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnInit>
Callback that is invoked when the property is initialized. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
554 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnJournalExecuting>
Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 555
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnJournalExecuting

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnJournalRecording>
Callback that is invoked before writting the journal for an action. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
556 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnJournalRecording

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnMigrate>
Callback that is invoked when the property version has been changed. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback allows the migration of data from the old saved property to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 557
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnPropertyMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnRemove>
Callback that is invoked when the property is removed. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
558 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnShow>
Callback that is invoked when the property is shown. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 559
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnValidate>
Callback that is invoked when the property is validated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
560 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate

Name
OnValidate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<SetValue>
Callback that is invoked when the property value is set. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is useful for transforming the submitted property value.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 561
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue

Name
SetValue

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<String2Value>
Callback that is invoked to convert a string to the property value. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
562 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Details
CallbackType
Ansys_ACT_Core_Callbacks_String2Value

Name
String2Value

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Value2String>
Callback that is invoked to convert the value stored by the property into a string. (inherited from
PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 563
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_Value2String

Name
Value2String

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

caption=
Caption of the property. (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
564 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Details
Mandatory
False

Name
caption

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

class=
Class name of the property's controller. (inherited from PropertyBase)

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes three arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The load associated to the property (of type IUserObject)

• The associated property (of type ISimProperty)

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 565
ACT XML Tags

Details
Mandatory
False

Name
class

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

control=
Control type of the object.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
566 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Name
control

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

default=
Default value of the property. (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
default

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 567
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

elementtype=
Property list element type (workflow). (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
elementtype

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
568 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

isparameter=
Indicates whether the property is a parameter. (inherited from PropertyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
isparameter

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 569
ACT XML Tags

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

keytype=
Property dictionary key type (workflow). (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
keytype

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
570 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the property. (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 571
ACT XML Tags

needupdate=
Indicates whether the context must be refreshed when the property value changes. (inherited from
PropertyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
needupdate

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

parameterizable=
Specifies the property parameterization (workflow). Indicates whether the property should be a candidate
for parameterization (in the schematic property view, a check-box will appear). (inherited from Proper-
tyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
572 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
parameterizable

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

persistent=
Specifies the property persistence (workflow). Indicates whether the property data should be saved
within the project. (inherited from PropertyBase)

Type
System_Boolean

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 573
ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
persistent

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

readonly=
Indicates whether the property is read-only. (inherited from PropertyBase)

Type
System_Boolean

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
574 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Examples
None.

Details
Mandatory
False

Name
readonly

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

unit=
Unit type of the property (for 'control' equals to 'float' only). (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 575
ACT XML Tags

Details
Mandatory
False

Name
unit

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

valuetype=
Property dictionary value type (workflow). (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
576 of ANSYS, Inc. and its subsidiaries and affiliates.
 <property>

Name
valuetype

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

visible=
Indicates whether the property is visible. (inherited from PropertyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
visible

DefaultValue
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 577
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

visibleon=
Specifies property visibility. With a PropertyGroup parent of control type "select", indicates the select
values for this property to be visible (separate with '|'). (inherited from PropertyBase)

Type
System_String_ARRAY_

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
visibleon

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
578 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

MultipleValue
True

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<propertygroup>
Class defining a collection of properties.

Remarks
None.

Examples
None.

Table 72: XML Tag Listing

Tag <Attributes> (p. 581) No details provided. (inherited from PropertyBase)

Tag <Callbacks> (p. 582) No details provided. (inherited from PropertyBase)
Callback <GetValue> (p. 582) Callback that is invoked when the property value
is acquired. (inherited from PropertyBase)
Tag <help> (p. 583) No details provided. (inherited from PropertyBase)
Callback <IsValid> (p. 584) Callback that is invoked to determine whether the
property is valid. (inherited from PropertyBase)
Callback <IsVisible> (p. 585) Callback that is invoked to determine whether the
property is visible. (inherited from PropertyBase)
Callback <OnActivate> (p. 586) Callback that is invoked when the property is
activated. (inherited from PropertyBase)
Callback <OnAdd> (p. 587) Callback that is invoked when the property is
added. (inherited from PropertyBase)
Callback <OnAfterGeometryUpdate> (p. 588) Callback that is invoked after the geometry has
been updated. (inherited from PropertyBase)
Callback <OnApply> (p. 589) Callback that is invoked when the property apply
button is clicked. (inherited from PropertyBase)
Callback <OnBodySuppressStateChange> (p. 590) Callback that is invoked when the body suppress
state change. (inherited from PropertyBase)
Callback <OnButtonClick> (p. 591) Callback that is invoked when click on a property's
button (inherited from PropertyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 579
ACT XML Tags

Callback <OnCancel> (p. 592) Callback that is invoked when the property cancel
button is clicked. (inherited from PropertyBase)
Callback <OnDuplicate> (p. 592) Callback that is invoked when the property is
duplicated. (inherited from PropertyBase)
Callback <OnHide> (p. 593) Callback that is invoked when the property is
hidden. (inherited from PropertyBase)
Callback <OnInit> (p. 594) Callback that is invoked when the property is
initialized. (inherited from PropertyBase)
Callback <OnJournalExecuting> (p. 595) Callback that is invoked before executing an action
written in the journal. (inherited from
PropertyBase)
Callback <OnJournalRecording> (p. 596) Callback that is invoked before writting the journal
for an action. (inherited from PropertyBase)
Callback <OnMigrate> (p. 597) Callback that is invoked when the property version
has been changed. (inherited from PropertyBase)
Callback <OnRemove> (p. 598) Callback that is invoked when the property is
removed. (inherited from PropertyBase)
Callback <OnShow> (p. 599) Callback that is invoked when the property is
shown. (inherited from PropertyBase)
Callback <OnValidate> (p. 600) Callback that is invoked when the property is
validated. (inherited from PropertyBase)
Tag <Property> (p. 601) No details provided.
Callback <SetValue> (p. 602) Callback that is invoked when the property value
is set. (inherited from PropertyBase)
Callback <String2Value> (p. 603) Callback that is invoked to convert a string to the
property value. (inherited from PropertyBase)
Callback <Value2String> (p. 604) Callback that is invoked to convert the value
stored by the property into a string. (inherited
from PropertyBase)
Attribute caption= (p. 605) Caption of the property. (inherited from
PropertyBase)
Attribute class= (p. 606) Class name of the property's controller. (inherited
from PropertyBase)
Attribute control= (p. 607) Control type of the object.
Attribute default= (p. 608) Default value of the property. (inherited from
PropertyBase)
Attribute display= (p. 608) Display type of the property group.
Attribute elementtype= (p. 609) Property list element type (workflow). (inherited
from PropertyBase)
Attribute isparameter= (p. 610) Indicates whether the property is a parameter.
(inherited from PropertyBase)
Attribute keytype= (p. 611) Property dictionary key type (workflow). (inherited
from PropertyBase)
Attribute name= (p. 612) Name of the property. (inherited from
PropertyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
580 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Attribute needupdate= (p. 613) Indicates whether the context must be refreshed
when the property value changes. (inherited from
PropertyBase)
Attribute parameterizable= (p. 614) Specifies the property parameterization (workflow).
Indicates whether the property should be a
candidate for parameterization (in the schematic
property view, a check-box will appear). (inherited
from PropertyBase)
Attribute persistent= (p. 615) Specifies the property persistence (workflow).
Indicates whether the property data should be
saved within the project. (inherited from
PropertyBase)
Attribute readonly= (p. 616) Indicates whether the property is read-only.
(inherited from PropertyBase)
Attribute unit= (p. 617) Unit type of the property (for 'control' equals to
'float' only). (inherited from PropertyBase)
Attribute valuetype= (p. 618) Property dictionary value type (workflow).
(inherited from PropertyBase)
Attribute visible= (p. 618) Indicates whether the property is visible. (inherited
from PropertyBase)
Attribute visibleon= (p. 619) Specifies property visibility. With a PropertyGroup
parent of control type "select", indicates the select
values for this property to be visible (separate with
'|'). (inherited from PropertyBase)

<Attributes>
No details provided. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 581
ACT XML Tags

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<GetValue>
Callback that is invoked when the property value is acquired. (inherited from PropertyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
582 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is useful for transforming the stored property value.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue

Name
GetValue

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<help>
No details provided. (inherited from PropertyBase)

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 583
ACT XML Tags

Remarks
None.

Examples
None.

Details
Description
Indicate the help that will be shown for the property. (Wizard only)

Name
help

ValueName
None.

Public
True

TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

<IsValid>
Callback that is invoked to determine whether the property is valid. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid

Name
IsValid

Public
True

Obsolete
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
584 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<IsVisible>
Callback that is invoked to determine whether the property is visible. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible

Name
IsVisible

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 585
ACT XML Tags

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnActivate>
Callback that is invoked when the property is activated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate

Name
OnActivate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
586 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAdd>
Callback that is invoked when the property is added. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 587
ACT XML Tags

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAfterGeometryUpdate>
Callback that is invoked after the geometry has been updated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
588 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnApply>
Callback that is invoked when the property apply button is clicked. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate

Name
OnApply

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 589
ACT XML Tags

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state change. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
590 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnButtonClick>
Callback that is invoked when click on a property's button (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnButtonClick

Name
OnButtonClick

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 591
ACT XML Tags

<OnCancel>
Callback that is invoked when the property cancel button is clicked. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate

Name
OnCancel

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnDuplicate>
Callback that is invoked when the property is duplicated. (inherited from PropertyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
592 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnHide>
Callback that is invoked when the property is hidden. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 593
ACT XML Tags

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnInit>
Callback that is invoked when the property is initialized. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
594 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnJournalExecuting>
Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 595
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnJournalExecuting

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnJournalRecording>
Callback that is invoked before writting the journal for an action. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
596 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnJournalRecording

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnMigrate>
Callback that is invoked when the property version has been changed. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback allows the migration of data from the old saved property to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 597
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnPropertyMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnRemove>
Callback that is invoked when the property is removed. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
598 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnShow>
Callback that is invoked when the property is shown. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 599
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnValidate>
Callback that is invoked when the property is validated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
600 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate

Name
OnValidate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 601
ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<SetValue>
Callback that is invoked when the property value is set. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is useful for transforming the submitted property value.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue

Name
SetValue

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
602 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<String2Value>
Callback that is invoked to convert a string to the property value. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_String2Value

Name
String2Value

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 603
ACT XML Tags

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Value2String>
Callback that is invoked to convert the value stored by the property into a string. (inherited from
PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_Value2String

Name
Value2String

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
604 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

caption=
Caption of the property. (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
caption

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 605
ACT XML Tags

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

class=
Class name of the property's controller. (inherited from PropertyBase)

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes three arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The load associated to the property (of type IUserObject)

• The associated property (of type ISimProperty)

Examples
None.

Details
DefaultValue
None.

Name
class

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
606 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

control=
Control type of the object.

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
control

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 607
ACT XML Tags

default=
Default value of the property. (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
default

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

display=
Display type of the property group.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
608 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Type
Ansys_ACT_Interfaces_UserObject_PropertyDisplayEnum

Remarks
None.

Examples
None.

Details
DefaultValue
Caption

Name
display

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

elementtype=
Property list element type (workflow). (inherited from PropertyBase)

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 609
ACT XML Tags

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
elementtype

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

isparameter=
Indicates whether the property is a parameter. (inherited from PropertyBase)

Type
System_Boolean

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
610 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Examples
None.

Details
DefaultValue
False

Name
isparameter

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

keytype=
Property dictionary key type (workflow). (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 611
ACT XML Tags

Details
DefaultValue
None.

Name
keytype

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the property. (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
612 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Name
name

Mandatory
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

needupdate=
Indicates whether the context must be refreshed when the property value changes. (inherited from
PropertyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
True

Name
needupdate

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 613
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

parameterizable=
Specifies the property parameterization (workflow). Indicates whether the property should be a candidate
for parameterization (in the schematic property view, a check-box will appear). (inherited from Proper-
tyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
parameterizable

Mandatory
False

DataDefinition
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
614 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

persistent=
Specifies the property persistence (workflow). Indicates whether the property data should be saved
within the project. (inherited from PropertyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
persistent

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 615
ACT XML Tags

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

readonly=
Indicates whether the property is read-only. (inherited from PropertyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
False

Name
readonly

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
616 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

unit=
Unit type of the property (for 'control' equals to 'float' only). (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
unit

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 617
ACT XML Tags

valuetype=
Property dictionary value type (workflow). (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
valuetype

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

visible=
Indicates whether the property is visible. (inherited from PropertyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
618 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertygroup>

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
True

Name
visible

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

visibleon=
Specifies property visibility. With a PropertyGroup parent of control type "select", indicates the select
values for this property to be visible (separate with '|'). (inherited from PropertyBase)

Type
System_String_ARRAY_

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 619
ACT XML Tags

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
visibleon

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
True

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<propertytable>
Class encapsulateing a list of child properties under one table.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
620 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Examples
None.

Table 73: XML Tag Listing

Tag <Attributes> (p. 623) No details provided. (inherited from PropertyBase)

Tag <Callbacks> (p. 623) No details provided. (inherited from PropertyBase)
Callback <GetValue> (p. 624) Callback that is invoked when the property value
is acquired. (inherited from PropertyBase)
Tag <help> (p. 625) No details provided. (inherited from PropertyBase)
Callback <IsValid> (p. 626) Callback that is invoked to determine whether the
property is valid. (inherited from PropertyBase)
Callback <IsVisible> (p. 627) Callback that is invoked to determine whether the
property is visible. (inherited from PropertyBase)
Callback <OnActivate> (p. 627) Callback that is invoked when the property is
activated. (inherited from PropertyBase)
Callback <OnAdd> (p. 628) Callback that is invoked when the property is
added. (inherited from PropertyBase)
Callback <OnAfterGeometryUpdate> (p. 629) Callback that is invoked after the geometry has
been updated. (inherited from PropertyBase)
Callback <OnApply> (p. 630) Callback that is invoked when the property apply
button is clicked. (inherited from PropertyBase)
Callback <OnBodySuppressStateChange> (p. 631) Callback that is invoked when the body suppress
state change. (inherited from PropertyBase)
Callback <OnButtonClick> (p. 632) Callback that is invoked when click on a property's
button (inherited from PropertyBase)
Callback <OnCancel> (p. 633) Callback that is invoked when the property cancel
button is clicked. (inherited from PropertyBase)
Callback <OnDuplicate> (p. 634) Callback that is invoked when the property is
duplicated. (inherited from PropertyBase)
Callback <OnHide> (p. 635) Callback that is invoked when the property is
hidden. (inherited from PropertyBase)
Callback <OnInit> (p. 636) Callback that is invoked when the property is
initialized. (inherited from PropertyBase)
Callback <OnJournalExecuting> (p. 637) Callback that is invoked before executing an action
written in the journal. (inherited from
PropertyBase)
Callback <OnJournalRecording> (p. 638) Callback that is invoked before writting the journal
for an action. (inherited from PropertyBase)
Callback <OnMigrate> (p. 639) Callback that is invoked when the property version
has been changed. (inherited from PropertyBase)
Callback <OnRemove> (p. 640) Callback that is invoked when the property is
removed. (inherited from PropertyBase)
Callback <OnShow> (p. 641) Callback that is invoked when the property is
shown. (inherited from PropertyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 621
ACT XML Tags

Callback <OnValidate> (p. 642) Callback that is invoked when the property is
validated. (inherited from PropertyBase)
Tag <Property> (p. 643) No details provided.
Callback <SetValue> (p. 644) Callback that is invoked when the property value
is set. (inherited from PropertyBase)
Callback <String2Value> (p. 645) Callback that is invoked to convert a string to the
property value. (inherited from PropertyBase)
Callback <Value2String> (p. 646) Callback that is invoked to convert the value
stored by the property into a string. (inherited
from PropertyBase)
Attribute allowempty= (p. 647) Unit type of the property (for float control).
Attribute caption= (p. 648) Caption of the property. (inherited from
PropertyBase)
Attribute class= (p. 649) Class name of the property's controller. (inherited
from PropertyBase)
Attribute control= (p. 650) Control type of the object.
Attribute default= (p. 650) Default value of the property. (inherited from
PropertyBase)
Attribute display= (p. 651) Display type of the property group.
Attribute elementtype= (p. 652) Property list element type (workflow). (inherited
from PropertyBase)
Attribute isparameter= (p. 653) Indicates whether the property is a parameter.
(inherited from PropertyBase)
Attribute keytype= (p. 654) Property dictionary key type (workflow). (inherited
from PropertyBase)
Attribute name= (p. 655) Name of the property. (inherited from
PropertyBase)
Attribute needupdate= (p. 656) Indicates whether the context must be refreshed
when the property value changes. (inherited from
PropertyBase)
Attribute parameterizable= (p. 657) Specifies the property parameterization (workflow).
Indicates whether the property should be a
candidate for parameterization (in the schematic
property view, a check-box will appear). (inherited
from PropertyBase)
Attribute persistent= (p. 658) Specifies the property persistence (workflow).
Indicates whether the property data should be
saved within the project. (inherited from
PropertyBase)
Attribute readonly= (p. 659) Indicates whether the property is read-only.
(inherited from PropertyBase)
Attribute unit= (p. 660) Unit type of the property (for 'control' equals to
'float' only). (inherited from PropertyBase)
Attribute valuetype= (p. 660) Property dictionary value type (workflow).
(inherited from PropertyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
622 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Attribute visible= (p. 661) Indicates whether the property is visible. (inherited
from PropertyBase)
Attribute visibleon= (p. 662) Specifies property visibility. With a PropertyGroup
parent of control type "select", indicates the select
values for this property to be visible (separate with
'|'). (inherited from PropertyBase)

<Attributes>
No details provided. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 623
ACT XML Tags

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<GetValue>
Callback that is invoked when the property value is acquired. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is useful for transforming the stored property value.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue

Name
GetValue

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
624 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<help>
No details provided. (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
Description
Indicate the help that will be shown for the property. (Wizard only)

Name
help

ValueName
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 625
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

<IsValid>
Callback that is invoked to determine whether the property is valid. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
626 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

<IsVisible>
Callback that is invoked to determine whether the property is visible. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible

Name
IsVisible

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnActivate>
Callback that is invoked when the property is activated. (inherited from PropertyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 627
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate

Name
OnActivate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAdd>
Callback that is invoked when the property is added. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
628 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAfterGeometryUpdate>
Callback that is invoked after the geometry has been updated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 629
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnApply>
Callback that is invoked when the property apply button is clicked. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
630 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate

Name
OnApply

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state change. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 631
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnButtonClick>
Callback that is invoked when click on a property's button (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
632 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnButtonClick

Name
OnButtonClick

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnCancel>
Callback that is invoked when the property cancel button is clicked. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 633
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate

Name
OnCancel

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnDuplicate>
Callback that is invoked when the property is duplicated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
634 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnHide>
Callback that is invoked when the property is hidden. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 635
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnInit>
Callback that is invoked when the property is initialized. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
636 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnJournalExecuting>
Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 637
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnJournalExecuting

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnJournalRecording>
Callback that is invoked before writting the journal for an action. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
638 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnJournalRecording

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnMigrate>
Callback that is invoked when the property version has been changed. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback allows the migration of data from the old saved property to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 639
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnPropertyMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnRemove>
Callback that is invoked when the property is removed. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
640 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnShow>
Callback that is invoked when the property is shown. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 641
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnValidate>
Callback that is invoked when the property is validated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
642 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate

Name
OnValidate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 643
ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<SetValue>
Callback that is invoked when the property value is set. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is useful for transforming the submitted property value.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue

Name
SetValue

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
644 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<String2Value>
Callback that is invoked to convert a string to the property value. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_String2Value

Name
String2Value

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 645
ACT XML Tags

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Value2String>
Callback that is invoked to convert the value stored by the property into a string. (inherited from
PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_Value2String

Name
Value2String

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
646 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

allowempty=
Unit type of the property (for float control).

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
allowempty

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 647
ACT XML Tags

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

caption=
Caption of the property. (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
caption

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
648 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

class=
Class name of the property's controller. (inherited from PropertyBase)

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes three arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The load associated to the property (of type IUserObject)

• The associated property (of type ISimProperty)

Examples
None.

Details
Name
class

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 649
ACT XML Tags

control=
Control type of the object.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
control

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

default=
Default value of the property. (inherited from PropertyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
650 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Type
System_String

Remarks
None.

Examples
None.

Details
Name
default

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

display=
Display type of the property group.

Type
Ansys_ACT_Interfaces_UserObject_PropertyDisplayEnum

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 651
ACT XML Tags

Remarks
None.

Examples
None.

Details
Name
display

Mandatory
False

DefaultValue
Caption

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

elementtype=
Property list element type (workflow). (inherited from PropertyBase)

Type
System_String

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
652 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Examples
None.

Details
Name
elementtype

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

isparameter=
Indicates whether the property is a parameter. (inherited from PropertyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 653
ACT XML Tags

Details
Name
isparameter

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

keytype=
Property dictionary key type (workflow). (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
keytype

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
654 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the property. (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
True

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 655
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

needupdate=
Indicates whether the context must be refreshed when the property value changes. (inherited from
PropertyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
needupdate

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
656 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

parameterizable=
Specifies the property parameterization (workflow). Indicates whether the property should be a candidate
for parameterization (in the schematic property view, a check-box will appear). (inherited from Proper-
tyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
parameterizable

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 657
ACT XML Tags

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

persistent=
Specifies the property persistence (workflow). Indicates whether the property data should be saved
within the project. (inherited from PropertyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
persistent

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
658 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

readonly=
Indicates whether the property is read-only. (inherited from PropertyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
readonly

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 659
ACT XML Tags

unit=
Unit type of the property (for 'control' equals to 'float' only). (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
unit

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

valuetype=
Property dictionary value type (workflow). (inherited from PropertyBase)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
660 of ANSYS, Inc. and its subsidiaries and affiliates.
 <propertytable>

Type
System_String

Remarks
None.

Examples
None.

Details
Name
valuetype

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

visible=
Indicates whether the property is visible. (inherited from PropertyBase)

Type
System_Boolean

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 661
ACT XML Tags

Remarks
None.

Examples
None.

Details
Name
visible

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

visibleon=
Specifies property visibility. With a PropertyGroup parent of control type "select", indicates the select
values for this property to be visible (separate with '|'). (inherited from PropertyBase)

Type
System_String_ARRAY_

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
662 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Examples
None.

Details
Name
visibleon

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
True

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Result>
Class defining a result.

Remarks
None.

Examples
None.

Table 74: XML Tag Listing

Callback <Action> (p. 665) No details provided.

Tag <Attributes> (p. 666) No details provided. (inherited from SimEntity)
Tag <Callbacks> (p. 667) No details provided. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 663
ACT XML Tags

Callback <CanAdd> (p. 668) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 669) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 669) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Callback <Evaluate> (p. 670) Callback that is invoked when the step described
by stepInfo is evaluated.
Callback <GetFieldCount> (p. 671) Callback that is invoked to get the number of fields
for a given element or node ID.
Callback <GetValue> (p. 672) Callback that is invoked to get the values
associated to a node or an element given by its
ID.
Callback <IsValid> (p. 673) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 674) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 675) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 676) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 677) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 678) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnEndEval> (p. 679) Callback that is invoked at the end of the
evaluation process for a given step.
Callback <OnEndPost> (p. 680) Callback that is invoked at the end of the post
process.
Callback <OnGenerateData> (p. 681) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 682) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 683) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 684) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 685) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 686) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 687) Callback that is invoked when the object is shown.
(inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
664 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Callback <OnStartEval> (p. 688) Callback that is invoked when the evaluation
process for a given step starts.
Callback <OnStartPost> (p. 689) Callback that is invoked when the post process
starts.
Callback <OnSuppress> (p. 690) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 691) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 692) No details provided. (inherited from SimEntity)
Attribute averaging= (p. 693) Averaging of the result.
Attribute caption= (p. 694) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 695) Class name of the controller of the object.
(inherited from SimEntity)
Attribute contextual= (p. 696) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute hasimaginary= (p. 697) Indicates whether the result supports imaginary
values.
Attribute icon= (p. 697) Icon for the object. (inherited from SimEntity)
Attribute iscontactresult= (p. 698) Indicates whether the result object should be
considered as a contact result or not.
Attribute location= (p. 699) Location of the result.
Attribute name= (p. 700) Name of the object. (inherited from SimEntity)
Attribute timehistory= (p. 701) Indicates whether the time history has to be
calculated.
Attribute type= (p. 702) Type of the result.
Attribute unit= (p. 703) Unit used by the contour display.
Attribute version= (p. 704) Version of the object. (inherited from SimEntity)

<Action>
No details provided.

Type
List_Action_

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 665
ACT XML Tags

Details
CallbackType
None.

Name
Action

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
666 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 667
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
668 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 669
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Evaluate>
Callback that is invoked when the step described by stepInfo is evaluated.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
670 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_Evaluate

Name
Evaluate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<GetFieldCount>
Callback that is invoked to get the number of fields for a given element or node ID.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 671
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetFieldCount

Name
GetFieldCount

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
672 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetValue

Name
GetValue

Public
True

Obsolete
True

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 673
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
674 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 675
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
676 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 677
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
678 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnEndEval>
Callback that is invoked at the end of the evaluation process for a given step.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 679
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_StartEndEval

Name
OnEndEval

Public
True

Obsolete
True

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnEndPost>
Callback that is invoked at the end of the post process.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
680 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
CallbackType
ActionCallback_IUserResult_

Name
OnEndPost

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 681
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
682 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 683
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
684 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 685
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
686 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 687
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnStartEval>
Callback that is invoked when the evaluation process for a given step starts.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
688 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
CallbackType
Ansys_ACT_Core_Callbacks_StartEndEval

Name
OnStartEval

Public
True

Obsolete
True

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnStartPost>
Callback that is invoked when the post process starts.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 689
ACT XML Tags

Details
CallbackType
ActionCallback_IUserResult_

Name
OnStartPost

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
690 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 691
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
692 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

averaging=
Averaging of the result.

Type
Ansys_ACT_Interfaces_Post_ResultAveragingEnum

Remarks
None.

Examples
None.

Details
Name
averaging

Mandatory
False

DefaultValue
Unaverage

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 693
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
caption

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
694 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
Name
class

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 695
ACT XML Tags

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
Name
contextual

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
696 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

hasimaginary=
Indicates whether the result supports imaginary values.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
hasimaginary

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 697
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Name
icon

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
698 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Remarks
None.

Examples
None.

Details
Name
iscontactresult

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
False

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

location=
Location of the result.

Type
Ansys_ACT_Interfaces_Post_ResultLocationEnum

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 699
ACT XML Tags

Examples
None.

Details
Name
location

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
System.String[]

MultipleValue
False

MappedValues
System.Object[]

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
700 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

Details
Name
name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

timehistory=
Indicates whether the time history has to be calculated.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
timehistory

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 701
ACT XML Tags

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

type=
Type of the result.

Type
Ansys_ACT_Interfaces_Post_ResultTypeEnum

Remarks
None.

Examples
None.

Details
Name
type

Mandatory
True

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
702 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Result>

DataDefinition
False

AllowedValues
System.String[]

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

unit=
Unit used by the contour display.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
unit

Mandatory
False

DefaultValue
Dimensionless

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 703
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
version

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
704 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<rsmjob>
This class defines an rsm job.

Remarks
None.

Examples
None.

Table 75: XML Tag Listing

Tag <Attributes> (p. 706) No details provided. (inherited from SimEntity)

Tag <Callbacks> (p. 707) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 708) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 709) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 710) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Tag <InputFile> (p. 711) The job input files.
Callback <IsValid> (p. 711) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 712) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 713) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 714) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 715) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <oncreatejobinput> (p. 716) This callback handles the generation of all input
files defined on the rsm job.
Callback <OnDuplicate> (p. 717) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 718) Callback that is invoked when object data are
generated. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 705
ACT XML Tags

Callback <OnHide> (p. 719) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 720) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <onjobcancellation> (p. 721) This callback handles a user-invoked job
cancellation.
Callback <onjobreconnect> (p. 722) This callback handles the reconnection of the rsm
job. The implementor must update the task data
model to deem the task as up-to-date.
Callback <onjobstatus> (p. 723) This callback handles the status polling engaged
by the Framework. Return True to indicate the job
has completed.
Callback <OnMigrate> (p. 724) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 725) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 726) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 727) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 728) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 729) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <OutputFile> (p. 730) The job output files.
Tag <Program> (p. 731) The programs to run by the rsm job. Currently
only one program per job allowed.
Tag <Property> (p. 732) No details provided. (inherited from SimEntity)
Attribute caption= (p. 732) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 733) Class name of the controller of the object.
(inherited from SimEntity)
Attribute contextual= (p. 734) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute deletefiles= (p. 735) Indicates whether ACT should delete all rsmJob
input and output files upon successful completion
or job cancellation.
Attribute icon= (p. 736) Icon for the object. (inherited from SimEntity)
Attribute name= (p. 737) Name of the object. (inherited from SimEntity)
Attribute version= (p. 738) Version of the object. (inherited from SimEntity)

<Attributes>
No details provided. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
706 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 707
ACT XML Tags

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Mandatory
False

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
708 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Mandatory
False

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 709
ACT XML Tags

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Mandatory
False

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
710 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<InputFile>
The job input files.

Type
Ansys_ACT_Core_XmlDataModel_InputFile (p. 255)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_InputFile

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 711
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Mandatory
False

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
712 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Mandatory
False

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 713
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Mandatory
False

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
714 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Mandatory
False

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 715
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Mandatory
False

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<oncreatejobinput>
This callback handles the generation of all input files defined on the rsm job.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
716 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Details
CallbackType
ActionCallback_IUserObject__List_string__

Mandatory
True

Name
oncreatejobinput

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
1

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 717
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Mandatory
False

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
718 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Mandatory
False

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 719
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Mandatory
False

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
720 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Mandatory
False

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onjobcancellation>
This callback handles a user-invoked job cancellation.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 721
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject__List_string___List_string__

Mandatory
True

Name
onjobcancellation

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
1

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onjobreconnect>
This callback handles the reconnection of the rsm job. The implementor must update the task data
model to deem the task as up-to-date.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
722 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Details
CallbackType
ActionCallback_IUserObject__List_string__

Mandatory
True

Name
onjobreconnect

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
1

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onjobstatus>
This callback handles the status polling engaged by the Framework. Return True to indicate the job has
completed.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 723
ACT XML Tags

Details
CallbackType
FuncCallback_IUserObject__List_string___bool_

Mandatory
True

Name
onjobstatus

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
1

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
724 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Mandatory
False

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 725
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Mandatory
False

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
726 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Mandatory
False

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 727
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Mandatory
False

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
728 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Mandatory
False

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 729
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Mandatory
False

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OutputFile>
The job output files.

Type
Ansys_ACT_Core_XmlDataModel_OutputFile (p. 458)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
730 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Details
ChildType
Ansys_ACT_Core_XmlDataModel_OutputFile

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Program>
The programs to run by the rsm job. Currently only one program per job allowed.

Type
Ansys_ACT_Core_XmlDataModel_Program (p. 536)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Program

MinOccurence
1

MaxOccurence
1

RealParent
None.

Mandatory
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 731
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
732 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Details
DefaultValue
None.

Name
caption

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 733
ACT XML Tags

Details
DefaultValue
None.

Name
class

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
DefaultValue
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
734 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

Name
contextual

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

deletefiles=
Indicates whether ACT should delete all rsmJob input and output files upon successful completion or
job cancellation.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
False

Name
deletefiles

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 735
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
icon

Mandatory
False

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
736 of ANSYS, Inc. and its subsidiaries and affiliates.
 <rsmjob>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
name

Mandatory
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 737
ACT XML Tags

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Examples
None.

Details
DefaultValue
None.

Name
version

Mandatory
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
738 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Sampling>
Class defining a DesignXplorer Sampling.

Remarks
None.

Examples
None.

Table 76: XML Tag Listing

Tag <Attributes> (p. 742) No details provided. (inherited from

SimEntity)
Tag <Callbacks> (p. 742) No details provided. (inherited from
SimEntity)
Callback <CanAdd> (p. 743) Callback that is invoked to determine
whether the object can be added.
(inherited from SimEntity)
Callback <CanDuplicate> (p. 744) Callback that is invoked to determine if
the object can be duplicated. (inherited
from SimEntity)
Callback <CanRemove> (p. 745) Callback that is invoked to determine if
the object can be removed. (inherited
from SimEntity)
Callback <CanRun> (p. 746) Callback that is invoked to indicate
whether the optimizer (or sampling) is
able to process the optimization (design
of experiments) study with its current
configuration. (inherited from
DesignExplorer)
Callback <Configuration> (p. 747) Callback that is invoked to return a
userreadable string summarizing the
current configuration of the optimizer
(or the sampling). (inherited from
DesignExplorer)
Callback <Description> (p. 748) Callback that is invoked to return a
user-readable string describing the
optimizer and its specific capabilities.
(inherited from DesignExplorer)
Callback <InputParametersEdited> (p. 749) Callback that is invoked when the
properties of input parameters have
changed. (inherited from
DesignExplorer)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 739
ACT XML Tags

Callback <IsValid> (p. 750) Callback that is invoked to determine if

the object is valid. (inherited from
SimEntity)
Callback <MethodPropertiesEdited> (p. 751) Callback that is invoked when the
properties of the optimization method
have changed. (inherited from
DesignExplorer)
Callback <OnAdd> (p. 752) Callback that is invoked when the object
is newly added. (inherited from
SimEntity)
Callback <OnAfterGeometryUpdate> (p. 752) Callback that is invoked when the
geometry has been updated. (inherited
from SimEntity)
Callback <OnBodySuppressStateChange> (p. 753) Callback that is invoked when the body
suppress state changse. (inherited from
SimEntity)
Callback <OnClearData> (p. 754) Callback that is invoked when object
data are cleared. (inherited from
SimEntity)
Callback <OnCreate> (p. 755) Callback that is invoked to provide an
instance of IOptimizationMethod (or
ISamplingMethod). (inherited from
DesignExplorer)
Callback <OnDuplicate> (p. 756) Callback that is invoked when the object
is duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 757) Callback that is invoked when object
data are generated. (inherited from
SimEntity)
Callback <OnHide> (p. 758) Callback that is invoked when the object
is hidden. (inherited from SimEntity)
Callback <OnInit> (p. 759) Callback that is invoked when the object
is initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 760) Callback that is invoked when the object
version has been changed. (inherited
from SimEntity)
Callback <OnReady> (p. 761) Callback that is invoked when the
application is fully loaded and in a
"ready" state. (Inherited from SimEntity)
(inherited from SimEntity)
Callback <OnRelease> (p. 762) Callback that is invoked to release the
IOptimizationMethod (or the
ISamplingMethod) instance. (inherited
from DesignExplorer)
Callback <OnRemove> (p. 763) Callback that is invoked when the object
is removed. (inherited from SimEntity)
Callback <OnShow> (p. 764) Callback that is invoked when the object
is shown. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
740 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Callback <OnSuppress> (p. 765) Callback that is invoked when the object
is suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 766) Callback that is invoked when the object
is unsuppressed. (inherited from
SimEntity)
Tag <Property> (p. 767) No details provided. (inherited from
SimEntity)
Callback <QuickHelp> (p. 768) Callback that is invoked to return a
user-readable string helping to
understand the state of the optimizer
(or the sampling) when CanRun is false.
(inherited from DesignExplorer)
Callback <Status> (p. 769) Callback that is invoked to return a
user-readable string describing the
status of the optimization (or the
sampling) resolution. (inherited from
DesignExplorer)
Attribute caption= (p. 770) Caption of the object. (inherited from
SimEntity)
Attribute class= (p. 771) Class name of the controller of the
object. (inherited from SimEntity)
Attribute contextual= (p. 772) Indicates whether the object has to be
displayed in the contextual menu.
(inherited from SimEntity)
Attribute CustomTable= (p. 773) Supports custom table points.
Attribute icon= (p. 773) Icon for the object. (inherited from
SimEntity)
Attribute logfile= (p. 774) Provides messages to generate a log file.
(inherited from DesignExplorer)
Attribute maximumnumberofdoublelistparameters= (p. 775) Indicates the maximum number of
double list parameters supported.
(inherited from DesignExplorer)
Attribute maximumnumberofdoubleparameters= (p. 776) Indicates the maximum number of
double parameters supported. (inherited
from DesignExplorer)
Attribute maximumnumberofinputparameters= (p. 777) Indicates the maximum number of input
parameters supported. (inherited from
DesignExplorer)
Attribute maximumnumberofintegerlistparameters= (p. 778) Indicates the maximum number of
integer list parameters supported.
(inherited from DesignExplorer)
Attribute name= (p. 779) Name of the object. (inherited from
SimEntity)
Attribute version= (p. 780) Version of the object. (inherited from
SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 741
ACT XML Tags

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
742 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 743
ACT XML Tags

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
744 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 745
ACT XML Tags

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<CanRun>
Callback that is invoked to indicate whether the optimizer (or sampling) is able to process the optimiz-
ation (design of experiments) study with its current configuration. (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__bool_

Name
CanRun

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
746 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Configuration>
Callback that is invoked to return a userreadable string summarizing the current configuration of the
optimizer (or the sampling). (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_

Name
Configuration

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 747
ACT XML Tags

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Description>
Callback that is invoked to return a user-readable string describing the optimizer and its specific capab-
ilities. (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_

Name
Description

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
748 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<InputParametersEdited>
Callback that is invoked when the properties of input parameters have changed. (inherited from De-
signExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_

Name
InputParametersEdited

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 749
ACT XML Tags

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
750 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

<MethodPropertiesEdited>
Callback that is invoked when the properties of the optimization method have changed. (inherited from
DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_

Name
MethodPropertiesEdited

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 751
ACT XML Tags

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
752 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 753
ACT XML Tags

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
754 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnCreate>
Callback that is invoked to provide an instance of IOptimizationMethod (or ISamplingMethod). (inherited
from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 755
ACT XML Tags

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__object_

Name
OnCreate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
756 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 757
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
758 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 759
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
760 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 761
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnRelease>
Callback that is invoked to release the IOptimizationMethod (or the ISamplingMethod) instance. (inherited
from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
762 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Details
CallbackType
ActionCallback_IUserObject_

Name
OnRelease

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 763
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
764 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 765
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
766 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 767
ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<QuickHelp>
Callback that is invoked to return a user-readable string helping to understand the state of the optimizer
(or the sampling) when CanRun is false. (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_

Name
QuickHelp

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
768 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Status>
Callback that is invoked to return a user-readable string describing the status of the optimization (or
the sampling) resolution. (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_

Name
Status

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 769
ACT XML Tags

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
caption

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
770 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
Name
class

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 771
ACT XML Tags

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
Name
contextual

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
772 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

CustomTable=
Supports custom table points.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
CustomTable

Mandatory
False

DefaultValue
False

DataDefinition
True

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 773
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Name
icon

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

logfile=
Provides messages to generate a log file. (inherited from DesignExplorer)

Type
System_Boolean

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
774 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Remarks
None.

Examples
None.

Details
Name
logfile

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

maximumnumberofdoublelistparameters=
Indicates the maximum number of double list parameters supported. (inherited from DesignExplorer)

Type
System_Int32

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 775
ACT XML Tags

Examples
None.

Details
Name
maximumnumberofdoublelistparameters

Mandatory
False

DefaultValue
100

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

maximumnumberofdoubleparameters=
Indicates the maximum number of double parameters supported. (inherited from DesignExplorer)

Type
System_Int32

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
776 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

Details
Name
maximumnumberofdoubleparameters

Mandatory
False

DefaultValue
100

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

maximumnumberofinputparameters=
Indicates the maximum number of input parameters supported. (inherited from DesignExplorer)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
maximumnumberofinputparameters

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 777
ACT XML Tags

Mandatory
False

DefaultValue
100

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

maximumnumberofintegerlistparameters=
Indicates the maximum number of integer list parameters supported. (inherited from DesignExplorer)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
maximumnumberofintegerlistparameters

Mandatory
False

DefaultValue
100

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
778 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Sampling>

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 779
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
version

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
780 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Scene>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Scene>
No details provided.

Remarks
None.

Examples
None.

Table 77: XML Tag Listing

Tag <Callbacks> (p. 781) Specifies the callbacks that will invoke functions from the
IronPython extension script. (inherited from Presentation)
Callback <OnAdd> (p. 782) No details provided. (inherited from Presentation)
Callback <OnDelete> (p. 783) No details provided. (inherited from Presentation)
Callback <OnHighlight> (p. 784) No details provided. (inherited from Presentation)
Callback <OnUnhighlight> (p. 785) No details provided. (inherited from Presentation)
Callback <OnUpdate> (p. 786) No details provided. (inherited from Presentation)
Attribute allowHighlight= (p. 787) No details provided. (inherited from Presentation)
Attribute userObject= (p. 788) No details provided. (inherited from Presentation)
Attribute visibility= (p. 788) No details provided. (inherited from Presentation)

<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (inherited from
Presentation)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 781
ACT XML Tags

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<OnAdd>
No details provided. (inherited from Presentation)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPresentation_

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
782 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Scene>

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnDelete>
No details provided. (inherited from Presentation)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPresentation_

Name
OnDelete

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 783
ACT XML Tags

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnHighlight>
No details provided. (inherited from Presentation)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPresentation_

Name
OnHighlight

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
784 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Scene>

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnUnhighlight>
No details provided. (inherited from Presentation)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPresentation_

Name
OnUnhighlight

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 785
ACT XML Tags

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnUpdate>
No details provided. (inherited from Presentation)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IPresentation_

Name
OnUpdate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
786 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Scene>

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

allowHighlight=
No details provided. (inherited from Presentation)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
allowHighlight

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 787
ACT XML Tags

userObject=
No details provided. (inherited from Presentation)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
userObject

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

visibility=
No details provided. (inherited from Presentation)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
788 of ANSYS, Inc. and its subsidiaries and affiliates.
 <script>

Type
Ansys_ACT_Interfaces_Presentations_VisibilityOptions

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
visibility

DefaultValue
Always

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<script>
Specifies the IronPython script referenced by the extension.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 789
ACT XML Tags

Examples
None.

Table 78: XML Tag Listing

Attribute compiled= (p. 790) Specifies whether the script will be compiled as a
binary file.
Attribute src= (p. 791) Name of the Python script file.

compiled=
Specifies whether the script will be compiled as a binary file.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
DefaultValue
False

Name
compiled

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
790 of ANSYS, Inc. and its subsidiaries and affiliates.
 <separator>

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

src=
Name of the Python script file.

Type
System_String

Remarks
By default, all folders referenced by this attribute are relatives to the folder of the extension.

Examples
None.

Details
DefaultValue
None.

Name
src

Mandatory
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<separator>
Class defining the separator for items in a toolbar.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 791
ACT XML Tags

Remarks
None.

Examples
None.

<simdata>
Class defining a general section that stores all user object definitions.

Remarks
None.

Examples
None.

Table 79: XML Tag Listing

Tag <Load> (p. 792) No details provided.

Attribute context= (p. 793) Context or combination of contexts (separated
using '|').

<Load>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Load (p. 307)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Load

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
792 of ANSYS, Inc. and its subsidiaries and affiliates.
 <simdata>

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

context=
Context or combination of contexts (separated using '|').

Type
System_String_ARRAY_

Remarks
This block will be taken into account only for the specified context(s).

Examples
None.

Details
DefaultValue
None.

Name
context

Mandatory
True

DataDefinition
False

AllowedValues
None.

MultipleValue
True

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 793
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Solver>
Class specifying a third-party solver to be used in the simulation.

Remarks
None.

Examples
None.

Table 80: XML Tag Listing

Tag <Attributes> (p. 795) No details provided. (inherited from SimEntity)

Tag <Callbacks> (p. 796) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 797) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 798) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 799) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Callback <GetFiles> (p. 800) Callback that is invoked to return a list of file
strings used by a custom solver.
Callback <GetReader> (p. 800) Callback that is invoked to get the reader class
name and associated options.
Callback <GetSteps> (p. 801) Callback that is invoked to get the list of time
steps (or frequencies) that were computed during
the solve and are available for the post-processing.
Callback <IsAnalysisValid> (p. 802) Callback that is invoked to determine whether the
analysis is valid.
Callback <IsValid> (p. 803) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 804) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 805) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBeforeSolve> (p. 806) Callback that is invoked before the solve process.
Callback <OnBodySuppressStateChange> (p. 807) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnCheckResults> (p. 808) Callback that is invoked before any post-processing
evaluation.
Callback <OnClearData> (p. 809) Callback that is invoked when object data are
cleared. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
794 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Callback <OnDuplicate> (p. 810) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 811) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 812) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 813) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 814) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 815) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 816) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 817) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSolve> (p. 818) Callback that is invoked when the solve process
is run.
Callback <OnSuppress> (p. 819) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 820) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Callback <OnWriteInputFile> (p. 821) Callback that is invoked to write the solver input
file.
Tag <Property> (p. 822) No details provided. (inherited from SimEntity)
Attribute analysis= (p. 823) Type of analysis.
Attribute caption= (p. 824) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 825) Class name of the controller of the object.
(inherited from SimEntity)
Attribute contextual= (p. 826) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 827) Icon for the object. (inherited from SimEntity)
Attribute name= (p. 827) Name of the object. (inherited from SimEntity)
Attribute physics= (p. 828) Type of physics.
Attribute toolbox= (p. 829) Name of the toolbox.
Attribute version= (p. 830) Version of the object. (inherited from SimEntity)

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 795
ACT XML Tags

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
796 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 797
ACT XML Tags

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
798 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 799
ACT XML Tags

<GetFiles>
Callback that is invoked to return a list of file strings used by a custom solver.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetFiles

Name
GetFiles

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<GetReader>
Callback that is invoked to get the reader class name and associated options.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
800 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetReader

Name
GetReader

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<GetSteps>
Callback that is invoked to get the list of time steps (or frequencies) that were computed during the
solve and are available for the post-processing.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 801
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSteps

Name
GetSteps

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<IsAnalysisValid>
Callback that is invoked to determine whether the analysis is valid.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
802 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsSolverAnalysisValid

Name
IsAnalysisValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 803
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
804 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 805
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnBeforeSolve>
Callback that is invoked before the solve process.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
806 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolve

Name
OnBeforeSolve

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 807
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnCheckResults>
Callback that is invoked before any post-processing evaluation.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
808 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnCheckResults

Name
OnCheckResults

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 809
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
810 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 811
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
812 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 813
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
814 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 815
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
816 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 817
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnSolve>
Callback that is invoked when the solve process is run.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
818 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSolve

Name
OnSolve

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 819
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
820 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnWriteInputFile>
Callback that is invoked to write the solver input file.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after "OnBeforeSolve" and before "OnSolve" in a full solve process.

If the user ask only to write the input file, the callback will be called after "OnBeforeSolve".

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 821
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnWriteInputFile

Name
OnWriteInputFile

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
822 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

analysis=
Type of analysis.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
analysis

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 823
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
caption

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
824 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
Name
class

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 825
ACT XML Tags

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
Name
contextual

Mandatory
False

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
826 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

icon=
Icon for the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
icon

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 827
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

physics=
Type of physics.

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
828 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Solver>

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
physics

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

toolbox=
Name of the toolbox.

Type
System_String

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 829
ACT XML Tags

Examples
None.

Details
Mandatory
False

Name
toolbox

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
830 of ANSYS, Inc. and its subsidiaries and affiliates.
 <StandardAction>

Details
Name
version

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<StandardAction>
No details provided.

Remarks
None.

Examples
None.

Table 81: XML Tag Listing

Attribute actionId= (p. 832) No details

provided.
Attribute caption= (p. 832) No details
provided.
Attribute name= (p. 833) No details
provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 831
ACT XML Tags

actionId=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
actionId

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

caption=
No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
832 of ANSYS, Inc. and its subsidiaries and affiliates.
 <StandardAction>

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
caption

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
No details provided.

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 833
ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Step>
Class defining a step in a guided process a (wizard or AIM custom template).

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
834 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Examples
None.

Table 82: XML Tag Listing

Tag <Attributes> (p. 836) No details provided. (inherited from SimEntity)

Tag <Callbacks> (p. 837) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 837) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 838) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 839) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Tag <ComponentData> (p. 840) Data of the components in the step's layout.
Tag <ComponentStyle> (p. 841) Styles of the components in the step's layout.
Tag <Description> (p. 842) Gets or sets the description of the step.
Callback <IsValid> (p. 842) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 843) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 844) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 845) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 846) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <oncreate> (p. 847) No details provided.
Callback <OnDuplicate> (p. 848) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 849) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 850) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 851) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 852) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 853) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <onrefresh> (p. 854) Callback that is invoked when the step is
initialized.
Callback <OnRemove> (p. 855) Callback that is invoked when the object is
removed. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 835
ACT XML Tags

Callback <onreset> (p. 856) Callback that is invoked when we return to the
previous step.
Callback <OnShow> (p. 857) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 858) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 859) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Callback <onupdate> (p. 860) Callback that is invoked when the step is finalized.
Tag <Property> (p. 861) No details provided. (inherited from SimEntity)
Attribute caption= (p. 862) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 863) Class name of the controller of the object.
(inherited from SimEntity)
Attribute Context= (p. 864) Gets or sets the context name.
Attribute contextual= (p. 865) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute Enabled= (p. 866) Gets or sets the Enabled flag.
Attribute helpFile= (p. 866) File containing help HTML content.
Attribute icon= (p. 867) Icon for the object. (inherited from SimEntity)
Attribute Layout= (p. 868) Gets or sets the layout to use for this step.
Attribute name= (p. 869) Name of the object. (inherited from SimEntity)
Attribute version= (p. 870) Version of the object. (inherited from SimEntity)

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
836 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 837
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
838 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 839
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<ComponentData>
Data of the components in the step's layout.

Type
Ansys_ACT_Core_XmlDataModel_ComponentData (p. 80)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
840 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<ComponentStyle>
Styles of the components in the step's layout.

Type
Ansys_ACT_Core_XmlDataModel_ComponentStyle (p. 88)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 841
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Description>
Gets or sets the description of the step.

Type
System_String

Remarks
None.

Examples
None.

Details
Description
None.

Name
Description

ValueName
None.

Public
True

TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
842 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 843
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
844 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 845
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
846 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<oncreate>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 847
ACT XML Tags

Details
CallbackType
ActionCallback_IWizardStep_

Name
oncreate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
848 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 849
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
850 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 851
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
852 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 853
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onrefresh>
Callback that is invoked when the step is initialized.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
854 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Details
CallbackType
ActionCallback_IWizardStep_

Name
onrefresh

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 855
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onreset>
Callback that is invoked when we return to the previous step.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
856 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Details
CallbackType
ActionCallback_IWizardStep_

Name
onreset

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 857
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
858 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 859
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onupdate>
Callback that is invoked when the step is finalized.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
860 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Details
CallbackType
ActionCallback_IWizardStep_

Name
onupdate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 861
ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
caption

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
862 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
Mandatory
False

Name
class

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 863
ACT XML Tags

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Context=
Gets or sets the context name.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
Context

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
864 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
Mandatory
False

Name
contextual

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 865
ACT XML Tags

Enabled=
Gets or sets the Enabled flag.

Type
System_Boolean

Remarks
This flag is true by default.

Examples
None.

Details
Mandatory
False

Name
Enabled

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

helpFile=
File containing help HTML content.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
866 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
helpFile

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object. (inherited from SimEntity)

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 867
ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
icon

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Layout=
Gets or sets the layout to use for this step.

Type
System_String

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
868 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Step>

Examples
None.

Details
Mandatory
False

Name
Layout

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 869
ACT XML Tags

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
870 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Target>

Name
version

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Target>
Class defining the target location for the object.

Remarks
None.

Examples
None.

Table 83: XML Tag Listing

Attribute location= (p. 871) Sub-type of the target location when

ype==Analysis.
Attribute name= (p. 872) Name of the parent.
Attribute type= (p. 873) Type of the target location.

location=
Sub-type of the target location when ype==Analysis.

Type
Ansys_ACT_Interfaces_UserObject_ObjectLocationEnum

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 871
ACT XML Tags

Remarks
None.

Examples
None.

Details
Name
location

Mandatory
False

DefaultValue
Default

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the parent.

Type
System_String

Remarks
This is the name of an object defined in the extension XML file. Used only if type==UserObject.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
872 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Target>

Examples
None.

Details
Name
name

Mandatory
False

DefaultValue
Default

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

type=
Type of the target location.

Type
Ansys_ACT_Interfaces_UserObject_ObjectTypeEnum

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 873
ACT XML Tags

Details
Name
type

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<task>
Class defining a task that encapsulates a single process or application.

Remarks
None.

Examples
None.

Table 84: XML Tag Listing

Tag <Attributes> (p. 876) No details provided. (inherited from SimEntity)

Tag <Callbacks> (p. 877) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 877) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <canconsumedata> (p. 878) Callback that is invoked for task
connection/consumption.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
874 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Callback <CanDuplicate> (p. 879) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 880) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Tag <ContextMenus> (p. 881) The user-defined custom context menu entries.
Tag <Inputs> (p. 882) User-defined task input connections.
Callback <IsValid> (p. 883) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 884) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 884) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 885) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 886) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <ondelete> (p. 887) Callback that is invoked for task deletion.
Callback <OnDuplicate> (p. 888) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <onedit> (p. 889) Callback that is invoked for task EDIT entry.
Callback <OnGenerateData> (p. 890) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 891) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 892) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <oninitialize> (p. 893) Callback that is invoked for task creation.
Callback <onload> (p. 894) Callback that is invoked when a task is loaded
from disk.
Callback <OnMigrate> (p. 895) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 896) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <onrefresh> (p. 897) Callback that is invoked for task refresh.
Callback <OnRemove> (p. 898) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <onreport> (p. 899) Callback that is invoked for task reporting.
Callback <onreset> (p. 900) Callback that is invoked for task reset.
Callback <OnShow> (p. 901) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <onstatus> (p. 902) Callback that is invoked for task status.
Callback <OnSuppress> (p. 903) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 875
ACT XML Tags

Callback <OnUnsuppress> (p. 904) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Callback <onupdate> (p. 905) Callback that is invoked for task update.
Tag <Outputs> (p. 906) User-defined task output connections.
Tag <Parameters> (p. 907) User-defined parameters to be exposed on the
task.
Tag <Property> (p. 908) No details provided. (inherited from SimEntity)
Tag <RsmJob> (p. 908) List of task-level RSM Jobs.
Attribute caption= (p. 909) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 910) Class name of the controller of the object.
(inherited from SimEntity)
Attribute contextual= (p. 911) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute enableGenericTransfer= (p. 912) Indicates whether or not the task should expose
the general transfer type as an output.
Attribute icon= (p. 913) Icon for the object. (inherited from SimEntity)
Attribute name= (p. 913) Name of the object. (inherited from SimEntity)
Attribute version= (p. 914) Version of the object. (inherited from SimEntity)

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
876 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 877
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<canconsumedata>
Callback that is invoked for task connection/consumption.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
878 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
CallbackType
FuncCallback_object__IUserObject__bool_

Name
canconsumedata

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 879
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
880 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<ContextMenus>
The user-defined custom context menu entries.

Type
Ansys_ACT_Core_XmlDataModel_ContextMenus (p. 92)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 881
ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_ContextMenus

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Inputs>
User-defined task input connections.

Type
Ansys_ACT_Core_XmlDataModel_Inputs (p. 263)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Inputs

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
882 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 883
ACT XML Tags

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
884 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 885
ACT XML Tags

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
886 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<ondelete>
Callback that is invoked for task deletion.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 887
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
ondelete

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
888 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onedit>
Callback that is invoked for task EDIT entry.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 889
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
onedit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
890 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 891
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
892 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<oninitialize>
Callback that is invoked for task creation.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 893
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
oninitialize

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onload>
Callback that is invoked when a task is loaded from disk.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
894 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
CallbackType
ActionCallback_IUserObject_

Name
onload

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 895
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
896 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onrefresh>
Callback that is invoked for task refresh.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 897
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
onrefresh

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
898 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onreport>
Callback that is invoked for task reporting.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 899
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject__object_

Name
onreport

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onreset>
Callback that is invoked for task reset.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
900 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
CallbackType
ActionCallback_IUserObject_

Name
onreset

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 901
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onstatus>
Callback that is invoked for task status.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
902 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
CallbackType
FuncCallback_IUserObject__object_

Name
onstatus

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 903
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
904 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onupdate>
Callback that is invoked for task update.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 905
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
onupdate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Outputs>
User-defined task output connections.

Type
Ansys_ACT_Core_XmlDataModel_Outputs (p. 460)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
906 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Outputs

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Parameters>
User-defined parameters to be exposed on the task.

Type
Ansys_ACT_Core_XmlDataModel_Parameters (p. 519)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Parameters

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 907
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<RsmJob>
List of task-level RSM Jobs.

Type
Ansys_ACT_Core_XmlDataModel_RsmJob (p. 705)

Remarks
Currently only one entry is allowed.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
908 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Details
ChildType
Ansys_ACT_Core_XmlDataModel_RsmJob

MinOccurence
0

MaxOccurence
1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
caption

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 909
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
Mandatory
False

Name
class

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
910 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
Mandatory
False

Name
contextual

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 911
ACT XML Tags

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

enableGenericTransfer=
Indicates whether or not the task should expose the general transfer type as an output.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
enableGenericTransfer

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
912 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

icon=
Icon for the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
icon

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 913
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
914 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
version

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<task>
No details provided.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 915
ACT XML Tags

Examples
None.

Table 85: XML Tag Listing

Attribute Message= (p. 916) No details

provided.
Attribute Name= (p. 917) No details
provided.
Attribute Pct= (p. 918) No details
provided.

Message=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
Message

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
916 of ANSYS, Inc. and its subsidiaries and affiliates.
 <task>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Name=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
Name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 917
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Pct=
No details provided.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
Pct

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<taskgroup>
Class defining a collection of tasks.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
918 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Remarks
None.

Examples
None.

Table 86: XML Tag Listing

Tag <Attributes> (p. 920) No details provided. (inherited from SimEntity)

Tag <Callbacks> (p. 921) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 921) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 922) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 923) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Tag <IncludeGroup> (p. 924) The task group's List of nested task groups.
Tag <IncludeTask> (p. 925) List of tasks for the task group.
Callback <IsValid> (p. 926) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 927) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 927) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 928) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 929) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 930) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 931) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 932) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 933) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 934) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 935) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 936) Callback that is invoked when the object is
removed. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 919
ACT XML Tags

Callback <OnShow> (p. 937) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 938) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 939) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 940) No details provided. (inherited from SimEntity)
Attribute abbreviation= (p. 941) Task group abbreviation used for directory and
naming purposes.
Attribute caption= (p. 942) Caption of the object. (inherited from SimEntity)
Attribute category= (p. 943) Category to which the task group applies.
Attribute class= (p. 944) Class name of the controller of the object.
(inherited from SimEntity)
Attribute contextual= (p. 945) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute headertext= (p. 945) The text to display in the both the toolbox and
the task group header block.
Attribute icon= (p. 946) Icon for the object. (inherited from SimEntity)
Attribute isparametricgroup= (p. 947) Indicates whether the taskgroup operates only on
parameters.
Attribute name= (p. 948) Name of the object. (inherited from SimEntity)
Attribute version= (p. 949) Version of the object. (inherited from SimEntity)

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
920 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 921
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
922 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 923
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<IncludeGroup>
The task group's List of nested task groups.

Type
Ansys_ACT_Core_XmlDataModel_IncludeGroup (p. 246)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
924 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Details
ChildType
Ansys_ACT_Core_XmlDataModel_IncludeGroup

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<IncludeTask>
List of tasks for the task group.

Type
Ansys_ACT_Core_XmlDataModel_IncludeTask (p. 249)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_IncludeTask

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 925
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
926 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 927
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
928 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 929
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
930 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 931
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
932 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 933
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
934 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 935
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
936 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 937
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
938 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 939
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
940 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

abbreviation=
Task group abbreviation used for directory and naming purposes.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
abbreviation

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 941
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
caption

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
942 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

category=
Category to which the task group applies.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
category

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 943
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
Mandatory
False

Name
class

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
944 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
Mandatory
False

Name
contextual

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

headertext=
The text to display in the both the toolbox and the task group header block.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 945
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
headertext

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object. (inherited from SimEntity)

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
946 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
icon

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

isparametricgroup=
Indicates whether the taskgroup operates only on parameters.

Type
System_Boolean

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 947
ACT XML Tags

Examples
None.

Details
Mandatory
False

Name
isparametricgroup

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
948 of ANSYS, Inc. and its subsidiaries and affiliates.
 <taskgroup>

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 949
ACT XML Tags

Name
version

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<taskgroups>
Class defining the task groups collection.

Remarks
None.

Examples
None.

Table 87: XML Tag Listing

Tag <TaskGroup> (p. 950) No details

provided.

<TaskGroup>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_TaskGroup (p. 918)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
950 of ANSYS, Inc. and its subsidiaries and affiliates.
 <tasks>

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_TaskGroup

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<tasks>
Class defining the tasks collection.

Remarks
None.

Examples
None.

Table 88: XML Tag Listing

Tag <Task> (p. 951) No details

provided.

<Task>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Task (p. 874)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 951
ACT XML Tags

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Task

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Templates>
Class defining a collection of control templates.

Remarks
None.

Examples
None.

Table 89: XML Tag Listing

Tag <ControlTemplate> (p. 952) Defines a control template for the creation of groups of
properties.

<ControlTemplate>
Defines a control template for the creation of groups of properties.

Type
Ansys_ACT_Core_XmlDataModel_ControlTemplate (p. 93)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
952 of ANSYS, Inc. and its subsidiaries and affiliates.
 <toolbar>

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<toolbar>
Class defining a toolbar in the UI of the application.

Remarks
None.

Examples
None.

Table 90: XML Tag Listing

Tag <Separator> (p. 953) Separator for the

toolbar.
Attribute caption= (p. 954) Caption of the
toolbar.
Attribute name= (p. 955) Name of the
toolbar.

<Separator>
Separator for the toolbar.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 953
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Separator (p. 791)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Separator

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the toolbar.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
caption

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
954 of ANSYS, Inc. and its subsidiaries and affiliates.
 <toolbar>

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the toolbar.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
True

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 955
ACT XML Tags

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<UIDefinition>
Class defining a set of interface layouts that can be used for guided processes (wizards).

Remarks
None.

Examples
None.

Table 91: XML Tag Listing

Tag <ComponentDefinition> (p. 956) No details

provided.
Tag <Layout> (p. 957) No details
provided.

<ComponentDefinition>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_UI_ComponentDefinition (p. 81)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
956 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UIDefinition>

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Layout>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_UI_Layout (p. 297)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 957
ACT XML Tags

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<UserDefinedTask>
Class defining a new application task.

Remarks
None.

Examples
None.

Table 92: XML Tag Listing

Tag <Callbacks> (p. 958) No details provided.

Callback <onUpdate> (p. 959) No details provided.
Attribute caption= (p. 960) The caption of the task. (inherited from
BaseTaskTag)
Attribute name= (p. 961) The name of the task. (inherited from
BaseTaskTag)

<Callbacks>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
958 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserDefinedTask>

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<onUpdate>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_string_

Name
onUpdate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 959
ACT XML Tags

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

caption=
The caption of the task. (inherited from BaseTaskTag)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
caption

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
960 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserInputTask>

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
The name of the task. (inherited from BaseTaskTag)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<UserInputTask>
Class defining a new user input application task.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 961
ACT XML Tags

Remarks
None.

Examples
None.

Table 93: XML Tag Listing

Tag <DataModelInOut> (p. 962) The panel associated to the task.

Attribute caption= (p. 963) The caption of the task. (inherited from
BaseTaskTag)
Attribute name= (p. 963) The name of the task. (inherited from
BaseTaskTag)
Attribute panel= (p. 964) The panel associated to the task.

<DataModelInOut>
The panel associated to the task.

Type
Ansys_ACT_Core_XmlDataModel_Application_DataModelInOut (p. 96)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_DataModelInOut

MinOccurence
1

MaxOccurence
-1

RealParent
None.

Mandatory
True

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
962 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserInputTask>

caption=
The caption of the task. (inherited from BaseTaskTag)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
caption

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
The name of the task. (inherited from BaseTaskTag)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 963
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Name
name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

panel=
The panel associated to the task.

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
964 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Remarks
None.

Examples
None.

Details
Name
panel

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<UserObject>
Class defining a user object of the data model.

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 965
ACT XML Tags

Examples
None.

Table 94: XML Tag Listing

Tag <Attributes> (p. 967) No details provided. (inherited from SimEntity)

Tag <Callbacks> (p. 968) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 968) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 969) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 970) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Callback <IsValid> (p. 971) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 972) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 973) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 974) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 975) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 976) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 977) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 978) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 979) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 980) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 981) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 982) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 983) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 984) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 985) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 986) No details provided. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
966 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Attribute basedonxmldefinition= (p. 987) Indicates if the definition of the UserObject is

strictly defined by its xml definition.
Attribute caption= (p. 988) Caption of the object. (inherited from SimEntity)
Attribute cardinality= (p. 989) Cardinality of the user object regarding is parent.
Attribute class= (p. 990) Class name of the controller of the object.
(inherited from SimEntity)
Attribute contextual= (p. 991) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 991) Icon for the object. (inherited from SimEntity)
Attribute name= (p. 992) Name of the object. (inherited from SimEntity)
Attribute parent= (p. 993) Name of the parent user object.
Attribute version= (p. 994) Version of the object. (inherited from SimEntity)

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 967
ACT XML Tags

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
968 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 969
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
970 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 971
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
972 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 973
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
974 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 975
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
976 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 977
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
978 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 979
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
980 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 981
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
982 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 983
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
984 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 985
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
986 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

basedonxmldefinition=
Indicates if the definition of the UserObject is strictly defined by its xml definition.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
basedonxmldefinition

DefaultValue
True

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 987
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
caption

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
988 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

cardinality=
Cardinality of the user object regarding is parent.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
cardinality

DefaultValue
0+

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 989
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Details
Mandatory
False

Name
class

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
990 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
Mandatory
False

Name
contextual

DefaultValue
True

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object. (inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 991
ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
icon

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
992 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObject>

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

parent=
Name of the parent user object.

Type
System_String

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 993
ACT XML Tags

Examples
None.

Details
Mandatory
False

Name
parent

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
994 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObjectConverter>

Details
Mandatory
True

Name
version

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<UserObjectConverter>
No details provided.

Remarks
None.

Examples
None.

Table 95: XML Tag Listing

Tag <Callbacks> (p. 996) No details

provided.
Callback <OnReadInput> (p. 996) No details
provided.
Callback <OnSendBackData> (p. 997) No details
provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 995
ACT XML Tags

Callback <OnSendData> (p. 998) No details

provided.
Callback <OnWriteInput> (p. 999) No details
provided.
Attribute userObject= (p. 1000) No details
provided.

<Callbacks>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<OnReadInput>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
996 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObjectConverter>

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject__StreamReader_

Name
OnReadInput

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnSendBackData>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 997
ACT XML Tags

Examples
None.

Details
CallbackType
ActionCallback_IUserObject__IExtAPI_

Name
OnSendBackData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnSendData>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
998 of ANSYS, Inc. and its subsidiaries and affiliates.
 <UserObjectConverter>

Details
CallbackType
ActionCallback_IUserObject__IExtAPI_

Name
OnSendData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnWriteInput>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 999
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject__StreamWriter_

Name
OnWriteInput

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

userObject=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1000 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Wizard>

Details
Mandatory
True

Name
userObject

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Wizard>
Class defining a guided process (a wizard or AIM custom template) within the extension.

Remarks
None.

Examples
None.

Table 96: XML Tag Listing

Tag <Callbacks> (p. 1002) Specifies the callbacks that will invoke functions from the
IronPython extension script. (inherited from BaseApplication)
Callback <canstart> (p. 1003) Callback that is invoked to determine whether the application
can be started. (inherited from BaseApplication)
Tag <Description> (p. 1004) Description of the application. (inherited from BaseApplication)
Tag <Step> (p. 1004) No details provided.
Attribute allowNavigation= (p. 1005) No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1001
ACT XML Tags

Attribute caption= (p. 1006) Caption of the application. (inherited from BaseApplication)
Attribute context= (p. 1007) Context or combination of contexts (separated using '|').
(inherited from BaseApplication)
Attribute hidden= (p. 1007) No details provided.
Attribute icon= (p. 1008) Icon for the application. (inherited from BaseApplication)
Attribute layout= (p. 1009) Layout to be used to display the wizard.
Attribute name= (p. 1010) Name of the application. (inherited from BaseApplication)
Attribute persistent= (p. 1011) No details provided.
Attribute subContext= (p. 1012) Sub-context used by AIM to filter the availability of the wizard.
Attribute version= (p. 1013) Major version of the application. (inherited from BaseApplication)

<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (inherited from
BaseApplication)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1002 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Wizard>

<canstart>
Callback that is invoked to determine whether the application can be started. (inherited from BaseApplic-
ation)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_string__bool_

Name
canstart

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1003
ACT XML Tags

<Description>
Description of the application. (inherited from BaseApplication)

Type
System_String

Remarks
None.

Examples
None.

Details
Description
Description of the wizard.

ValueName
description

Name
Description

Public
True

TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

<Step>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Step (p. 834)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Step

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1004 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Wizard>

MinOccurence
1

MaxOccurence
-1

RealParent
None.

Mandatory
True

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

allowNavigation=
No details provided.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
allowNavigation

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1005
ACT XML Tags

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

caption=
Caption of the application. (inherited from BaseApplication)

Type
System_String

Remarks
None.

Examples
None.

Details
Name
caption

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1006 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Wizard>

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

context=
Context or combination of contexts (separated using '|'). (inherited from BaseApplication)

Type
System_String_ARRAY_

Remarks
This block will be taken into account only for the specified context(s).

Examples
None.

Details
Name
context

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
True

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

hidden=
No details provided.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1007
ACT XML Tags

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
hidden

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
False

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the application. (inherited from BaseApplication)

Type
System_String

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1008 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Wizard>

Remarks
None.

Examples
None.

Details
Name
icon

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

layout=
Layout to be used to display the wizard.

Type
System_String

Remarks
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1009
ACT XML Tags

Examples
None.

Details
Name
layout

Mandatory
False

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the application. (inherited from BaseApplication)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1010 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Wizard>

Details
Name
name

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

persistent=
No details provided.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Name
persistent

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1011
ACT XML Tags

Mandatory
False

DefaultValue
False

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

subContext=
Sub-context used by AIM to filter the availability of the wizard.

Type
System_String

Remarks
None.

Examples
None.

Details
Name
subContext

Mandatory
False

DefaultValue
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1012 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Wizard>

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Major version of the application. (inherited from BaseApplication)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Name
version

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1013
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Workflow>
Class defining the top-level workflow tag within an ACT app.

Remarks
Used to define process integration items (tasks and task groups)

Examples
None.

Table 97: XML Tag Listing

Tag <Attributes> (p. 1016) No details provided. (inherited from SimEntity)

Tag <Callbacks> (p. 1017) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 1018) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 1019) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 1019) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Callback <IsValid> (p. 1020) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 1021) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <onafterdesignpointchanged> (p. 1022) Callback that is invoked after the design point has
changed.
Callback <OnAfterGeometryUpdate> (p. 1023) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <onaftertaskcanduplicate> (p. 1024) Callback that is invoked after a task determines
duplication viability.
Callback <onaftertaskcanusetransfer> (p. 1025) Callback that is invoked after a task determines
transfer data viability.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1014 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Callback <onaftertaskcreation> (p. 1026) Callback that is invoked after a task has been
created.
Callback <onaftertaskdeletion> (p. 1027) Callback that is invoked after a task is deleted.
Callback <onaftertaskduplicate> (p. 1028) Callback that is invoked after a task has been
duplicated.
Callback <onaftertaskpropertyretrieval> (p. 1029) CCallback that is invoked after a task provides its
property-containing objects.
Callback <onaftertaskrefresh> (p. 1030) Callback that is invoked after a task has been
refreshed.
Callback <onaftertaskreset> (p. 1031) Callback that is invoked after a task has been reset.
Callback <onaftertasksourceschanged> (p. 1032) Callback that is invoked after a task handles a
source change.
Callback <onaftertaskstatus> (p. 1033) Callback that is invoked after a task determines
its status.
Callback <onaftertaskupdate> (p. 1034) Callback that is invoked after a task has been
updated.
Callback <onbeforedesignpointchanged> (p. 1035)Callback that is invoked immediately before the
design point changes.
Callback <onbeforetaskcanduplicate> (p. 1036) Callback that is invoked before a task determines
duplication viability.
Callback <onbeforetaskcanusetransfer> (p. 1037) Callback that is invoked before a task determines
transfer data viability.
Callback <onbeforetaskcreation> (p. 1038) Callback that is invoked before a task is created.
Callback <onbeforetaskdeletion> (p. 1039) Callback that is invoked before a task is deleted.
Callback <onbeforetaskduplicate> (p. 1040) Callback that is invoked before a task is duplicated.
Callback <onbeforetaskpropertyretrieval> (p. 1041)Callback that is invoked before a task provides its
property-containing objects.
Callback <onbeforetaskrefresh> (p. 1042) Callback that is invoked before a task is refreshed.
Callback <onbeforetaskreset> (p. 1043) Callback that is invoked before a task is reset.
Callback <onbeforetasksourceschanged> (p. 1044)Callback that is invoked before a task handles a
source change.
Callback <onbeforetaskstatus> (p. 1045) Callback that is invoked before a task determines
its status.
Callback <onbeforetaskupdate> (p. 1046) Callback that is invoked before a task is updated.
Callback <OnBodySuppressStateChange> (p. 1047)Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 1048) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 1049) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 1050) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 1051) Callback that is invoked when the object is hidden.
(inherited from SimEntity)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1015
ACT XML Tags

Callback <OnInit> (p. 1052) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 1053) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 1054) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 1055) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 1056) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 1057) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 1058) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 1059) No details provided. (inherited from SimEntity)
Tag <TaskGroups> (p. 1060) Task groupings to be exposed as organized blocks
within the workflow.
Tag <Tasks> (p. 1061) Tasks xposed by this workflow.
Attribute caption= (p. 1061) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 1062) Class name of the controller of the object.
(inherited from SimEntity)
Attribute context= (p. 1063) Contexts (application) to which this workflow
applies.
Attribute contextual= (p. 1064) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 1065) Icon for the object. (inherited from SimEntity)
Attribute name= (p. 1066) Name of the object. (inherited from SimEntity)
Attribute version= (p. 1067) Version of the object. (inherited from SimEntity)

<Attributes>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1016 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Callbacks>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 57)

Remarks
None.

Examples
None.

Details
ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1017
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Name
CanAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1018 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate

Name
CanDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1019
ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove

Name
CanRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1020 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation

Name
IsValid

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is not invoked when the project is reopened.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1021
ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnAdd

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onafterdesignpointchanged>
Callback that is invoked after the design point has changed.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1022 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
onafterdesignpointchanged

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1023
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
OnAfterGeometryUpdate

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onaftertaskcanduplicate>
Callback that is invoked after a task determines duplication viability.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1024 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
FuncCallback_object__object_

Name
onaftertaskcanduplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onaftertaskcanusetransfer>
Callback that is invoked after a task determines transfer data viability.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1025
ACT XML Tags

Details
CallbackType
FuncCallback_IUserObject__IUserObject__object__object_

Name
onaftertaskcanusetransfer

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onaftertaskcreation>
Callback that is invoked after a task has been created.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1026 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
ActionCallback_IUserObject_

Name
onaftertaskcreation

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onaftertaskdeletion>
Callback that is invoked after a task is deleted.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1027
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
onaftertaskdeletion

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onaftertaskduplicate>
Callback that is invoked after a task has been duplicated.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1028 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
ActionCallback_IUserObject_

Name
onaftertaskduplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onaftertaskpropertyretrieval>
CCallback that is invoked after a task provides its property-containing objects.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1029
ACT XML Tags

Details
CallbackType
FuncCallback_IUserObject__object__object_

Name
onaftertaskpropertyretrieval

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onaftertaskrefresh>
Callback that is invoked after a task has been refreshed.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1030 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
ActionCallback_IUserObject_

Name
onaftertaskrefresh

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onaftertaskreset>
Callback that is invoked after a task has been reset.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1031
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
onaftertaskreset

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onaftertasksourceschanged>
Callback that is invoked after a task handles a source change.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1032 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
ActionCallback_IUserObject_

Name
onaftertasksourceschanged

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onaftertaskstatus>
Callback that is invoked after a task determines its status.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1033
ACT XML Tags

Details
CallbackType
FuncCallback_IUserObject__object__object_

Name
onaftertaskstatus

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onaftertaskupdate>
Callback that is invoked after a task has been updated.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1034 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
ActionCallback_IUserObject_

Name
onaftertaskupdate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onbeforedesignpointchanged>
Callback that is invoked immediately before the design point changes.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1035
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
onbeforedesignpointchanged

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onbeforetaskcanduplicate>
Callback that is invoked before a task determines duplication viability.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1036 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback

Name
onbeforetaskcanduplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onbeforetaskcanusetransfer>
Callback that is invoked before a task determines transfer data viability.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1037
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject__IUserObject_

Name
onbeforetaskcanusetransfer

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onbeforetaskcreation>
Callback that is invoked before a task is created.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1038 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
ActionCallback_IUserObject_

Name
onbeforetaskcreation

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onbeforetaskdeletion>
Callback that is invoked before a task is deleted.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1039
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
onbeforetaskdeletion

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onbeforetaskduplicate>
Callback that is invoked before a task is duplicated.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1040 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
ActionCallback_IUserObject_

Name
onbeforetaskduplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onbeforetaskpropertyretrieval>
Callback that is invoked before a task provides its property-containing objects.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1041
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
onbeforetaskpropertyretrieval

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onbeforetaskrefresh>
Callback that is invoked before a task is refreshed.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1042 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
ActionCallback_IUserObject_

Name
onbeforetaskrefresh

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onbeforetaskreset>
Callback that is invoked before a task is reset.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1043
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
onbeforetaskreset

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onbeforetasksourceschanged>
Callback that is invoked before a task handles a source change.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1044 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
ActionCallback_IUserObject_

Name
onbeforetasksourceschanged

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onbeforetaskstatus>
Callback that is invoked before a task determines its status.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1045
ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_

Name
onbeforetaskstatus

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onbeforetaskupdate>
Callback that is invoked before a task is updated.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 454)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1046 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
ActionCallback_IUserObject_

Name
onbeforetaskupdate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1047
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange

Name
OnBodySuppressStateChange

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1048 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnClearData

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1049
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnDuplicate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1050 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged

Name
OnGenerateData

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1051
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnHide

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
This callback is called after the OnAdd callback and when the project is reopened.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1052 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity

Name
OnInit

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
It enables the migration of data from the old saved object to the new one.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1053
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate

Name
OnMigrate

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from Si-
mEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1054 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady

Name
OnReady

Public
False

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1055
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove

Name
OnRemove

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1056 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide

Name
OnShow

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1057
ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnSuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 47)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1058 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged

Name
OnUnsuppress

Public
True

Obsolete
False

ObsoleteMessage
None.

ChildType
None.

MinOccurence
0

MaxOccurence
-1

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Property>
No details provided. (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 538)

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1059
ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<TaskGroups>
Task groupings to be exposed as organized blocks within the workflow.

Type
Ansys_ACT_Core_XmlDataModel_TaskGroups (p. 950)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_TaskGroups

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1060 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Tasks>
Tasks xposed by this workflow.

Type
Ansys_ACT_Core_XmlDataModel_Tasks (p. 951)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Tasks

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1061
ACT XML Tags

Details
Mandatory
False

Name
caption

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:

• The ExtAPI variable (of type IMechanicalExtAPI)

• The associated load (of type IUserLoad)

Examples
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1062 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Details
Mandatory
False

Name
class

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

context=
Contexts (application) to which this workflow applies.

Type
System_String_ARRAY_

Remarks
None.

Examples
None.

Details
Name
context

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1063
ACT XML Tags

Mandatory
True

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
True

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Remarks
By default, the contextual flag is true for "load" and "result" and false for "object".

Examples
None.

Details
Mandatory
False

Name
contextual

DefaultValue
True

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1064 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Name
icon

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1065
ACT XML Tags

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the object. (inherited from SimEntity)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
name

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1066 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

Public
True

Description
None.

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Version of the object. (inherited from SimEntity)

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
True

Name
version

DefaultValue
None.

DataDefinition
False

AllowedValues
None.

MultipleValue
False

MappedValues
None.

Public
True

Description
None.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1067
ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Workflow>
Class defining a new application workflow.

Remarks
The name of the application will be a new context available for customization.

Examples
None.

Table 98: XML Tag Listing

Tag <ApplicationTaskLink> (p. 1068) Links connecting task in the

workflow.
Tag <UserDefinedTask> (p. 1069) Tasks used by the workflow.

<ApplicationTaskLink>
Links connecting task in the workflow.

Type
Ansys_ACT_Core_XmlDataModel_Application_ApplicationTaskLink (p. 305)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_ApplicationTaskLink

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1068 of ANSYS, Inc. and its subsidiaries and affiliates.
 <Workflow>

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<UserDefinedTask>
Tasks used by the workflow.

Type
Ansys_ACT_Core_XmlDataModel_Application_UserDefinedTask (p. 958)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_UserDefinedTask

MinOccurence
0

MaxOccurence
-1

RealParent
None.

Mandatory
False

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1069
 Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1070 of ANSYS, Inc. and its subsidiaries and affiliates.