ANSYS ACT XML Reference Guide

ANSYS, Inc.
Southpointe
2600 ANSYS Drive
Canonsburg, PA 15317
[email protected]
http://www.ansys.com
(T) 724-746-3304
(F) 724-514-9494

Release 17.1
April 2016
ANSYS Customization
ANSYS, Inc. is
certified to ISO
9001:2008.

Copyright and Trademark Information

2016 SAS IP, Inc. All rights reserved. Unauthorized use, distribution or duplication is prohibited.
ANSYS, ANSYS Workbench, Ansoft, AUTODYN, EKM, Engineering Knowledge Manager, CFX, FLUENT, HFSS, AIM
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 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.

Disclaimer Notice
THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFIDENTIAL 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. is certified to ISO 9001:2008.

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
<ActionCallback> ............................................................................................................................. 5
caption= .................................................................................................................................... 5
icon= ......................................................................................................................................... 6
name= ....................................................................................................................................... 7
<Application> .................................................................................................................................. 8
<Callbacks> ............................................................................................................................... 9
<description> ............................................................................................................................ 9
<OnApplicationFinished> ......................................................................................................... 10
<OnApplicationInitialized> ....................................................................................................... 11
<OnApplicationStarted> .......................................................................................................... 12
<Panel> ................................................................................................................................... 13
class= ....................................................................................................................................... 13
context= .................................................................................................................................. 14
MainPanel= .............................................................................................................................. 15
name= ..................................................................................................................................... 16
<argument> ................................................................................................................................... 17
name= ..................................................................................................................................... 18
separator= ................................................................................................................................ 18
value= ...................................................................................................................................... 19
<assembly> .................................................................................................................................... 20
context= .................................................................................................................................. 21
namespace= ............................................................................................................................. 22
src= .......................................................................................................................................... 23
<attributes> ................................................................................................................................... 23
<Callback> ..................................................................................................................................... 24
<CallbackGetCommands> .............................................................................................................. 24
location= .................................................................................................................................. 24
order= ...................................................................................................................................... 25
<CallbackGetPostPreSolveCommands> .......................................................................................... 26
order= ...................................................................................................................................... 26
timedependent= ...................................................................................................................... 27
<CallbackOnActiveObjectChange> ................................................................................................. 28
name= ..................................................................................................................................... 29
type= ....................................................................................................................................... 30
<Callbacks> .................................................................................................................................... 31
<Action> .................................................................................................................................. 31
<Component> ............................................................................................................................... 32
<Attributes> ............................................................................................................................. 32
BottomAttachment= ................................................................................................................ 33
BottomOffset= ......................................................................................................................... 34
ComponentType= .................................................................................................................... 35
CustomCSSFile= ....................................................................................................................... 36
CustomHTMLFile= .................................................................................................................... 37
CustomJSFile= .......................................................................................................................... 38
Height= .................................................................................................................................... 38
HeightType= ............................................................................................................................ 39
LeftAttachment= ...................................................................................................................... 40
LeftOffset= ............................................................................................................................... 41
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

iii

ACT XML Reference Guide

MaxHeight= ............................................................................................................................. 42
MaxWidth= .............................................................................................................................. 43
name= ..................................................................................................................................... 44
RightAttachment= .................................................................................................................... 45
RightOffset= ............................................................................................................................. 46
TopAttachment= ...................................................................................................................... 47
TopOffset= ............................................................................................................................... 47
visible= .................................................................................................................................... 48
Width= ..................................................................................................................................... 49
WidthType= ............................................................................................................................. 50
<ComponentData> ........................................................................................................................ 51
component= ............................................................................................................................ 51
<ComponentDefinition> ................................................................................................................ 52
Class= ...................................................................................................................................... 53
CSSFile= ................................................................................................................................... 54
DataModelClass= ..................................................................................................................... 55
Directory= ................................................................................................................................ 56
HTMLFile= ................................................................................................................................ 56
JSFile= ...................................................................................................................................... 57
Name= ..................................................................................................................................... 58
<ComponentStyle> ........................................................................................................................ 59
component= ............................................................................................................................ 60
filter= ....................................................................................................................................... 60
<contextmenus> ............................................................................................................................ 61
<UIEntry> ................................................................................................................................. 62
<ControlTemplate> ........................................................................................................................ 62
<PropertyTable> ...................................................................................................................... 63
name= ..................................................................................................................................... 63
version= ................................................................................................................................... 64
<entity> ......................................................................................................................................... 65
<Attributes> ............................................................................................................................. 67
<Callbacks> .............................................................................................................................. 67
<CanAdd> ................................................................................................................................ 68
<CanDuplicate> ....................................................................................................................... 69
<CanRemove> ......................................................................................................................... 70
<IsValid> .................................................................................................................................. 71
<OnAdd> ................................................................................................................................. 72
<OnAfterGeometryUpdate> ..................................................................................................... 73
<OnBodySuppressStateChange> .............................................................................................. 74
<OnClearData> ........................................................................................................................ 75
<OnDuplicate> ......................................................................................................................... 76
<OnGenerateData> .................................................................................................................. 77
<OnHide> ................................................................................................................................ 78
<OnInit> .................................................................................................................................. 79
<OnMigrate> ........................................................................................................................... 79
<OnReady> .............................................................................................................................. 80
<OnRemove> ........................................................................................................................... 81
<OnShow> ............................................................................................................................... 82
<OnSuppress> ......................................................................................................................... 83
<OnUnsuppress> ..................................................................................................................... 84
<Property> ............................................................................................................................... 85
caption= .................................................................................................................................. 86

iv

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Reference Guide

class= ....................................................................................................................................... 87
contextual= .............................................................................................................................. 88
datatype= ................................................................................................................................ 89
icon= ....................................................................................................................................... 89
name= ..................................................................................................................................... 90
version= ................................................................................................................................... 91
<entry> .......................................................................................................................................... 92
<Callbacks> .............................................................................................................................. 93
<onclick> ................................................................................................................................. 93
caption= .................................................................................................................................. 94
icon= ....................................................................................................................................... 95
name= ..................................................................................................................................... 96
priority= ................................................................................................................................... 97
type= ....................................................................................................................................... 98
version= ................................................................................................................................... 99
<entry> ........................................................................................................................................ 100
<Callbacks> ............................................................................................................................ 100
<OnClick> .............................................................................................................................. 101
<Separator> ........................................................................................................................... 102
caption= ................................................................................................................................ 103
Icon= ...................................................................................................................................... 103
name= ................................................................................................................................... 104
userobject= ............................................................................................................................ 105
<Extension> ................................................................................................................................. 106
<Application> ........................................................................................................................ 107
<appStoreId> ......................................................................................................................... 108
<assembly> ............................................................................................................................ 108
<author> ................................................................................................................................ 109
<description> ......................................................................................................................... 110
<Guid> ................................................................................................................................... 110
<Interface> ............................................................................................................................ 111
<Licenses> ............................................................................................................................. 112
<script> ................................................................................................................................. 112
<simdata> .............................................................................................................................. 113
<Templates> .......................................................................................................................... 114
<UIDefinition> ....................................................................................................................... 114
<Wizard> ............................................................................................................................... 115
<Workflow> ........................................................................................................................... 116
debug= .................................................................................................................................. 116
icon= ...................................................................................................................................... 117
loadAsDefault= ....................................................................................................................... 118
masked= ................................................................................................................................ 119
minorversion= ........................................................................................................................ 120
name= ................................................................................................................................... 121
version= ................................................................................................................................. 122
<ExtensionObject> ....................................................................................................................... 122
<Attributes> ........................................................................................................................... 124
<Callbacks> ............................................................................................................................ 125
<CanAdd> .............................................................................................................................. 125
<CanDuplicate> ..................................................................................................................... 126
<CanRemove> ........................................................................................................................ 127
<HostObjectModified> ........................................................................................................... 128
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Reference Guide

<IsValid> ................................................................................................................................ 129
<OnAdd> ............................................................................................................................... 130
<OnAfterGeometryUpdate> ................................................................................................... 131
<OnBodySuppressStateChange> ............................................................................................ 132
<OnClearData> ...................................................................................................................... 133
<OnDuplicate> ....................................................................................................................... 134
<OnGenerateData> ................................................................................................................ 135
<OnHide> .............................................................................................................................. 136
<OnInit> ................................................................................................................................ 137
<OnMigrate> .......................................................................................................................... 138
<OnReady> ............................................................................................................................ 139
<OnRemove> ......................................................................................................................... 140
<OnShow> ............................................................................................................................. 141
<OnSuppress> ....................................................................................................................... 142
<OnUnsuppress> ................................................................................................................... 143
<Property> ............................................................................................................................. 144
<Target> ................................................................................................................................ 145
caption= ................................................................................................................................ 146
class= ..................................................................................................................................... 146
contextual= ............................................................................................................................ 147
icon= ...................................................................................................................................... 148
name= ................................................................................................................................... 149
version= ................................................................................................................................. 150
<filter> ......................................................................................................................................... 151
name= ................................................................................................................................... 151
src= ........................................................................................................................................ 152
<Geometry> ................................................................................................................................. 153
<Attributes> ........................................................................................................................... 155
<Callbacks> ............................................................................................................................ 155
<CanAdd> .............................................................................................................................. 156
<CanDuplicate> ..................................................................................................................... 157
<CanRemove> ........................................................................................................................ 158
<IsValid> ................................................................................................................................ 159
<OnAdd> ............................................................................................................................... 160
<OnAfterGenerate> ................................................................................................................ 161
<OnAfterGeometryUpdate> ................................................................................................... 162
<OnBodySuppressStateChange> ............................................................................................ 163
<OnClearData> ...................................................................................................................... 164
<OnDuplicate> ....................................................................................................................... 165
<OnEdit> ............................................................................................................................... 165
<OnGenerate> ....................................................................................................................... 166
<OnGenerateData> ................................................................................................................ 167
<OnHide> .............................................................................................................................. 168
<OnInit> ................................................................................................................................ 169
<OnMigrate> .......................................................................................................................... 170
<OnReady> ............................................................................................................................ 171
<OnRemove> ......................................................................................................................... 172
<OnShow> ............................................................................................................................. 173
<OnSuppress> ....................................................................................................................... 174
<OnUnsuppress> ................................................................................................................... 175
<Property> ............................................................................................................................. 176
caption= ................................................................................................................................ 177

vi

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Reference Guide

class= ..................................................................................................................................... 178
contextual= ............................................................................................................................ 179
icon= ...................................................................................................................................... 180
name= ................................................................................................................................... 180
version= ................................................................................................................................. 181
<guid> ......................................................................................................................................... 182
shortid= ................................................................................................................................. 183
<includegroup> ........................................................................................................................... 184
caption= ................................................................................................................................ 184
external= ................................................................................................................................ 185
name= ................................................................................................................................... 186
<includetask> .............................................................................................................................. 187
caption= ................................................................................................................................ 187
external= ................................................................................................................................ 188
name= ................................................................................................................................... 189
<input> ........................................................................................................................................ 190
count= ................................................................................................................................... 190
format= .................................................................................................................................. 191
type= ..................................................................................................................................... 192
<inputfile> ................................................................................................................................... 193
id= ......................................................................................................................................... 193
name= ................................................................................................................................... 194
<inputs> ...................................................................................................................................... 195
<Input> .................................................................................................................................. 195
<Interface> .................................................................................................................................. 196
<Callbacks> ............................................................................................................................ 197
<filter> ................................................................................................................................... 198
<GetPostCommands> ............................................................................................................ 198
<GetPreCommands> .............................................................................................................. 199
<GetSolveCommands> ........................................................................................................... 200
<images> ............................................................................................................................... 201
<IsAnalysisValid> .................................................................................................................... 202
<OnActiveObjectChange> ...................................................................................................... 203
<OnAfterGeometryUpdate> ................................................................................................... 204
<OnAfterRemove> ................................................................................................................. 205
<OnAfterSolve> ...................................................................................................................... 206
<OnBeforeGeometryUpdate> ................................................................................................. 207
<OnBeforeSolve> ................................................................................................................... 208
<OnBodySuppressStateChange> ............................................................................................ 208
<OnDraw> ............................................................................................................................. 209
<OnDraw2D> ......................................................................................................................... 210
<OnInit> ................................................................................................................................ 211
<OnLoad> .............................................................................................................................. 212
<OnMeshCleaned> ................................................................................................................. 213
<OnMeshGenerated> ............................................................................................................. 214
<OnPostFinished> .................................................................................................................. 215
<OnPostStarted> .................................................................................................................... 216
<OnReady> ............................................................................................................................ 217
<OnSave> .............................................................................................................................. 218
<OnTerminate> ...................................................................................................................... 219
<Resume> .............................................................................................................................. 220
<Save> ................................................................................................................................... 221
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

vii

ACT XML Reference Guide

<toolbar> ............................................................................................................................... 222
context= ................................................................................................................................ 223
<Layout> ...................................................................................................................................... 224
<Component> ........................................................................................................................ 224
name= ................................................................................................................................... 225
<License> ..................................................................................................................................... 226
name= ................................................................................................................................... 226
<Licenses> ................................................................................................................................... 227
<License> ............................................................................................................................... 227
<Load> ........................................................................................................................................ 228
<Action> ................................................................................................................................ 230
<Attributes> ........................................................................................................................... 231
<Callbacks> ............................................................................................................................ 231
<CanAdd> .............................................................................................................................. 232
<CanDuplicate> ..................................................................................................................... 233
<CanRemove> ........................................................................................................................ 234
<GetCommands> ................................................................................................................... 235
<GetNodalValuesForDisplay> ................................................................................................. 236
<GetPostCommands> ............................................................................................................ 237
<GetPreCommands> .............................................................................................................. 238
<GetSolveCommands> ........................................................................................................... 239
<IsValid> ................................................................................................................................ 240
<OnAdd> ............................................................................................................................... 241
<OnAfterGenerate> ................................................................................................................ 242
<OnAfterGeometryUpdate> ................................................................................................... 243
<OnBodySuppressStateChange> ............................................................................................ 243
<OnClearData> ...................................................................................................................... 244
<OnDuplicate> ....................................................................................................................... 245
<OnGenerate> ....................................................................................................................... 246
<OnGenerateData> ................................................................................................................ 247
<OnHide> .............................................................................................................................. 248
<OnInit> ................................................................................................................................ 249
<OnMigrate> .......................................................................................................................... 250
<OnReady> ............................................................................................................................ 251
<OnRemove> ......................................................................................................................... 252
<OnShow> ............................................................................................................................. 253
<OnSuppress> ....................................................................................................................... 254
<OnUnsuppress> ................................................................................................................... 255
<Property> ............................................................................................................................. 256
caption= ................................................................................................................................ 257
class= ..................................................................................................................................... 258
color= .................................................................................................................................... 259
contextual= ............................................................................................................................ 260
icon= ...................................................................................................................................... 261
IsLoad= .................................................................................................................................. 261
IsSupport= ............................................................................................................................. 262
name= ................................................................................................................................... 263
unit= ...................................................................................................................................... 264
version= ................................................................................................................................. 265
<Object> ...................................................................................................................................... 266
<Action> ................................................................................................................................ 268
<Attributes> ........................................................................................................................... 269

viii

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Reference Guide

<Callbacks> ............................................................................................................................ 269
<CanAdd> .............................................................................................................................. 270
<CanDuplicate> ..................................................................................................................... 271
<CanRemove> ........................................................................................................................ 272
<GetCommands> ................................................................................................................... 273
<GetNodalValuesForDisplay> ................................................................................................. 274
<GetPostCommands> ............................................................................................................ 275
<GetPreCommands> .............................................................................................................. 276
<GetSolveCommands> ........................................................................................................... 277
<IsValid> ................................................................................................................................ 278
<OnAdd> ............................................................................................................................... 279
<OnAfterGenerate> ................................................................................................................ 280
<OnAfterGeometryUpdate> ................................................................................................... 281
<OnBodySuppressStateChange> ............................................................................................ 281
<OnClearData> ...................................................................................................................... 282
<OnDuplicate> ....................................................................................................................... 283
<OnGenerate> ....................................................................................................................... 284
<OnGenerateData> ................................................................................................................ 285
<OnHide> .............................................................................................................................. 286
<OnInit> ................................................................................................................................ 287
<OnMigrate> .......................................................................................................................... 288
<OnReady> ............................................................................................................................ 289
<OnRemove> ......................................................................................................................... 290
<OnShow> ............................................................................................................................. 291
<OnSuppress> ....................................................................................................................... 292
<OnUnsuppress> ................................................................................................................... 293
<Property> ............................................................................................................................. 294
<Target> ................................................................................................................................ 295
caption= ................................................................................................................................ 296
class= ..................................................................................................................................... 296
color= .................................................................................................................................... 297
contextual= ............................................................................................................................ 298
icon= ...................................................................................................................................... 299
IsLoad= .................................................................................................................................. 300
IsSupport= ............................................................................................................................. 301
name= ................................................................................................................................... 302
unit= ...................................................................................................................................... 303
version= ................................................................................................................................. 304
<Optimizer> ................................................................................................................................. 305
<Attributes> ........................................................................................................................... 309
<Callbacks> ............................................................................................................................ 309
<CanAdd> .............................................................................................................................. 310
<CanDuplicate> ..................................................................................................................... 311
<CanRemove> ........................................................................................................................ 312
<CanRun> .............................................................................................................................. 313
<Configuration> ..................................................................................................................... 314
<ConvergenceDescription> .................................................................................................... 315
<Description> ........................................................................................................................ 316
<InputParametersEdited> ....................................................................................................... 317
<IsValid> ................................................................................................................................ 318
<MethodPropertiesEdited> .................................................................................................... 319
<ObjectivesOrConstraintsEdited> ........................................................................................... 320
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ix

ACT XML Reference Guide

<OnAdd> ............................................................................................................................... 320
<OnAfterGeometryUpdate> ................................................................................................... 321
<OnBodySuppressStateChange> ............................................................................................ 322
<OnClearData> ...................................................................................................................... 323
<OnCreate> ........................................................................................................................... 324
<OnDuplicate> ....................................................................................................................... 325
<OnGenerateData> ................................................................................................................ 326
<OnHide> .............................................................................................................................. 327
<OnInit> ................................................................................................................................ 328
<OnMigrate> .......................................................................................................................... 329
<OnReady> ............................................................................................................................ 330
<OnRelease> .......................................................................................................................... 331
<OnRemove> ......................................................................................................................... 332
<OnShow> ............................................................................................................................. 333
<OnSuppress> ....................................................................................................................... 334
<OnUnsuppress> ................................................................................................................... 335
<ParameterRelationshipsEdited> ............................................................................................ 336
<Property> ............................................................................................................................. 337
<QuickHelp> .......................................................................................................................... 338
<Status> ................................................................................................................................ 339
basedondirectoptimizationonly= ............................................................................................ 340
basedonresponsesurfaceonly= ............................................................................................... 341
caption= ................................................................................................................................ 342
class= ..................................................................................................................................... 342
constrainthandling= ............................................................................................................... 343
constraintimportance= ........................................................................................................... 344
constraintoninputparameter= ................................................................................................. 345
contextual= ............................................................................................................................ 346
convergencedata= .................................................................................................................. 347
equaltoconstraint= ................................................................................................................. 348
greaterthanconstraint= ........................................................................................................... 349
historychartxaxistype= ........................................................................................................... 350
icon= ...................................................................................................................................... 351
insideboundsconstraint= ........................................................................................................ 351
lessthanconstraint= ................................................................................................................ 352
logfile= ................................................................................................................................... 353
maximizeobjective= ............................................................................................................... 354
maximumnumberofconstraints= ............................................................................................. 355
maximumnumberofdoublelistparameters= ............................................................................. 356
maximumnumberofdoubleparameters= ................................................................................. 357
maximumnumberofinputparameters= .................................................................................... 358
maximumnumberofintegerlistparameters= ............................................................................. 359
maximumnumberofobjectives= .............................................................................................. 360
minimizeobjective= ................................................................................................................ 360
minimumnumberofconstraints= ............................................................................................. 361
minimumnumberofobjectives= .............................................................................................. 362
name= ................................................................................................................................... 363
objectiveimportance= ............................................................................................................ 364
objectiveoninputparameter= .................................................................................................. 365
parameterrelationship= .......................................................................................................... 366
seekobjective= ....................................................................................................................... 367
startingpointrequired= ........................................................................................................... 368

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Reference Guide

version= ................................................................................................................................. 369
<OrderableCallback> .................................................................................................................... 370
order= .................................................................................................................................... 370
<output> ..................................................................................................................................... 371
format= .................................................................................................................................. 371
type= ..................................................................................................................................... 372
<outputfile> ................................................................................................................................. 373
id= ......................................................................................................................................... 373
name= ................................................................................................................................... 374
<outputs> .................................................................................................................................... 375
<Output> ............................................................................................................................... 375
<Panel> ........................................................................................................................................ 376
<Callbacks> ............................................................................................................................ 377
<OnPanelHidden> .................................................................................................................. 377
<OnPanelInitialized> .............................................................................................................. 378
<OnPanelShown> .................................................................................................................. 379
class= ..................................................................................................................................... 380
layout= ................................................................................................................................... 381
name= ................................................................................................................................... 382
<parameter> ................................................................................................................................ 383
<Attributes> ........................................................................................................................... 384
<Callbacks> ............................................................................................................................ 385
<CanAdd> .............................................................................................................................. 386
<CanDuplicate> ..................................................................................................................... 387
<CanRemove> ........................................................................................................................ 388
<IsValid> ................................................................................................................................ 388
<OnAdd> ............................................................................................................................... 389
<OnAfterGeometryUpdate> ................................................................................................... 390
<OnBodySuppressStateChange> ............................................................................................ 391
<OnClearData> ...................................................................................................................... 392
<OnDuplicate> ....................................................................................................................... 393
<OnGenerateData> ................................................................................................................ 394
<OnHide> .............................................................................................................................. 395
<OnInit> ................................................................................................................................ 396
<OnMigrate> .......................................................................................................................... 397
<OnReady> ............................................................................................................................ 398
<OnRemove> ......................................................................................................................... 399
<OnShow> ............................................................................................................................. 400
<OnSuppress> ....................................................................................................................... 401
<OnUnsuppress> ................................................................................................................... 402
<Property> ............................................................................................................................. 403
caption= ................................................................................................................................ 404
class= ..................................................................................................................................... 405
contextual= ............................................................................................................................ 406
control= ................................................................................................................................. 407
icon= ...................................................................................................................................... 407
name= ................................................................................................................................... 408
usage= ................................................................................................................................... 409
version= ................................................................................................................................. 410
<parameters> ............................................................................................................................... 411
<Parameter> .......................................................................................................................... 411
<platform> ................................................................................................................................... 412
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xi

ACT XML Reference Guide

name= ................................................................................................................................... 413
path= ..................................................................................................................................... 413
<program> ................................................................................................................................... 414
<Argument> .......................................................................................................................... 415
<Platform> ............................................................................................................................. 415
<projectdata> .............................................................................................................................. 416
<DataEntity> .......................................................................................................................... 416
<property> .................................................................................................................................. 417
<Attributes> ........................................................................................................................... 419
<Callbacks> ............................................................................................................................ 420
<GetValue> ............................................................................................................................ 421
<help> ................................................................................................................................... 422
<IsValid> ................................................................................................................................ 422
<IsVisible> .............................................................................................................................. 423
<OnActivate> ......................................................................................................................... 424
<OnAdd> ............................................................................................................................... 425
<OnAfterGeometryUpdate> ................................................................................................... 426
<OnApply> ............................................................................................................................ 427
<OnBodySuppressStateChange> ............................................................................................ 428
<OnCancel> ........................................................................................................................... 429
<OnDuplicate> ....................................................................................................................... 430
<OnHide> .............................................................................................................................. 431
<OnInit> ................................................................................................................................ 432
<OnJournalExecuting> ........................................................................................................... 433
<OnJournalRecording> .......................................................................................................... 433
<OnMigrate> .......................................................................................................................... 434
<OnRemove> ......................................................................................................................... 435
<OnShow> ............................................................................................................................. 436
<OnValidate> ......................................................................................................................... 437
<SetValue> ............................................................................................................................. 438
<String2Value> ...................................................................................................................... 439
<Value2String> ...................................................................................................................... 440
caption= ................................................................................................................................ 441
class= ..................................................................................................................................... 442
control= ................................................................................................................................. 443
default= ................................................................................................................................. 444
elementtype= ......................................................................................................................... 445
isparameter= .......................................................................................................................... 446
keytype= ................................................................................................................................ 447
name= ................................................................................................................................... 447
needupdate= ......................................................................................................................... 448
parameterizable= ................................................................................................................... 449
persistent= ............................................................................................................................. 450
readonly= ............................................................................................................................... 451
unit= ...................................................................................................................................... 452
valuetype= ............................................................................................................................. 453
visible= .................................................................................................................................. 454
visibleon= .............................................................................................................................. 455
<propertygroup> ......................................................................................................................... 456
<Attributes> ........................................................................................................................... 458
<Callbacks> ............................................................................................................................ 458
<GetValue> ............................................................................................................................ 459

xii

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Reference Guide

<help> ................................................................................................................................... 460
<IsValid> ................................................................................................................................ 461
<IsVisible> .............................................................................................................................. 462
<OnActivate> ......................................................................................................................... 463
<OnAdd> ............................................................................................................................... 464
<OnAfterGeometryUpdate> ................................................................................................... 464
<OnApply> ............................................................................................................................ 465
<OnBodySuppressStateChange> ............................................................................................ 466
<OnCancel> ........................................................................................................................... 467
<OnDuplicate> ....................................................................................................................... 468
<OnHide> .............................................................................................................................. 469
<OnInit> ................................................................................................................................ 470
<OnJournalExecuting> ........................................................................................................... 471
<OnJournalRecording> .......................................................................................................... 472
<OnMigrate> .......................................................................................................................... 473
<OnRemove> ......................................................................................................................... 474
<OnShow> ............................................................................................................................. 475
<OnValidate> ......................................................................................................................... 476
<PropertyGroup> ................................................................................................................... 477
<SetValue> ............................................................................................................................. 478
<String2Value> ...................................................................................................................... 479
<Value2String> ...................................................................................................................... 480
caption= ................................................................................................................................ 481
class= ..................................................................................................................................... 482
control= ................................................................................................................................. 483
default= ................................................................................................................................. 483
display= ................................................................................................................................. 484
elementtype= ......................................................................................................................... 485
isparameter= .......................................................................................................................... 486
keytype= ................................................................................................................................ 487
name= ................................................................................................................................... 488
needupdate= ......................................................................................................................... 489
parameterizable= ................................................................................................................... 490
persistent= ............................................................................................................................. 491
readonly= ............................................................................................................................... 492
unit= ...................................................................................................................................... 493
valuetype= ............................................................................................................................. 493
visible= .................................................................................................................................. 494
visibleon= .............................................................................................................................. 495
<propertytable> ........................................................................................................................... 496
<Attributes> ........................................................................................................................... 499
<Callbacks> ............................................................................................................................ 499
<GetValue> ............................................................................................................................ 500
<help> ................................................................................................................................... 501
<IsValid> ................................................................................................................................ 501
<IsVisible> .............................................................................................................................. 502
<OnActivate> ......................................................................................................................... 503
<OnAdd> ............................................................................................................................... 504
<OnAfterGeometryUpdate> ................................................................................................... 505
<OnApply> ............................................................................................................................ 506
<OnBodySuppressStateChange> ............................................................................................ 507
<OnCancel> ........................................................................................................................... 508
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xiii

ACT XML Reference Guide

<OnDuplicate> ....................................................................................................................... 509
<OnHide> .............................................................................................................................. 510
<OnInit> ................................................................................................................................ 511
<OnJournalExecuting> ........................................................................................................... 512
<OnJournalRecording> .......................................................................................................... 513
<OnMigrate> .......................................................................................................................... 514
<OnRemove> ......................................................................................................................... 515
<OnShow> ............................................................................................................................. 516
<OnValidate> ......................................................................................................................... 517
<PropertyGroup> ................................................................................................................... 518
<SetValue> ............................................................................................................................. 519
<String2Value> ...................................................................................................................... 520
<Value2String> ...................................................................................................................... 521
allowempty= .......................................................................................................................... 522
caption= ................................................................................................................................ 523
class= ..................................................................................................................................... 524
control= ................................................................................................................................. 524
default= ................................................................................................................................. 525
display= ................................................................................................................................. 526
elementtype= ......................................................................................................................... 527
isparameter= .......................................................................................................................... 528
keytype= ................................................................................................................................ 529
name= ................................................................................................................................... 530
needupdate= ......................................................................................................................... 531
parameterizable= ................................................................................................................... 532
persistent= ............................................................................................................................. 533
readonly= ............................................................................................................................... 534
unit= ...................................................................................................................................... 534
valuetype= ............................................................................................................................. 535
visible= .................................................................................................................................. 536
visibleon= .............................................................................................................................. 537
<Result> ....................................................................................................................................... 538
<Action> ................................................................................................................................ 540
<Attributes> ........................................................................................................................... 541
<Callbacks> ............................................................................................................................ 542
<CanAdd> .............................................................................................................................. 542
<CanDuplicate> ..................................................................................................................... 543
<CanRemove> ........................................................................................................................ 544
<Evaluate> ............................................................................................................................. 545
<GetFieldCount> .................................................................................................................... 546
<GetValue> ............................................................................................................................ 547
<IsValid> ................................................................................................................................ 548
<OnAdd> ............................................................................................................................... 549
<OnAfterGeometryUpdate> ................................................................................................... 550
<OnBodySuppressStateChange> ............................................................................................ 551
<OnClearData> ...................................................................................................................... 552
<OnDuplicate> ....................................................................................................................... 553
<OnEndEval> ......................................................................................................................... 554
<OnEndPost> ......................................................................................................................... 555
<OnGenerateData> ................................................................................................................ 556
<OnHide> .............................................................................................................................. 557
<OnInit> ................................................................................................................................ 558

xiv

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Reference Guide

<OnMigrate> .......................................................................................................................... 559
<OnReady> ............................................................................................................................ 560
<OnRemove> ......................................................................................................................... 561
<OnShow> ............................................................................................................................. 562
<OnStartEval> ........................................................................................................................ 563
<OnStartPost> ........................................................................................................................ 564
<OnSuppress> ....................................................................................................................... 565
<OnUnsuppress> ................................................................................................................... 566
<Property> ............................................................................................................................. 567
averaging= ............................................................................................................................. 568
caption= ................................................................................................................................ 569
class= ..................................................................................................................................... 570
contextual= ............................................................................................................................ 571
hasimaginary= ....................................................................................................................... 571
icon= ...................................................................................................................................... 572
location= ................................................................................................................................ 573
name= ................................................................................................................................... 574
timehistory= ........................................................................................................................... 575
type= ..................................................................................................................................... 576
unit= ...................................................................................................................................... 577
version= ................................................................................................................................. 578
<rsmjob> ..................................................................................................................................... 579
<Attributes> ........................................................................................................................... 580
<Callbacks> ............................................................................................................................ 581
<CanAdd> .............................................................................................................................. 582
<CanDuplicate> ..................................................................................................................... 583
<CanRemove> ........................................................................................................................ 584
<InputFile> ............................................................................................................................ 585
<IsValid> ................................................................................................................................ 585
<OnAdd> ............................................................................................................................... 586
<OnAfterGeometryUpdate> ................................................................................................... 587
<OnBodySuppressStateChange> ............................................................................................ 588
<OnClearData> ...................................................................................................................... 589
<oncreatejobinput> ............................................................................................................... 590
<OnDuplicate> ....................................................................................................................... 591
<OnGenerateData> ................................................................................................................ 592
<OnHide> .............................................................................................................................. 593
<OnInit> ................................................................................................................................ 594
<onjobcancellation> .............................................................................................................. 595
<onjobreconnect> ................................................................................................................. 596
<onjobstatus> ........................................................................................................................ 597
<OnMigrate> .......................................................................................................................... 598
<OnReady> ............................................................................................................................ 599
<OnRemove> ......................................................................................................................... 600
<OnShow> ............................................................................................................................. 601
<OnSuppress> ....................................................................................................................... 602
<OnUnsuppress> ................................................................................................................... 603
<OutputFile> .......................................................................................................................... 604
<Program> ............................................................................................................................. 605
<Property> ............................................................................................................................. 606
caption= ................................................................................................................................ 606
class= ..................................................................................................................................... 607
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xv

ACT XML Reference Guide

contextual= ............................................................................................................................ 608
deletefiles= ............................................................................................................................ 609
icon= ...................................................................................................................................... 610
name= ................................................................................................................................... 611
version= ................................................................................................................................. 612
<Sampling> ................................................................................................................................. 612
<Attributes> ........................................................................................................................... 615
<Callbacks> ............................................................................................................................ 616
<CanAdd> .............................................................................................................................. 617
<CanDuplicate> ..................................................................................................................... 618
<CanRemove> ........................................................................................................................ 619
<CanRun> .............................................................................................................................. 620
<Configuration> ..................................................................................................................... 621
<Description> ........................................................................................................................ 622
<InputParametersEdited> ....................................................................................................... 623
<IsValid> ................................................................................................................................ 624
<MethodPropertiesEdited> .................................................................................................... 625
<OnAdd> ............................................................................................................................... 626
<OnAfterGeometryUpdate> ................................................................................................... 626
<OnBodySuppressStateChange> ............................................................................................ 627
<OnClearData> ...................................................................................................................... 628
<OnCreate> ........................................................................................................................... 629
<OnDuplicate> ....................................................................................................................... 630
<OnGenerateData> ................................................................................................................ 631
<OnHide> .............................................................................................................................. 632
<OnInit> ................................................................................................................................ 633
<OnMigrate> .......................................................................................................................... 634
<OnReady> ............................................................................................................................ 635
<OnRelease> .......................................................................................................................... 636
<OnRemove> ......................................................................................................................... 637
<OnShow> ............................................................................................................................. 638
<OnSuppress> ....................................................................................................................... 639
<OnUnsuppress> ................................................................................................................... 640
<Property> ............................................................................................................................. 641
<QuickHelp> .......................................................................................................................... 642
<Status> ................................................................................................................................ 643
caption= ................................................................................................................................ 644
class= ..................................................................................................................................... 645
contextual= ............................................................................................................................ 646
CustomTable= ........................................................................................................................ 646
icon= ...................................................................................................................................... 647
logfile= ................................................................................................................................... 648
maximumnumberofdoublelistparameters= ............................................................................. 649
maximumnumberofdoubleparameters= ................................................................................. 650
maximumnumberofinputparameters= .................................................................................... 651
maximumnumberofintegerlistparameters= ............................................................................. 652
name= ................................................................................................................................... 653
version= ................................................................................................................................. 654
<script> ....................................................................................................................................... 655
compiled= .............................................................................................................................. 655
src= ........................................................................................................................................ 656
<separator> ................................................................................................................................. 657

xvi

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Reference Guide

<simdata> .................................................................................................................................... 657
<Object> ................................................................................................................................ 657
context= ................................................................................................................................ 658
<Solver> ...................................................................................................................................... 659
<Attributes> ........................................................................................................................... 661
<Callbacks> ............................................................................................................................ 661
<CanAdd> .............................................................................................................................. 662
<CanDuplicate> ..................................................................................................................... 663
<CanRemove> ........................................................................................................................ 664
<GetFiles> .............................................................................................................................. 665
<GetReader> .......................................................................................................................... 666
<GetSteps> ............................................................................................................................ 667
<IsAnalysisValid> .................................................................................................................... 668
<IsValid> ................................................................................................................................ 669
<OnAdd> ............................................................................................................................... 670
<OnAfterGeometryUpdate> ................................................................................................... 671
<OnBeforeSolve> ................................................................................................................... 671
<OnBodySuppressStateChange> ............................................................................................ 672
<OnCheckResults> ................................................................................................................. 673
<OnClearData> ...................................................................................................................... 674
<OnDuplicate> ....................................................................................................................... 675
<OnGenerateData> ................................................................................................................ 676
<OnHide> .............................................................................................................................. 677
<OnInit> ................................................................................................................................ 678
<OnMigrate> .......................................................................................................................... 679
<OnReady> ............................................................................................................................ 680
<OnRemove> ......................................................................................................................... 681
<OnShow> ............................................................................................................................. 682
<OnSolve> ............................................................................................................................. 683
<OnSuppress> ....................................................................................................................... 684
<OnUnsuppress> ................................................................................................................... 685
<OnWriteInputFile> ................................................................................................................ 686
<Property> ............................................................................................................................. 687
analysis= ................................................................................................................................ 688
caption= ................................................................................................................................ 689
class= ..................................................................................................................................... 690
contextual= ............................................................................................................................ 691
icon= ...................................................................................................................................... 691
name= ................................................................................................................................... 692
physics= ................................................................................................................................. 693
toolbox= ................................................................................................................................ 694
version= ................................................................................................................................. 695
<Step> ......................................................................................................................................... 696
<Attributes> ........................................................................................................................... 698
<Callbacks> ............................................................................................................................ 698
<CanAdd> .............................................................................................................................. 699
<CanDuplicate> ..................................................................................................................... 700
<CanRemove> ........................................................................................................................ 701
<ComponentData> ................................................................................................................ 702
<ComponentStyle> ................................................................................................................ 703
<Description> ........................................................................................................................ 703
<IsValid> ................................................................................................................................ 704
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xvii

ACT XML Reference Guide

<OnAdd> ............................................................................................................................... 705
<OnAfterGeometryUpdate> ................................................................................................... 706
<OnBodySuppressStateChange> ............................................................................................ 707
<OnClearData> ...................................................................................................................... 708
<OnDuplicate> ....................................................................................................................... 709
<OnGenerateData> ................................................................................................................ 710
<OnHide> .............................................................................................................................. 710
<OnInit> ................................................................................................................................ 711
<OnMigrate> .......................................................................................................................... 712
<OnReady> ............................................................................................................................ 713
<onrefresh> ........................................................................................................................... 714
<OnRemove> ......................................................................................................................... 715
<onreset> .............................................................................................................................. 716
<OnShow> ............................................................................................................................. 717
<OnSuppress> ....................................................................................................................... 718
<OnUnsuppress> ................................................................................................................... 719
<onupdate> ........................................................................................................................... 720
<Property> ............................................................................................................................. 721
caption= ................................................................................................................................ 722
class= ..................................................................................................................................... 723
Context= ................................................................................................................................ 724
contextual= ............................................................................................................................ 725
Enabled= ................................................................................................................................ 725
helpFile= ................................................................................................................................ 726
icon= ...................................................................................................................................... 727
Layout= .................................................................................................................................. 728
name= ................................................................................................................................... 729
version= ................................................................................................................................. 730
<Target> ...................................................................................................................................... 731
location= ................................................................................................................................ 731
name= ................................................................................................................................... 732
type= ..................................................................................................................................... 733
<task> .......................................................................................................................................... 734
<Attributes> ........................................................................................................................... 736
<Callbacks> ............................................................................................................................ 736
<CanAdd> .............................................................................................................................. 737
<canconsumedata> ................................................................................................................ 738
<CanDuplicate> ..................................................................................................................... 739
<CanRemove> ........................................................................................................................ 740
<ContextMenus> .................................................................................................................... 741
<Inputs> ................................................................................................................................ 742
<IsValid> ................................................................................................................................ 742
<OnAdd> ............................................................................................................................... 743
<OnAfterGeometryUpdate> ................................................................................................... 744
<OnBodySuppressStateChange> ............................................................................................ 745
<OnClearData> ...................................................................................................................... 746
<ondelete> ............................................................................................................................ 747
<OnDuplicate> ....................................................................................................................... 748
<onedit> ................................................................................................................................ 749
<OnGenerateData> ................................................................................................................ 750
<OnHide> .............................................................................................................................. 751
<OnInit> ................................................................................................................................ 752

xviii

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Reference Guide

<oninitialize> ......................................................................................................................... 753
<OnMigrate> .......................................................................................................................... 754
<OnReady> ............................................................................................................................ 755
<onrefresh> ........................................................................................................................... 756
<OnRemove> ......................................................................................................................... 757
<onreport> ............................................................................................................................ 758
<onreset> .............................................................................................................................. 759
<OnShow> ............................................................................................................................. 760
<onstatus> ............................................................................................................................. 761
<OnSuppress> ....................................................................................................................... 762
<OnUnsuppress> ................................................................................................................... 763
<onupdate> ........................................................................................................................... 764
<Outputs> ............................................................................................................................. 765
<Parameters> ......................................................................................................................... 766
<Property> ............................................................................................................................. 767
<RsmJob> .............................................................................................................................. 767
caption= ................................................................................................................................ 768
class= ..................................................................................................................................... 769
contextual= ............................................................................................................................ 770
enableGenericTransfer= .......................................................................................................... 771
icon= ...................................................................................................................................... 771
name= ................................................................................................................................... 772
version= ................................................................................................................................. 773
<taskgroup> ................................................................................................................................ 774
<Attributes> ........................................................................................................................... 776
<Callbacks> ............................................................................................................................ 776
<CanAdd> .............................................................................................................................. 777
<CanDuplicate> ..................................................................................................................... 778
<CanRemove> ........................................................................................................................ 779
<IncludeGroup> ..................................................................................................................... 780
<IncludeTask> ........................................................................................................................ 781
<IsValid> ................................................................................................................................ 781
<OnAdd> ............................................................................................................................... 782
<OnAfterGeometryUpdate> ................................................................................................... 783
<OnBodySuppressStateChange> ............................................................................................ 784
<OnClearData> ...................................................................................................................... 785
<OnDuplicate> ....................................................................................................................... 786
<OnGenerateData> ................................................................................................................ 787
<OnHide> .............................................................................................................................. 788
<OnInit> ................................................................................................................................ 789
<OnMigrate> .......................................................................................................................... 790
<OnReady> ............................................................................................................................ 791
<OnRemove> ......................................................................................................................... 792
<OnShow> ............................................................................................................................. 793
<OnSuppress> ....................................................................................................................... 794
<OnUnsuppress> ................................................................................................................... 795
<Property> ............................................................................................................................. 796
abbreviation= ......................................................................................................................... 797
caption= ................................................................................................................................ 798
category= ............................................................................................................................... 799
class= ..................................................................................................................................... 800
contextual= ............................................................................................................................ 801
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xix

ACT XML Reference Guide

icon= ...................................................................................................................................... 801
isparametricgroup= ................................................................................................................ 802
name= ................................................................................................................................... 803
version= ................................................................................................................................. 804
<taskgroups> ............................................................................................................................... 805
<TaskGroup> .......................................................................................................................... 805
<tasks> ........................................................................................................................................ 806
<Task> ................................................................................................................................... 806
<Templates> ................................................................................................................................ 807
<ControlTemplate> ................................................................................................................ 807
<toolbar> ..................................................................................................................................... 808
<Separator> ........................................................................................................................... 809
caption= ................................................................................................................................ 809
name= ................................................................................................................................... 810
<UIDefinition> ............................................................................................................................. 811
<ComponentDefinition> ........................................................................................................ 811
<Layout> ................................................................................................................................ 812
<Wizard> ..................................................................................................................................... 813
<Callbacks> ............................................................................................................................ 813
<canstart> .............................................................................................................................. 814
<Description> ........................................................................................................................ 815
<Step> ................................................................................................................................... 816
caption= ................................................................................................................................ 816
context= ................................................................................................................................ 817
icon= ...................................................................................................................................... 818
layout= ................................................................................................................................... 819
name= ................................................................................................................................... 820
version= ................................................................................................................................. 821
<Workflow> ................................................................................................................................. 822
<Attributes> ........................................................................................................................... 824
<Callbacks> ............................................................................................................................ 825
<CanAdd> .............................................................................................................................. 825
<CanDuplicate> ..................................................................................................................... 826
<CanRemove> ........................................................................................................................ 827
<IsValid> ................................................................................................................................ 828
<OnAdd> ............................................................................................................................... 829
<OnAfterGeometryUpdate> ................................................................................................... 830
<onaftertaskcanduplicate> ..................................................................................................... 831
<onaftertaskcanusetransfer> .................................................................................................. 832
<onaftertaskcreation> ............................................................................................................ 833
<onaftertaskdeletion> ............................................................................................................ 834
<onaftertaskduplicate> .......................................................................................................... 835
<onaftertaskpropertyretrieval> ............................................................................................... 836
<onaftertaskrefresh> .............................................................................................................. 837
<onaftertaskreset> ................................................................................................................. 838
<onaftertasksourceschanged> ................................................................................................ 839
<onaftertaskstatus> ............................................................................................................... 840
<onaftertaskupdate> .............................................................................................................. 841
<onbeforetaskcanduplicate> .................................................................................................. 842
<onbeforetaskcanusetransfer> ............................................................................................... 843
<onbeforetaskcreation> ......................................................................................................... 844
<onbeforetaskdeletion> ......................................................................................................... 845

xx

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Reference Guide

<onbeforetaskduplicate> ....................................................................................................... 846
<onbeforetaskpropertyretrieval> ............................................................................................ 847
<onbeforetaskrefresh> ........................................................................................................... 848
<onbeforetaskreset> .............................................................................................................. 849
<onbeforetasksourceschanged> ............................................................................................. 850
<onbeforetaskstatus> ............................................................................................................. 851
<onbeforetaskupdate> ........................................................................................................... 852
<OnBodySuppressStateChange> ............................................................................................ 853
<OnClearData> ...................................................................................................................... 854
<OnDuplicate> ....................................................................................................................... 855
<OnGenerateData> ................................................................................................................ 856
<OnHide> .............................................................................................................................. 857
<OnInit> ................................................................................................................................ 858
<OnMigrate> .......................................................................................................................... 859
<OnReady> ............................................................................................................................ 860
<OnRemove> ......................................................................................................................... 861
<OnShow> ............................................................................................................................. 862
<OnSuppress> ....................................................................................................................... 863
<OnUnsuppress> ................................................................................................................... 864
<Property> ............................................................................................................................. 865
<TaskGroups> ........................................................................................................................ 866
<Tasks> .................................................................................................................................. 867
caption= ................................................................................................................................ 867
class= ..................................................................................................................................... 868
context= ................................................................................................................................ 869
contextual= ............................................................................................................................ 870
icon= ...................................................................................................................................... 871
name= ................................................................................................................................... 872
version= ................................................................................................................................. 873

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

xxi

xxii

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

Part I: ACT XML Reference

This document describes the XML tags used to define ACT extensions. For the most effective navigation
of available tags, start with the top-level <Extension> (p. 106) tag.

Note
Information on XML tags can also be accessed in the ACT Online Reference Guide, an easy-tonavigate document providing both API and XML reference materials for ACT. Both online
(.html) and downloadable (.zip) versions are available.
To access this document, go to the ANSYS ACT Application Store for the current release
on the ANSYS Customer Portal.

ACT XML Tags

Table 1: XML Tag Listing
<ActionCallback> (p. 5)

Class defining the action callback.

<Application> (p. 8)

Class defining a new application.

<argument> (p. 17)

This class defines the Argument XML Tag.

<assembly> (p. 20)

Class defining the assembly to be loaded.

<attributes> (p. 23)

Class defining the set of attributes for the object.

<Callback> (p. 24)

No details provided.

<CallbackGetCommands> (p. 24)

Class providing the commands to add to the solver

input file.

<CallbackGetPostPreSolveCommands> (p. 26) Class collecting all commands to add to the solver
input file.
<CallbackOnActiveObjectChange> (p. 28)

Callback that is invoked when the active object

changes.

<Callbacks> (p. 31)

Class specifying the callbacks that will invoke

functions from the IronPython extension script.

<Component> (p. 32)

Class defining a new component in a layout.

<ComponentData> (p. 51)

Class defining the data for the component.

<ComponentDefinition> (p. 52)

Class defining the display of the component.

<ComponentStyle> (p. 59)

Class defining the styles for the component.

<contextmenus> (p. 61)

No details provided.

<ControlTemplate> (p. 62)

Class defining a control template for the creation of

groups of properties.

<entity> (p. 65)

Class defining a custom data entity definition based

on an ACT XML Extension file.

<entry> (p. 92)

Class defining a user-interface GUI operatio.

<entry> (p. 100)

Class defining a drop-down menu within a toolbar.

<Extension> (p. 106)

Class defining an ACT extension.

<ExtensionObject> (p. 122)

Class extending the extension object definition.

(Inherited from DesignXplorer SimEntity)

<filter> (p. 151)

Class defining a filter for the object.

<Geometry> (p. 153)

Class defining a geometry feature.

<guid> (p. 182)

Class defining a unique identifier for the extension.

<includegroup> (p. 184)

Class defining the include group tag (used by task

groups).

<includetask> (p. 187)

Class defining the include task tag (used by task

groups).

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Tags

<input> (p. 190)

Class defining an input-level data connection

definition.

<inputfile> (p. 193)

This class difines the InputFile XML Tag.

<inputs> (p. 195)

Class defining the inputs collection for a task.

<Interface> (p. 196)

Class defining the user interface for the extension.

<Layout> (p. 224)

Class defining the a new panel layout.

<License> (p. 226)

Class defining a license to be used in the execution

of an extension.

<Licenses> (p. 227)

Class defining a licenses collection for the extension.

<Load> (p. 228)

Class defining a simulation load or boundary.

<Object> (p. 266)

Class defining an object.

<Optimizer> (p. 305)

Class defining an optimizer.

<OrderableCallback> (p. 370)

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. 371)

Class defining an output-level data connection

definition.

<outputfile> (p. 373)

This class defines the OutputFile XML Tag.

<outputs> (p. 375)

Class defining the outputs collection for a task.

<Panel> (p. 376)

Class defining a panel to be displayed in the

application.

<parameter> (p. 383)

Class defining a single parameter definition for a task.

<parameters> (p. 411)

Class defining the collection of task parameters.

<platform> (p. 412)

This class defines the Platform XML Tag.

<program> (p. 414)

This class defines the Program XML Tag.

<projectdata> (p. 416)

No details provided.

<property> (p. 417)

Class defining a property of any user object.

<propertygroup> (p. 456)

Class defining a collection of properties.

<propertytable> (p. 496)

Class encapsulateing a list of child properties under

one table.

<Result> (p. 538)

Class defining a result.

<rsmjob> (p. 579)

This class defines an rsm job.

<Sampling> (p. 612)

Class defining a DesignXxplorer Sampling.

<code><sampling>...</sampling></code>

<script> (p. 655)

Specifies the IronPython script referenced by the

extension.

<separator> (p. 657)

Class defining the separator for items in a toolbar.

<simdata> (p. 657)

Class defining a general section that stores all user

object definitions.

<Solver> (p. 659)

Class specifying a third-party solver to be used in the

simulation.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ActionCallback>
<Step> (p. 696)

Class defining a step in a guided process a (wizard or

AIM custom template).

<Target> (p. 731)

Class defining the target location for the object.

<task> (p. 734)

Class defining a task that encapsulates a single

process or application.

<taskgroup> (p. 774)

Class defining a collection of tasks.

<taskgroups> (p. 805)

Class defining the task groups collection.

<tasks> (p. 806)

Class defining the tasks collection.

<Templates> (p. 807)

Class defining a collection of control templates.

<toolbar> (p. 808)

Class defining a toolbar in the UI of the application.

<UIDefinition> (p. 811)

Class defining a set of interface layouts that can be

used for guided processes (wizards).

<Wizard> (p. 813)

Class defining a guided process (a wizard or AIM

custom template) within the extension.

<Workflow> (p. 822)

Class defining the top-level workflow tag within an

ACT app.

<ActionCallback>
Class defining the action callback.

Remarks
None.

Examples
None.
Table 2: XML Tag Listing
Attribute caption= (p. 5)

No details provided.

Attribute icon= (p. 6)

No details provided.

Attribute name= (p. 7)

Name of the action

callback.

caption=
No details provided.

Type
System_String

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Tags

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

icon=
No details provided.

Type
System_String

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ActionCallback>

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 action callback.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

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

<Application>
Class defining a new application.

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

Examples
None.
Table 3: XML Tag Listing
Tag

<Callbacks> (p. 9)

Specifies the callbacks that will invoke functions from

the IronPython extension script.

Tag

<description> (p. 9)

Description of the application.

Callback <OnApplicationFinished> (p. 10)

Callback that is invoked after the application finishes.

Callback <OnApplicationInitialized> (p. 11) Callback that is invoked when the application initializes.
Callback <OnApplicationStarted> (p. 12)

Callback that is invoked when the application starts.

Tag

Defines one or more panels to be displayed in the

application.

<Panel> (p. 13)

Attribute class= (p. 13)

Class name of the controller of the object.

Attribute context= (p. 14)

Defines a context or combination of contexts (separated

using '|') in which the application can be launched.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Application>
Attribute MainPanel= (p. 15)

Name of the first panel to display.

Attribute name= (p. 16)

Name of the application.

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

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

Remarks
The &lt;callbacks&gt; element and its children specify the Python functions that are invoked based on
system and user-generated events.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<description>
Description of the application.

Type
System_String

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

ACT XML Tags

Examples
None.

Details
Description
Description of the application.
Name
description
ValueName
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_Application_
Name
OnApplicationFinished
Public
True
Obsolete
False
ObsoleteMessage
None.

10

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Application>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnApplicationInitialized>
Callback that is invoked when the application initializes.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_Application_
Name
OnApplicationInitialized
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

11

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_Application_
Name
OnApplicationStarted
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0

12

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Application>
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_Panel (p. 376)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

class=
Class name of the controller of the object.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

13

ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

context=
Defines a context or combination of contexts (separated using '|') in which the application can be
launched.

Type
System_String_ARRAY_

14

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Application>

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
True
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

MainPanel=
Name of the first panel to display.

Type
System_String

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

15

ACT XML Tags

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
MainPanel
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the application.

Type
System_String

Remarks
None.

Examples
None.

16

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<argument>

Details
Mandatory
True
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<argument>
This class defines the Argument XML Tag.

Remarks
None.

Examples
None.
Table 4: XML Tag Listing
Attribute name= (p. 18)

The argument name.

Attribute separator= (p. 18)

The argument-value
separator.

Attribute value= (p. 19)

The argument value.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

17

ACT XML Tags

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
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

separator=
The argument-value separator.

18

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<argument>

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

value=
The argument value.

Type
System_String

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

19

ACT XML Tags

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.

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

20

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<assembly>

Examples
Example 1: <code type="xml"> &lt;assembly src="CSharp.dll" namespace="CSharp" /&gt; </code>
Table 5: XML Tag Listing
Attribute context= (p. 21)

Context or combination of contexts (separated using '|') for the

import.

Attribute namespace= (p. 22)

Namespace to import.

Attribute src= (p. 23)

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
MappedValues
None.
Public
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

21

ACT XML Tags

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
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

22

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<attributes>

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

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

23

ACT XML Tags

Remarks
None.

Examples
None.

<Callback>
No details provided.

Remarks
None.

Examples
None.

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

Remarks
None.

Examples
None.
Table 6: XML Tag Listing
Attribute location= (p. 24)

Location of
the call.

Attribute order= (p. 25)

Order of the
call.

location=
Location of the call.

Type
System_String

Remarks
None.

24

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<CallbackGetCommands>

Examples
None.

Details
Mandatory
True
Name
location
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

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

25

ACT XML Tags

Details
Mandatory
False
Name
order
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.

Examples
None.
Table 7: XML Tag Listing
Attribute order= (p. 26)

Order of the call.

Attribute timedependent= (p. 27)

Specifies if the callback will be called for each

step.

order=
Order of the call.

26

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<CallbackGetPostPreSolveCommands>

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
order
DefaultValue
1
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Boolean

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

27

ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
timedependent
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.

Remarks
None.

28

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<CallbackOnActiveObjectChange>

Examples
None.
Table 8: XML Tag Listing
Attribute name= (p. 29)

The
name
filter.

Attribute type= (p. 30)

The type
filter.

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

29

ACT XML Tags

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

30

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Callbacks>

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

Remarks
The &lt;callbacks&gt; element and its children specify the Python functions that are invoked based on
system- and user-generated events.

Examples
None.
Table 9: XML Tag Listing
Tag <Action> (p. 31)

No details
provided.

<Action>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Action (p. 5)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Action
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

31

ACT XML Tags

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

Remarks
None.

Examples
None.
Table 10: XML Tag Listing
Tag

<Attributes> (p. 32)

Defines the set ofattributes for the

component.

Attribute BottomAttachment= (p. 33)

Bottom attachment of the layout.

Attribute BottomOffset= (p. 34)

Bottom offset related to the bottom

attachment.

Attribute ComponentType= (p. 35)

Type of the component for the component.

Attribute CustomCSSFile= (p. 36)

Custom css file for the component layout.

Attribute CustomHTMLFile= (p. 37)

Custom html file for the component layout.

Attribute CustomJSFile= (p. 38)

Custom jscript file for the component

layout.

Attribute Height= (p. 38)

Height value for the component.

Attribute HeightType= (p. 39)

Height type for the component.

Attribute LeftAttachment= (p. 40)

Left attachment of the layout.

Attribute LeftOffset= (p. 41)

Left offset related to the left attachment.

Attribute MaxHeight= (p. 42)

Maximum height for the component.

Attribute MaxWidth= (p. 43)

Maximum width for the component.

Attribute name= (p. 44)

Name of the component.

Attribute RightAttachment= (p. 45)

Right attachment of the layout.

Attribute RightOffset= (p. 46)

Right offset related to the right

attachment.

Attribute TopAttachment= (p. 47)

Top attachment of the layout.

Attribute TopOffset= (p. 47)

Top offset related to the top attachment.

Attribute visible= (p. 48)

Initial visibility of the component.

Attribute Width= (p. 49)

Width value for the component.

Attribute WidthType= (p. 50)

Width type for the component.

<Attributes>
Defines the set ofattributes for the component.

32

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Component>

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

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
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

33

ACT XML Tags

MultipleValue
False
Name
BottomAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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
Mandatory
False
MultipleValue
False
Name
BottomOffset

34

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Component>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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
Mandatory
True
MultipleValue
False
Name
ComponentType
DefaultValue
None.
DataDefinition
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

35

ACT XML Tags

AllowedValues
None.
MappedValues
None.
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
Mandatory
False
MultipleValue
False
Name
CustomCSSFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.

36

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Component>
Public
True
Description
None.
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
Mandatory
False
MultipleValue
False
Name
CustomHTMLFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.

Release 17.1 - SAS IP, 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

CustomJSFile=
Custom jscript 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
Mandatory
False
MultipleValue
False
Name
CustomJSFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Height=
Height value for the component.

38

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Component>

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
True
MultipleValue
False
Name
Height
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

HeightType=
Height type for the component.

Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

39

ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
True
MultipleValue
False
Name
HeightType
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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.

40

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Component>

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
LeftAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

41

ACT XML Tags

Details
Mandatory
False
MultipleValue
False
Name
LeftOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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
Mandatory
False

42

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Component>
MultipleValue
False
Name
MaxHeight
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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
Mandatory
False
MultipleValue
False
Name
MaxWidth

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

43

ACT XML Tags

DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the component.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False

44

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Component>
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

RightAttachment=
Right attachment of the layout.

Type
System_String

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

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
RightAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

45

ACT XML Tags

Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

RightOffset=
Right offset related to the right attachment.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
RightOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.

46

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

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

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
TopAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

TopOffset=
Top offset related to the top attachment.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

47

ACT XML Tags

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
TopOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

visible=
Initial visibility of the component.

Type
System_Boolean

48

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Component>

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
visible
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Width=
Width value for the component.

Type
System_Int32

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

49

ACT XML Tags

Examples
None.

Details
Mandatory
True
MultipleValue
False
Name
Width
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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.

50

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ComponentData>

Details
Mandatory
True
MultipleValue
False
Name
WidthType
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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 11: XML Tag Listing
Attribute component= (p. 51)

No details
provided.

component=
No details provided.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

51

ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True
Name
component
DefaultValue
None.
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.

52

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ComponentDefinition>

Examples
None.
Table 12: XML Tag Listing
Attribute Class= (p. 53)

Class to control this component.

Attribute CSSFile= (p. 54)

Default CSS file to use for this component.

Attribute DataModelClass= (p. 55)

Class type that describes the data model of the

component

Attribute Directory= (p. 56)

Directory where are located HTML, CSS and JS files

Attribute HTMLFile= (p. 56)

Default HTML file to use for this component.

Attribute JSFile= (p. 57)

Default JS file to use for this component.

Attribute Name= (p. 58)

Name of the component definition.

Class=
Class to control this component.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
Class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

53

ACT XML Tags

MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

CSSFile=
Default CSS file to use for this component.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
CSSFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True

54

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ComponentDefinition>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
DataModelClass
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

55

ACT XML Tags

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.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
Directory
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

HTMLFile=
Default HTML file to use for this component.

56

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ComponentDefinition>

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
HTMLFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

JSFile=
Default JS file to use for this component.

Type
System_String

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

57

ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
JSFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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.

58

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ComponentStyle>

Examples
None.

Details
Mandatory
True
MultipleValue
False
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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 13: XML Tag Listing
Attribute component= (p. 60)

Name of the component for which styles are being

defined.

Attribute filter= (p. 60)

Filter for the component styles.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

59

ACT XML Tags

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

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True
MultipleValue
False
Name
component
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

filter=
Filter for the component styles.

60

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<contextmenus>

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
filter
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<contextmenus>
No details provided.

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

61

ACT XML Tags

Examples
None.
Table 14: XML Tag Listing
Tag <UIEntry> (p. 62)

No details
provided.

<UIEntry>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_UIEntry (p. 92)

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.

62

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ControlTemplate>

Examples
None.
Table 15: XML Tag Listing
Tag

<PropertyTable> (p. 63)

No details provided.

Attribute name= (p. 63)

Name of the control

template.

Attribute version= (p. 64)

Version of the control

template.

<PropertyTable>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_PropertyTable (p. 496)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_PropertyTable
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

name=
Name of the control template.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

63

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 control template.

Type
System_Int32

64

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>

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

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

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

65

ACT XML Tags

Examples
None.
Table 16: XML Tag Listing
Tag

<Attributes> (p. 67)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 67)

No details provided. (inherited from SimEntity)

Callback <CanAdd> (p. 68)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <CanDuplicate> (p. 69)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

Callback <CanRemove> (p. 70)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Callback <IsValid> (p. 71)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 72)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGeometryUpdate> (p. 73)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

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

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <OnDuplicate> (p. 76)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <OnGenerateData> (p. 77)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Callback <OnHide> (p. 78)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 79)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <OnMigrate> (p. 79)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 80)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <OnRemove> (p. 81)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <OnShow> (p. 82)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Callback <OnSuppress> (p. 83)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 84)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Tag

No details provided. (inherited from SimEntity)

66

<Property> (p. 85)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>
Attribute caption= (p. 86)

Caption of the object. (inherited from SimEntity)

Attribute class= (p. 87)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute contextual= (p. 88)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

Attribute datatype= (p. 89)

Data type representing the schematic-exposed

type for which this data entity represents.

Attribute icon= (p. 89)

Icon for the object. (inherited from SimEntity)

Attribute name= (p. 90)

Name of the object. (inherited from SimEntity)

Attribute version= (p. 91)

Version of the object. (inherited from SimEntity)

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

67

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

68

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

69

ACT XML Tags

Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Mandatory
False
Name
CanRemove

70

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Mandatory
False
Name
IsValid
Public
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

71

ACT XML Tags

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. 24)

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

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False

72

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Mandatory
False
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

73

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Mandatory
False
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.

74

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

75

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1

76

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>
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. 24)

Remarks
None.

Examples
None.

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

77

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. 24)

Remarks
None.

Examples
None.

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

78

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

Examples
None.

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

<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

79

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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
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 SimEntity) (inherited from SimEntity)

80

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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. 24)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

81

ACT XML Tags

Remarks
None.

Examples
None.

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. 24)

Remarks
None.

82

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>

Examples
None.

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. 24)

Remarks
None.

Examples
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

83

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

84

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>

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

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

85

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.

86

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

Examples
None.

Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

87

ACT XML Tags

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

88

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>
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

icon=
Icon for the object. (inherited from SimEntity)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

89

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

90

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entity>

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

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

91

ACT XML Tags

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.

Examples
None.
Table 17: XML Tag Listing
Tag

<Callbacks> (p. 93)

Callbacks

Callback <onclick> (p. 93)

Callback that is invoked on click.

Attribute caption= (p. 94)

Display text of GUI operation.

92

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entry>
Attribute icon= (p. 95)

Icon for the object.

Attribute name= (p. 96)

Name of GUI operation.

Attribute priority= (p. 97)

UI-level priority (for grouping and ordering

purposes)

Attribute type= (p. 98)

Type of GUI operation.

Attribute version= (p. 99)

Version of GUI operation...for backwards

compatiblity

<Callbacks>
Callbacks

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<onclick>
Callback that is invoked on click.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

93

ACT XML Tags

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

caption=
Display text of GUI operation.

Type
System_String

Remarks
None.

94

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entry>

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the object.

Type
System_String

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

95

ACT XML Tags

Details
Mandatory
False
MultipleValue
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of GUI operation.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

96

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entry>
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
priority

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

97

ACT XML Tags

DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

type=
Type of GUI operation.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
type
DefaultValue
None.
DataDefinition
False

98

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entry>
AllowedValues
None.
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
Mandatory
False
MultipleValue
False
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

99

ACT XML Tags

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 18: XML Tag Listing
Tag

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

Callback <OnClick> (p. 101)

Tag

Callback that is invoked to return when the object is clicked.

<Separator> (p. 102) No details provided.

Attribute caption= (p. 103)

Caption of the entry.

Attribute Icon= (p. 103)

Icon of the entry.

Attribute name= (p. 104)

Name of the entry.

Attribute userobject= (p. 105) Related user object name.

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

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

Remarks
None.

Examples
None.

100

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entry>

Details
ChildType
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IDataModelObject_
Name
OnClick
Public
True
Obsolete
False
ObsoleteMessage
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

101

ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Separator>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Separator (p. 657)

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

102

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entry>

caption=
Caption of the entry.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Icon=
Icon of the entry.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

103

ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
Icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the entry.

Type
System_String

104

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<entry>

Remarks
None.

Examples
None.

Details
Mandatory
True
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

userobject=
Related user object name.

Type
System_String

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

105

ACT XML Tags

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
userobject
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Extension>
Class defining an ACT extension.

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

Examples
None.
Table 19: XML Tag Listing
Tag

<Application> (p. 107)

Defines one or more ACT applications that will be posted to the

ANSYS ACT Application Store.

Tag

<appStoreId> (p. 108)

Defines a unique identifier for the ACT application, to be used in

the ANSYS ACT Application Store.

106

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Extension>
Tag

<assembly> (p. 108)

Defines one or more assemblies to be loaded.

Tag

<author> (p. 109)

Defines the author of the extension.

Tag

<description> (p. 110)

Defines the description of the extension.

Tag

<Guid> (p. 110)

Defines a unique identifier for the extension.

Tag

<Interface> (p. 111)

Defines one or more the user interfaces for the extension.

Tag

<Licenses> (p. 112)

Defines a licenses collection for the extension.

Tag

<script> (p. 112)

Specifies one or more IronPython scripts referenced by the

extension.

Tag

<simdata> (p. 113)

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

Tag

<Templates> (p. 114)

Defines a collection of control templates for the extension.

Tag

<UIDefinition> (p. 114) Defines one or more user interfaces for the extension.

Tag

<Wizard> (p. 115)

Defines one or more wizards within the extension.

Tag

<Workflow> (p. 116)

Defines one or more user-defined custom workflows composed

of tasks and task groups.

Attribute debug= (p. 116)

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

Attribute icon= (p. 117)

Icon for the extension.

Attribute loadAsDefault= (p. 118) Specifies if the extension should be loaded automatically.
Attribute masked= (p. 119)

Specifies if the extension should be loaded automatically, but

hidden in the Extension Manager.

Attribute minorversion= (p. 120) Minor version of the extension.

Attribute name= (p. 121)

Name of the extension.

Attribute version= (p. 122)

Major version of the extension.

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

Type
Ansys_ACT_Core_XmlDataModel_Application (p. 8)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

107

ACT XML Tags

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 ACT Application Store.

Type
System_String

Remarks
None.

Examples
None.

Details
Description
Unique identifier of the application for the ANSYS Application 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. 20)

108

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Extension>

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<author>
Defines the author of the extension.

Type
System_String

Remarks
None.

Examples
None.

Details
Description
Author of the extension.
Name
author
ValueName
authorName
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

109

ACT XML Tags

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.
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. 182)

Remarks
None.

Examples
None.
110

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Extension>

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. 196)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

111

ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Licenses>
Defines a licenses collection for the extension.

Type
Ansys_ACT_Core_XmlDataModel_Licenses (p. 227)

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.

Type
Ansys_ACT_Core_XmlDataModel_Script (p. 655)

Remarks
None.

Examples
None.
112

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Extension>

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. 657)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

113

ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Templates (p. 807)

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.

Type
Ansys_ACT_Core_XmlDataModel_UI_UIDefinition (p. 811)

Remarks
None.

Examples
None.
114

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Extension>

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. 813)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

115

ACT XML Tags

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. 822)

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.

Type
System_Boolean

Remarks
None.

Examples
None.
116

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Extension>

Details
Mandatory
False
MultipleValue
False
Name
debug
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the extension.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

117

ACT XML Tags

MultipleValue
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

loadAsDefault=
Specifies if the extension should be loaded automatically.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
loadAsDefault

118

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Extension>
DefaultValue
False
DataDefinition
False
AllowedValues
None.
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
Mandatory
False
MultipleValue
False
Name
masked
DefaultValue
False
DataDefinition
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

119

ACT XML Tags

AllowedValues
None.
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
Mandatory
False
MultipleValue
False
Name
minorversion
DefaultValue
0
DataDefinition
False
AllowedValues
None.
MappedValues
None.

120

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Extension>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the extension.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

121

ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Major version of the extension.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
version
DefaultValue
1
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

122

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

Remarks
None.

Examples
None.
Table 20: XML Tag Listing
Tag

<Attributes> (p. 124)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 125)

No details provided. (inherited from SimEntity)

Callback <CanAdd> (p. 125)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <CanDuplicate> (p. 126)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

Callback <CanRemove> (p. 127)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Callback <HostObjectModified> (p. 128)

Callback that is invoked to return when the

properties of host object have changed.

Callback <IsValid> (p. 129)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 130)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGeometryUpdate> (p. 131)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

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

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <OnDuplicate> (p. 134)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <OnGenerateData> (p. 135)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Callback <OnHide> (p. 136)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 137)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <OnMigrate> (p. 138)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 139)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <OnRemove> (p. 140)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <OnShow> (p. 141)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

123

ACT XML Tags

Callback <OnSuppress> (p. 142)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 143)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Tag

<Property> (p. 144)

No details provided. (inherited from SimEntity)

Tag

<Target> (p. 145)

Defines the target location for the object.

Attribute caption= (p. 146)

Caption of the object. (inherited from SimEntity)

Attribute class= (p. 146)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute contextual= (p. 147)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

Attribute icon= (p. 148)

Icon for the object. (inherited from SimEntity)

Attribute name= (p. 149)

Name of the object. (inherited from SimEntity)

Attribute version= (p. 150)

Version of the object. (inherited from SimEntity)

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

124

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

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

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_CanAdd
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
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. 24)

Remarks
None.

Examples
None.

126

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_CanRemove
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

128

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
HostObjectModified
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

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

Examples
None.

130

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

131

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. 24)

Remarks
None.

Examples
None.

132

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

133

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

134

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

135

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

136

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

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. 24)

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

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

137

ACT XML Tags

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

Examples
None.

138

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

139

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. 24)

Remarks
None.

Examples
None.

140

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

141

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. 24)

Remarks
None.

Examples
None.

142

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

143

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

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

Remarks
None.

Examples
None.

144

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

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. 731)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

145

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
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)

146

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

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)

Type
System_Boolean

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

147

ACT XML Tags

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

Remarks
None.

148

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<ExtensionObject>

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.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

149

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

150

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<filter>
Name
version
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.

Examples
None.
Table 21: XML Tag Listing
Attribute name= (p. 151) Name of the filter.
Attribute src= (p. 152)

Specifies the path of the reference IronPython

script.

name=
Name of the filter.

Type
System_String

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

151

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

src=
Specifies the path of the reference IronPython script.

Type
System_String

Remarks
None.

152

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>

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.

Remarks
None.

Examples
None.
Table 22: XML Tag Listing
Tag

<Attributes> (p. 155)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 155)

No details provided. (inherited from SimEntity)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

153

ACT XML Tags

Callback <CanAdd> (p. 156)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <CanDuplicate> (p. 157)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

Callback <CanRemove> (p. 158)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Callback <IsValid> (p. 159)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 160)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGenerate> (p. 161)

Callback that is invoked at the end of the

generation process.

Callback <OnAfterGeometryUpdate> (p. 162)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

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

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <OnDuplicate> (p. 165)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <OnEdit> (p. 165)

Callback that is invoked when the object is edited.

Callback <OnGenerate> (p. 166)

Callback that is invoked when the object is

generated.

Callback <OnGenerateData> (p. 167)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Callback <OnHide> (p. 168)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 169)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <OnMigrate> (p. 170)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 171)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <OnRemove> (p. 172)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <OnShow> (p. 173)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Callback <OnSuppress> (p. 174)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 175)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Tag

No details provided. (inherited from SimEntity)

<Property> (p. 176)

Attribute caption= (p. 177)

154

Caption of the object. (inherited from SimEntity)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>
Attribute class= (p. 178)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute contextual= (p. 179)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

Attribute icon= (p. 180)

Icon for the object. (inherited from SimEntity)

Attribute name= (p. 180)

Name of the object. (inherited from SimEntity)

Attribute version= (p. 181)

Version of the object. (inherited from SimEntity)

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

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. 31)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

155

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Mandatory
False
Name
CanAdd
156

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False
Name
CanDuplicate
Public
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

157

ACT XML Tags

Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False

158

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

159

ACT XML Tags

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. 24)

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

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.

160

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

161

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Mandatory
False
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1

162

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>
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. 24)

Remarks
None.

Examples
None.

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

163

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

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

164

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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

<OnEdit>
Callback that is invoked when the object is edited.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

165

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
OnEdit
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

166

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnGenerate
Mandatory
False
Name
OnGenerate
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. 24)

Remarks
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

167

ACT XML Tags

Examples
None.

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. 24)

Remarks
None.

Examples
None.

168

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>

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. 24)

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

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

169

ACT XML Tags

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

Examples
None.

170

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>

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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

171

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. 24)

Remarks
None.

Examples
None.

172

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

173

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. 24)

Remarks
None.

Examples
None.

174

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

175

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

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

Remarks
None.

Examples
None.

176

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

177

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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

Examples
None.

Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.

178

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

179

ACT XML Tags

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

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

180

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Geometry>

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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

181

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

<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.<br /> 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).<br /> 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.<br />

182

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<guid>

Examples
Example 1: A GUID can be generated from the project's page command window using the following
code:<br /><br /><code type="python"> import System System.Guid.NewGuid().ToString() </code>
Table 23: XML Tag Listing
Attribute shortid= (p. 183) 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
Mandatory
False
MultipleValue
False
Name
shortid
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

183

ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Remarks
None.

Examples
None.
Table 24: XML Tag Listing
Attribute caption= (p. 184) The caption of the item to include. (inherited from IncludeTag)
Attribute external= (p. 185) Indicates whether the included item is defined outside of the extension
file. (inherited from IncludeTag)
Attribute name= (p. 186)

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

184

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

185

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

186

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 25: XML Tag Listing
Attribute caption= (p. 187) The caption of the item to include. (inherited from IncludeTag)
Attribute external= (p. 188) Indicates whether the included item is defined outside of the extension
file. (inherited from IncludeTag)
Attribute name= (p. 189)

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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

187

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.

188

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

189

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 26: XML Tag Listing
Attribute count= (p. 190)

Maximum number of simultaneous input

instances.

Attribute format= (p. 191) Connection format type. (inherited from

IOItem)
Attribute type= (p. 192)

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

190

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

191

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

192

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 27: XML Tag Listing
Attribute id= (p. 193)

The unique file id. (inherited

from File)

Attribute name= (p. 194) 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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

193

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.

194

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<inputs>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Remarks
None.

Examples
None.
Table 28: XML Tag Listing
Tag <Input> (p. 195) No details
provided.

<Input>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Input (p. 190)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

195

ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Input
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Remarks
This interface element information pertains specifically to the GUI.

Examples
None.
Table 29: XML Tag Listing
Tag

<Callbacks> (p. 197)

No details provided.

Tag

<filter> (p. 198)

Defines one or more filters.

Callback <GetPostCommands> (p. 198)

Called to collect all "post" commands to add to

the solver input file.

Callback <GetPreCommands> (p. 199)

Called to collect all "pre" commands to add to the

solver input file.

Callback <GetSolveCommands> (p. 200)

Called to collect all "solve" commands to add to

the solver input file.

Tag

Defines the default folder where images to be

used by the extension are stored.

<images> (p. 201)

Callback <IsAnalysisValid> (p. 202)

Called to know if an analysis is valid.

Callback <OnActiveObjectChange> (p. 203)

Called when the active object change.

Callback <OnAfterGeometryUpdate> (p. 204)

OnAfterGeometryUpdate.

Callback <OnAfterRemove> (p. 205)

OnAfterRemove.

Callback <OnAfterSolve> (p. 206)

Called when an analysis has been solved.

Callback <OnBeforeGeometryUpdate> (p. 207)

OnBeforeGeometryUpdate.

196

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Interface>
Callback <OnBeforeSolve> (p. 208)

Called when an analysis starts to solve.

Callback <OnBodySuppressStateChange> (p. 208) Called when the body suppress state change.
Callback <OnDraw> (p. 209)

Called when the application is drawn.

Callback <OnDraw2D> (p. 210)

Called when the application is drawn.

Callback <OnInit> (p. 211)

Called when the given context is initialized.

Callback <OnLoad> (p. 212)

Called when a project is loaded.

Callback <OnMeshCleaned> (p. 213)

Called when the mesh is cleaned.

Callback <OnMeshGenerated> (p. 214)

Called when the mesh is generated.

Callback <OnPostFinished> (p. 215)

Called when the post process end for a given

analysis.

Callback <OnPostStarted> (p. 216)

Called when the post process start for a given

analysis.

Callback <OnReady> (p. 217)

OnReady.

Callback <OnSave> (p. 218)

Called when a project is saved.

Callback <OnTerminate> (p. 219)

Called when the given context is terminated.

Callback <Resume> (p. 220)

Called when a project is loaded. Usefull to retreive

aditional data.

Callback <Save> (p. 221)

Called when a project is saved. Usefull to save

aditional data.

Tag

Defines one or more toolbars.

<toolbar> (p. 222)

Attribute context= (p. 223)

Context or combination of contexts (separated

using '|') for the interface.

<Callbacks>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

197

ACT XML Tags

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. 151)

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.

198

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Interface>

Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 26)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetAnalysisSolveCommands
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. 26)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

199

ACT XML Tags

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetAnalysisSolveCommands
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. 26)

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

200

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Interface>

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetAnalysisSolveCommands
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

<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.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

201

ACT XML Tags

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.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsAnalysisValid
Name
IsAnalysisValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.

202

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Interface>
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. 28)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActiveObjectChanged
Name
OnActiveObjectChange
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

203

ACT XML Tags

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. 24)

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

204

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Interface>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAfterRemove>
OnAfterRemove.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

205

ACT XML Tags

Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAfterSolve>
Called when an analysis has been solved.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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

206

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Interface>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnBeforeGeometryUpdate>
OnBeforeGeometryUpdate.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

207

ACT XML Tags

<OnBeforeSolve>
Called when an analysis starts to solve.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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.

208

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Interface>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

<OnDraw>
Called when the application is drawn.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

209

ACT XML Tags

Remarks
None.

Examples
None.

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. 24)

Remarks
None.

210

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Interface>

Examples
None.

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. 24)

Remarks
None.

Examples
None.
Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

212

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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
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. 24)

Remarks
None.

Examples
None.

214

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

216

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

217

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. 24)

Remarks
None.

Examples
None.

218

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

220

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Interface>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 808)

Remarks
None.

Examples
None.

222

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Interface>

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
Mandatory
True
MultipleValue
True
Name
context
DefaultValue
None.
DataDefinition
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

223

ACT XML Tags

AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Layout>
Class defining the a new panel layout.

Remarks
None.

Examples
None.
Table 30: XML Tag Listing
Tag

<Component> (p. 224) Defines the component for which the panel layout is being
defined.

Attribute name= (p. 225)

Name of the layout.

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

Type
Ansys_ACT_Core_XmlDataModel_UI_Component (p. 32)

Remarks
None.

Examples
None.

Details
ChildType
None.

224

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Layout>
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

name=
Name of the layout.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

225

ACT XML Tags

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.

Examples
None.
Table 31: XML Tag Listing
Attribute name= (p. 226) Name of the
license.

name=
Name of the license.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
name
DefaultValue
None.

226

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Licenses>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Remarks
None.

Examples
None.
Table 32: XML Tag Listing
Tag <License> (p. 227) A license collection defined for the
extension.

<License>
A license collection defined for the extension.

Type
Ansys_ACT_Core_XmlDataModel_License (p. 226)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

227

ACT XML Tags

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Load>
Class defining a simulation load or boundary.

Remarks
The &lt;load&gt; 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 33: XML Tag Listing
Callback <Action> (p. 230)

No details provided.

Tag

<Attributes> (p. 231)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 231)

No details provided. (inherited from SimEntity)

Callback <CanAdd> (p. 232)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <CanDuplicate> (p. 233)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

Callback <CanRemove> (p. 234)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Callback <GetCommands> (p. 235)

Callback that is invoked to collect all commands

to add to the solver input file.

Callback <GetNodalValuesForDisplay> (p. 236)

Callback that is invoked to get nodal values

associated with the load.

Callback <GetPostCommands> (p. 237)

Callback that is invoked to collect all "post"

commands to add to the solver input file.

228

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>
Callback <GetPreCommands> (p. 238)

Callback that is invoked to collect all "pre"

commands to add to the solver input file.

Callback <GetSolveCommands> (p. 239)

Callback that is invoked to collect all "solve"

commands to add to the solver input file.

Callback <IsValid> (p. 240)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 241)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGenerate> (p. 242)

Callback that is invoked after the generation is

completed.

Callback <OnAfterGeometryUpdate> (p. 243)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

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

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <OnDuplicate> (p. 245)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <OnGenerate> (p. 246)

Callback that is invoked when the load object is

generated.

Callback <OnGenerateData> (p. 247)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Callback <OnHide> (p. 248)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 249)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <OnMigrate> (p. 250)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 251)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <OnRemove> (p. 252)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <OnShow> (p. 253)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Callback <OnSuppress> (p. 254)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 255)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Tag

No details provided. (inherited from SimEntity)

<Property> (p. 256)

Attribute caption= (p. 257)

Caption of the object. (inherited from SimEntity)

Attribute class= (p. 258)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute color= (p. 259)

Color of the scoped entities.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

229

ACT XML Tags

Attribute contextual= (p. 260)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

Attribute icon= (p. 261)

Icon for the object. (inherited from SimEntity)

Attribute IsLoad= (p. 261)

Indicates whether the load object should be

considered as a load boundary.

Attribute IsSupport= (p. 262)

Indicates whether the load object should be

considered as a support boundary.

Attribute name= (p. 263)

Name of the object. (inherited from SimEntity)

Attribute unit= (p. 264)

Default unit used by the contour display.

Attribute version= (p. 265)

Version of the object. (inherited from SimEntity)

<Action>
No details provided.

Type
List_Action_

Remarks
None.

Examples
None.

Details
CallbackType
None.
Mandatory
False
Name
Action
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.

230

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

231

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

232

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

233

ACT XML Tags

Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Mandatory
False
Name
CanRemove

234

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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
Mandatory
False
Name
GetCommands
Public
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

235

ACT XML Tags

Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetNodeValues
Mandatory
False
Name
GetNodalValuesForDisplay
Public
True
Obsolete
False

236

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 26)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Mandatory
False
Name
GetPostCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="post".

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

237

ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 26)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Mandatory
False
Name
GetPreCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="pre".
ChildType
None.

238

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 26)

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

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Mandatory
False
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="solve".
ChildType
None.
MinOccurence
0

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

239

ACT XML Tags

MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

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

240

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>
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. 24)

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

Examples
None.

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

241

ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Mandatory
False
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

242

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

243

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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. 24)

244

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>

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. 24)

Remarks
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

245

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

246

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnGenerate
Mandatory
False
Name
OnGenerate
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

247

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. 24)

Remarks
None.

Examples
None.

248

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>

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. 24)

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

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

249

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. 24)

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

Examples
None.

250

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>

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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

251

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. 24)

Remarks
None.

Examples
None.

252

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

253

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. 24)

Remarks
None.

Examples
None.

254

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

255

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

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

Remarks
None.

Examples
None.

256

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>

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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

257

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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

Examples
None.

Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.

258

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>
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 2digit integer in hexadecimal for the blue part.<br />

Examples
Example 1: For example:<br /> White: #FFFFFF<br /> Black: #000000<br /> Red: #FF0000<br /> Green:
#00FF00<br /> Blue: #0000FF<br />

Details
Mandatory
False
Name
color
DefaultValue
#00ff00
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

259

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
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

260

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>

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

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

261

ACT XML Tags

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
IsLoad
DefaultValue
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

262

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
IsSupport
DefaultValue
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.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

263

ACT XML Tags

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

unit=
Default unit used by the contour display.

Type
System_String

Remarks
None.

Examples
None.

264

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Load>

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

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

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

265

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

<Object>
Class defining an object.

Remarks
None.

Examples
None.
Table 34: XML Tag Listing
Callback <Action> (p. 268)

No details provided.

Tag

<Attributes> (p. 269)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 269)

No details provided. (inherited from SimEntity)

Callback <CanAdd> (p. 270)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <CanDuplicate> (p. 271)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

Callback <CanRemove> (p. 272)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Callback <GetCommands> (p. 273)

Called to collect all commands to add to the solver

input file.

266

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>
Callback <GetNodalValuesForDisplay> (p. 274)

Called to get nodal values associated to the load.

Callback <GetPostCommands> (p. 275)

Called to collect all "post" commands to add to

the solver input file.

Callback <GetPreCommands> (p. 276)

Called to collect all "pre" commands to add to the

solver input file.

Callback <GetSolveCommands> (p. 277)

Called to collect all "solve" commands to add to

the solver input file.

Callback <IsValid> (p. 278)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 279)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGenerate> (p. 280)

Called when the generation is completed.

Callback <OnAfterGeometryUpdate> (p. 281)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

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

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <OnDuplicate> (p. 283)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <OnGenerate> (p. 284)

Called when the load object is generated.

Callback <OnGenerateData> (p. 285)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Callback <OnHide> (p. 286)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 287)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <OnMigrate> (p. 288)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 289)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <OnRemove> (p. 290)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <OnShow> (p. 291)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Callback <OnSuppress> (p. 292)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 293)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Tag

<Property> (p. 294)

No details provided. (inherited from SimEntity)

Tag

<Target> (p. 295)

Defines the target location for the object.

Attribute caption= (p. 296)

Caption of the object. (inherited from SimEntity)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

267

ACT XML Tags

Attribute class= (p. 296)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute color= (p. 297)

Color of scoped entities.

Attribute contextual= (p. 298)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

Attribute icon= (p. 299)

Icon for the object. (inherited from SimEntity)

Attribute IsLoad= (p. 300)

Indicates whether the load object should be

considered as a load boundary.

Attribute IsSupport= (p. 301)

Indicates whether the load object should be

considered as a support boundary.

Attribute name= (p. 302)

Name of the object. (inherited from SimEntity)

Attribute unit= (p. 303)

Default unit used by the contour display.

Attribute version= (p. 304)

Version of the object. (inherited from SimEntity)

<Action>
No details provided.

Type
List_Action_

Remarks
None.

Examples
None.

Details
CallbackType
None.
Mandatory
False
Name
Action
Public
False
Obsolete
False
ObsoleteMessage
None.

268

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

269

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

270

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

271

ACT XML Tags

Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Mandatory
False
Name
CanRemove

272

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetCommands
Mandatory
False
Name
GetCommands
Public
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

273

ACT XML Tags

Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetNodeValues
Mandatory
False
Name
GetNodalValuesForDisplay
Public
True
Obsolete
False

274

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 26)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Mandatory
False
Name
GetPostCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="post".

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

275

ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 26)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Mandatory
False
Name
GetPreCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="pre".
ChildType
None.

276

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 26)

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

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Mandatory
False
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="solve".
ChildType
None.
MinOccurence
0

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

277

ACT XML Tags

MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

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

278

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>
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. 24)

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

Examples
None.

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

279

ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnAfterGenerate>
Called when the generation is completed.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Mandatory
False
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

280

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

281

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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. 24)

282

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>

Remarks
None.

Examples
None.

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

283

ACT XML Tags

Examples
None.

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

<OnGenerate>
Called when the load object is generated.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

284

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnGenerate
Mandatory
False
Name
OnGenerate
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

286

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>

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. 24)

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

Examples
None.

Release 17.1 - SAS IP, 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_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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

Examples
None.

288

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>

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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

290

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

292

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

293

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

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

Remarks
None.

Examples
None.

294

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 731)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

295

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
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)

296

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

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

color=
Color of scoped entities.

Type
System_String

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

297

ACT XML Tags

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 2digit integer in hexadecimal for the blue part.<br />

Examples
Example 1: For example:<br /> White: #FFFFFF<br /> Black: #000000<br /> Red: #FF0000<br /> Green:
#00FF00<br /> Blue: #0000FF<br />

Details
Mandatory
False
Name
color
DefaultValue
#00ff00
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".

298

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<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

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

299

ACT XML Tags

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

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

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

300

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>
Name
IsLoad
DefaultValue
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.

Examples
None.

Details
Mandatory
False
Name
IsSupport
DefaultValue
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

301

ACT XML Tags

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.

Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.

302

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Object>
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
Mandatory
False
Name
unit
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

303

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
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.

304

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Optimizer>
Class defining an optimizer.

Remarks
None.

Examples
None.
Table 35: XML Tag Listing
Tag

<Attributes> (p. 309)

No details provided. (inherited from

SimEntity)

Tag

<Callbacks> (p. 309)

No details provided. (inherited from

SimEntity)

Callback <CanAdd> (p. 310)

Callback that is invoked to determine

whether the object can be added.
(inherited from SimEntity)

Callback <CanDuplicate> (p. 311)

Callback that is invoked to determine if

the object can be duplicated. (inherited
from SimEntity)

Callback <CanRemove> (p. 312)

Callback that is invoked to determine if

the object can be removed. (inherited
from SimEntity)

Callback <CanRun> (p. 313)

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. 314)

Callback that is invoked to return a

userreadable string summarizing the
current configuration of the optimizer
(or the sampling). (inherited from
DesignExplorer)

Callback <ConvergenceDescription> (p. 315)

Callback that is invoked to return a

DXConvergenceDescription object
describing the convergence data
provided.

Callback <Description> (p. 316)

Callback that is invoked to return a

user-readable string describing the
optimizer and its specific capabilities.
(inherited from DesignExplorer)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

305

ACT XML Tags

Callback <InputParametersEdited> (p. 317)

Callback that is invoked when the

properties of input parameters have
changed. (inherited from
DesignExplorer)

Callback <IsValid> (p. 318)

Callback that is invoked to determine if

the object is valid. (inherited from
SimEntity)

Callback <MethodPropertiesEdited> (p. 319)

Callback that is invoked when the

properties of the optimization method
have changed. (inherited from
DesignExplorer)

Callback <ObjectivesOrConstraintsEdited> (p. 320)

Callback that is invoked when the

definition of objectives or constraints
have changed.

Callback <OnAdd> (p. 320)

Callback that is invoked when the object

is newly added. (inherited from
SimEntity)

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 <OnCreate> (p. 324)

Callback that is invoked to provide an

instance of IOptimizationMethod (or
ISamplingMethod). (inherited from
DesignExplorer)

Callback <OnDuplicate> (p. 325)

Callback that is invoked when the object

is duplicated. (inherited from SimEntity)

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)

306

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>
Callback <OnRelease> (p. 331)

Callback that is invoked to release the

IOptimizationMethod (or the
ISamplingMethod) instance. (inherited
from DesignExplorer)

Callback <OnRemove> (p. 332)

Callback that is invoked when the object

is removed. (inherited from SimEntity)

Callback <OnShow> (p. 333)

Callback that is invoked when the object

is shown. (inherited from SimEntity)

Callback <OnSuppress> (p. 334)

Callback that is invoked when the object

is suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 335)

Callback that is invoked when the object

is unsuppressed. (inherited from
SimEntity)

Callback <ParameterRelationshipsEdited> (p. 336)

Callback that is invoked when the

definition of parameter relationships
have changed.

Tag

No details provided. (inherited from

SimEntity)

<Property> (p. 337)

Callback <QuickHelp> (p. 338)

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. 339)

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. 340)

True if the optimizer is only available in

the context of a Direct Optimization
component; false otherwise.

Attribute basedonresponsesurfaceonly= (p. 341)

True if the optimizer is only available in

the context of a Response Surface
component; false otherwise.

Attribute caption= (p. 342)

Caption of the object. (inherited from

SimEntity)

Attribute class= (p. 342)

Class name of the controller of the

object. (inherited from SimEntity)

Attribute constrainthandling= (p. 343)

Supports constraint handling.

Attribute constraintimportance= (p. 344)

Supports the Importance property of a

constraint.

Attribute constraintoninputparameter= (p. 345)

Supports constraints defined on an

input parameter.

Attribute contextual= (p. 346)

Indicates whether the object has to be

displayed in the contextual menu.
(inherited from SimEntity)

Attribute convergencedata= (p. 347)

Provides convergence data.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

307

ACT XML Tags

Attribute equaltoconstraint= (p. 348)

Supports the Equal To constraint type.

Attribute greaterthanconstraint= (p. 349)

Supports the Greater Than constraint

type.

Attribute historychartxaxistype= (p. 350)

Defines the X axis type for history charts.

Attribute icon= (p. 351)

Icon for the object. (inherited from

SimEntity)

Attribute insideboundsconstraint= (p. 351)

Supports the Inside Bounds constraint

type.

Attribute lessthanconstraint= (p. 352)

Supports the Less Than constraint type.

Attribute logfile= (p. 353)

Provides messages to generate a log file.

(inherited from DesignExplorer)

Attribute maximizeobjective= (p. 354)

Supports the Maximize objective type.

Attribute maximumnumberofconstraints= (p. 355)

Defines the maximum number of

constraints supported by the optimizer.

Attribute maximumnumberofdoublelistparameters= (p. 356) Indicates the maximum number of

double list parameters supported.
(inherited from DesignExplorer)
Attribute maximumnumberofdoubleparameters= (p. 357)

Indicates the maximum number of

double parameters supported. (inherited
from DesignExplorer)

Attribute maximumnumberofinputparameters= (p. 358)

Indicates the maximum number of input

parameters supported. (inherited from
DesignExplorer)

Attribute maximumnumberofintegerlistparameters= (p. 359) Indicates the maximum number of

integer list parameters supported.
(inherited from DesignExplorer)
Attribute maximumnumberofobjectives= (p. 360)

Defines the maximum number of

objectives supported by the optimizer.

Attribute minimizeobjective= (p. 360)

Supports the Minimize objective type.

Attribute minimumnumberofconstraints= (p. 361)

Defines the minimum number of

constraints required.

Attribute minimumnumberofobjectives= (p. 362)

Defines the minimum number of

objectives required.

Attribute name= (p. 363)

Name of the object. (inherited from

SimEntity)

Attribute objectiveimportance= (p. 364)

Supports the Importance property of an

objective.

Attribute objectiveoninputparameter= (p. 365)

Supports objectives defined on an Input

Parameter.

Attribute parameterrelationship= (p. 366)

Supports parameter relationships.

Attribute seekobjective= (p. 367)

Supports the Seek objective type.

Attribute startingpointrequired= (p. 368)

Requires a Starting Point.

Attribute version= (p. 369)

Version of the object. (inherited from

SimEntity)

308

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

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. 31)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

309

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False

310

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>
ObsoleteMessage
None.
ChildType
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.

Release 17.1 - SAS IP, 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
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.

312

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<CanRun>
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)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__bool_
Mandatory
False
Name
CanRun
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
Release 17.1 - SAS IP, 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
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_
Mandatory
False
Name
Configuration
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1

314

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__object_
Mandatory
False
Name
ConvergenceDescription
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

315

ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Description>
Callback that is invoked to return a user-readable string describing the optimizer and its specific capabilities. (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_
Mandatory
False
Name
Description
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

316

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

<InputParametersEdited>
Callback that is invoked when the properties of input parameters have changed. (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
InputParametersEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

317

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. 24)

Remarks
None.

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

318

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

<MethodPropertiesEdited>
Callback that is invoked when the properties of the optimization method have changed. (inherited from
DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
MethodPropertiesEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

319

ACT XML Tags

<ObjectivesOrConstraintsEdited>
Callback that is invoked when the definition of objectives or constraints have changed.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
ObjectivesOrConstraintsEdited
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)

320

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

Examples
None.

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. 24)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

321

ACT XML Tags

Remarks
None.

Examples
None.

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. 24)

Remarks
None.

322

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

Examples
None.

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. 24)

Remarks
None.

Examples
None.
Release 17.1 - SAS IP, 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
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

<OnCreate>
Callback that is invoked to provide an instance of IOptimizationMethod (or ISamplingMethod). (inherited
from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

324

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

Details
CallbackType
FuncCallback_IUserObject__object_
Mandatory
False
Name
OnCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

326

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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
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. 24)

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

Examples
None.

328

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

Examples
None.

Release 17.1 - SAS IP, 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
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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

330

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

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

<OnRelease>
Callback that is invoked to release the IOptimizationMethod (or the ISamplingMethod) instance. (inherited
from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

331

ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
OnRelease
Public
True
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. 24)

Remarks
None.

Examples
None.

332

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

334

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

335

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

<ParameterRelationshipsEdited>
Callback that is invoked when the definition of parameter relationships have changed.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

336

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
ParameterRelationshipsEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

337

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_
Mandatory
False
Name
QuickHelp
Public
True
Obsolete
False

338

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_
Mandatory
False
Name
Status
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

339

ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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
Mandatory
False
Name
basedondirectoptimizationonly
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.

340

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>
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
Mandatory
False
Name
basedonresponsesurfaceonly
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

341

ACT XML Tags

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.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

342

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes two arguments:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

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

constrainthandling=
Supports constraint handling.

Type
System_Boolean

Release 17.1 - SAS IP, 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
Mandatory
False
Name
constrainthandling
DefaultValue
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

Remarks
None.

344

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

Examples
None.

Details
Mandatory
False
Name
constraintimportance
DefaultValue
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.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

345

ACT XML Tags

Details
Mandatory
False
Name
constraintoninputparameter
DefaultValue
True
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
Mandatory
False

346

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>
Name
contextual
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
Mandatory
False
Name
convergencedata
DefaultValue
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

347

ACT XML Tags

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
Mandatory
False
Name
equaltoconstraint
DefaultValue
True
DataDefinition
False
AllowedValues
None.

348

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>
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
Mandatory
False
Name
greaterthanconstraint
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

349

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
Mandatory
False
Name
historychartxaxistype
DefaultValue
bypoint
DataDefinition
False
AllowedValues
System.String[]
MultipleValue
False
MappedValues
None.
Public
True
Description
None.

350

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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
Mandatory
False
Name
icon
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

351

ACT XML Tags

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
insideboundsconstraint
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

352

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
lessthanconstraint
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

353

ACT XML Tags

Examples
None.

Details
Mandatory
False
Name
logfile
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.

354

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

Details
Mandatory
False
Name
maximizeobjective
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
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

355

ACT XML Tags

Name
maximumnumberofconstraints
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
Mandatory
False
Name
maximumnumberofdoublelistparameters
DefaultValue
100

356

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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
Mandatory
False
Name
maximumnumberofdoubleparameters
DefaultValue
100
DataDefinition
False
AllowedValues
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

357

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
Mandatory
False
Name
maximumnumberofinputparameters
DefaultValue
100
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.

358

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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
Mandatory
False
Name
maximumnumberofintegerlistparameters
DefaultValue
100
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

359

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
Mandatory
False
Name
maximumnumberofobjectives
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.

360

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
minimizeobjective
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

361

ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
minimumnumberofconstraints
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.

362

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>

Examples
None.

Details
Mandatory
False
Name
minimumnumberofobjectives
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

363

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

objectiveimportance=
Supports the Importance property of an objective.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

364

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Optimizer>
Name
objectiveimportance
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
Mandatory
False
Name
objectiveoninputparameter
DefaultValue
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

365

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
Mandatory
False
Name
parameterrelationship
DefaultValue
False
DataDefinition
False
AllowedValues
None.

366

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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
Mandatory
False
Name
seekobjective
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

367

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
Mandatory
False
Name
startingpointrequired
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.

368

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

369

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 36: XML Tag Listing
Attribute order= (p. 370) The order "priority". The lower the order, the earlier the
execution.

order=
The order "priority". The lower the order, the earlier the execution.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
order
DefaultValue
0
DataDefinition
False
AllowedValues
None.
MultipleValue
False

370

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<output>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Remarks
None.

Examples
None.
Table 37: XML Tag Listing
Attribute format= (p. 371) Connection format type. (inherited from
IOItem)
Attribute type= (p. 372)

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

371

ACT XML Tags

Name
format
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.

372

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<outputfile>
DataDefinition
False
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 38: XML Tag Listing
Attribute id= (p. 373)

The unique file id. (inherited

from File)

Attribute name= (p. 374) The file name. (inherited from

File)

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

Type
System_String

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

373

ACT XML Tags

Examples
None.

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.

374

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<outputs>

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

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

Remarks
None.

Examples
None.
Table 39: XML Tag Listing
Tag <Output> (p. 375) No details
provided.

<Output>
No details provided.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

375

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Output (p. 371)

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 40: XML Tag Listing
Tag

<Callbacks> (p. 377)

Callback <OnPanelHidden> (p. 377)

Specifies the callbacks that will invoke functions from the

IronPython extension script. (Inherited from SimEntity)
Callback that is invoked when the panel is hidden.

Callback <OnPanelInitialized> (p. 378) Callback that is invoked when the panel is initialized.
Callback <OnPanelShown> (p. 379)

Callback that is invoked when the panel is shown.

Attribute class= (p. 380)

Class name of the controller of the object.

376

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Panel>
Attribute layout= (p. 381)

Layout of the panel.

Attribute name= (p. 382)

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. 31)

Remarks
None.

Examples
None.

Details
ChildType
None.
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. 24)

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

377

ACT XML Tags

Examples
None.

Details
CallbackType
ActionCallback_IPanel_
Mandatory
False
Name
OnPanelHidden
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnPanelInitialized>
Callback that is invoked when the panel is initialized.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

378

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Panel>

Details
CallbackType
ActionCallback_IPanel_
Mandatory
False
Name
OnPanelInitialized
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnPanelShown>
Callback that is invoked when the panel is shown.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

379

ACT XML Tags

Details
CallbackType
ActionCallback_IPanel_
Mandatory
False
Name
OnPanelShown
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

class=
Class name of the controller of the object.

Type
System_String

Remarks
None.

Examples
None.

380

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Panel>

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

layout=
Layout of the panel.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

381

ACT XML Tags

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

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True
Name
name
DefaultValue
None.

382

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

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

Examples
None.
Table 41: XML Tag Listing
Tag

<Attributes> (p. 384)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 385)

No details provided. (inherited from SimEntity)

Callback <CanAdd> (p. 386)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <CanDuplicate> (p. 387)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

Callback <CanRemove> (p. 388)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Callback <IsValid> (p. 388)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 389)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGeometryUpdate> (p. 390)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

Callback <OnBodySuppressStateChange> (p. 391) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

383

ACT XML Tags

Callback <OnClearData> (p. 392)

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <OnDuplicate> (p. 393)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <OnGenerateData> (p. 394)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Callback <OnHide> (p. 395)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 396)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <OnMigrate> (p. 397)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 398)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <OnRemove> (p. 399)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <OnShow> (p. 400)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Callback <OnSuppress> (p. 401)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 402)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Tag

No details provided. (inherited from SimEntity)

<Property> (p. 403)

Attribute caption= (p. 404)

Caption of the object. (inherited from SimEntity)

Attribute class= (p. 405)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute contextual= (p. 406)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

Attribute control= (p. 407)

Underlying data type of the parameter.

Attribute icon= (p. 407)

Icon for the object. (inherited from SimEntity)

Attribute name= (p. 408)

Name of the object. (inherited from SimEntity)

Attribute usage= (p. 409)

Usage of the parameter.

Attribute version= (p. 410)

Version of the object. (inherited from SimEntity)

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

Remarks
None.

384

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameter>

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. 31)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

385

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

386

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameter>
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. 24)

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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

387

ACT XML Tags

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

388

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameter>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

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. 24)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

389

ACT XML Tags

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

Examples
None.

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. 24)

Remarks
None.

390

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameter>

Examples
None.

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. 24)

Remarks
None.

Examples
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

391

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

392

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameter>

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

393

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. 24)

Remarks
None.

Examples
None.

394

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameter>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

395

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. 24)

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

Examples
None.

396

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameter>

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

397

ACT XML Tags

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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

398

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameter>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

399

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

400

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameter>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

401

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

402

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameter>

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

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

403

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.

404

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

Examples
None.

Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

405

ACT XML Tags

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

406

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameter>
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

icon=
Icon for the object. (inherited from SimEntity)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

407

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

408

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameter>

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

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

409

ACT XML Tags

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.

Examples
None.

410

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<parameters>

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 42: XML Tag Listing
Tag <Parameter> (p. 411) No details
provided.

<Parameter>
No details provided.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

411

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Parameter (p. 383)

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 43: XML Tag Listing
Attribute name= (p. 413) The platform name. May be "Win64" or
"Linux64"
Attribute path= (p. 413)

412

The platform-supported path (e.g., to an

exe)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<platform>

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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

413

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

<program>
This class defines the Program XML Tag.

Remarks
None.

414

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<program>

Examples
None.
Table 44: XML Tag Listing
Tag <Argument> (p. 415) The program's command-line
arguments.
Tag <Platform> (p. 415)

The program's supported platforms.

<Argument>
The program's command-line arguments.

Type
Ansys_ACT_Core_XmlDataModel_Argument (p. 17)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Argument
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Platform>
The program's supported platforms.

Type
Ansys_ACT_Core_XmlDataModel_Platform (p. 412)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

415

ACT XML Tags

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.

Examples
None.
Table 45: XML Tag Listing
Tag <DataEntity> (p. 416) No details
provided.

<DataEntity>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_DataEntity (p. 65)

416

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>

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.

Examples
None.
Table 46: XML Tag Listing
Tag

<Attributes> (p. 419)

No details provided. (inherited from PropertyBase)

Tag

<Callbacks> (p. 420)

No details provided. (inherited from PropertyBase)

Callback <GetValue> (p. 421)

Callback that is invoked when the property value

is acquired. (inherited from PropertyBase)

Tag

No details provided. (inherited from PropertyBase)

<help> (p. 422)

Callback <IsValid> (p. 422)

Callback that is invoked to determine whether the

property is valid. (inherited from PropertyBase)

Callback <IsVisible> (p. 423)

Callback that is invoked to determine whether the

property is visible. (inherited from PropertyBase)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

417

ACT XML Tags

Callback <OnActivate> (p. 424)

Callback that is invoked when the property is

activated. (inherited from PropertyBase)

Callback <OnAdd> (p. 425)

Callback that is invoked when the property is

added. (inherited from PropertyBase)

Callback <OnAfterGeometryUpdate> (p. 426)

Callback that is invoked after the geometry has

been updated. (inherited from PropertyBase)

Callback <OnApply> (p. 427)

Callback that is invoked when the property apply

button is clicked. (inherited from PropertyBase)

Callback <OnBodySuppressStateChange> (p. 428) Callback that is invoked when the body suppress
state change. (inherited from PropertyBase)
Callback <OnCancel> (p. 429)

Callback that is invoked when the property cancel

button is clicked. (inherited from PropertyBase)

Callback <OnDuplicate> (p. 430)

Callback that is invoked when the property is

duplicated. (inherited from PropertyBase)

Callback <OnHide> (p. 431)

Callback that is invoked when the property is

hidden. (inherited from PropertyBase)

Callback <OnInit> (p. 432)

Callback that is invoked when the property is

initialized. (inherited from PropertyBase)

Callback <OnJournalExecuting> (p. 433)

Callback that is invoked before executing an action

written in the journal. (inherited from
PropertyBase)

Callback <OnJournalRecording> (p. 433)

Callback that is invoked before writting the journal

for an action. (inherited from PropertyBase)

Callback <OnMigrate> (p. 434)

Callback that is invoked when the property version

has been changed. (inherited from PropertyBase)

Callback <OnRemove> (p. 435)

Callback that is invoked when the property is

removed. (inherited from PropertyBase)

Callback <OnShow> (p. 436)

Callback that is invoked when the property is

shown. (inherited from PropertyBase)

Callback <OnValidate> (p. 437)

Callback that is invoked when the property is

validated. (inherited from PropertyBase)

Callback <SetValue> (p. 438)

Callback that is invoked when the property value

is set. (inherited from PropertyBase)

Callback <String2Value> (p. 439)

Callback that is invoked to convert a string to the

property value. (inherited from PropertyBase)

Callback <Value2String> (p. 440)

Callback that is invoked to convert the value

stored by the property into a string. (inherited
from PropertyBase)

Attribute caption= (p. 441)

Caption of the property. (inherited from

PropertyBase)

Attribute class= (p. 442)

Class name of the property's controller. (inherited

from PropertyBase)

Attribute control= (p. 443)

Control type of the object.

Attribute default= (p. 444)

Default value of the property. (inherited from

PropertyBase)

418

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>
Attribute elementtype= (p. 445)

Property list element type (workflow). (inherited

from PropertyBase)

Attribute isparameter= (p. 446)

Indicates whether the property is a parameter.

(inherited from PropertyBase)

Attribute keytype= (p. 447)

Property dictionary key type (workflow). (inherited

from PropertyBase)

Attribute name= (p. 447)

Name of the property. (inherited from

PropertyBase)

Attribute needupdate= (p. 448)

Indicates whether the context must be refreshed

when the property value changes. (inherited from
PropertyBase)

Attribute parameterizable= (p. 449)

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. 450)

Specifies the property persistence (workflow).

Indicates whether the property data should be
saved within the project. (inherited from
PropertyBase)

Attribute readonly= (p. 451)

Indicates whether the property is read-only.

(inherited from PropertyBase)

Attribute unit= (p. 452)

Unit type of the property (for 'control' equals to

'float' only). (inherited from PropertyBase)

Attribute valuetype= (p. 453)

Property dictionary value type (workflow).

(inherited from PropertyBase)

Attribute visible= (p. 454)

Indicates whether the property is visible. (inherited

from PropertyBase)

Attribute visibleon= (p. 455)

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. 23)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

419

ACT XML Tags

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. 31)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False

420

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>
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. 24)

Remarks
This callback is useful for transforming the stored property value.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue
Mandatory
False
Name
GetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

421

ACT XML Tags

<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)
Public
True
Name
help
ValueName
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid

422

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>
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

<IsVisible>
Callback that is invoked to determine whether the property is visible. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

423

ACT XML Tags

Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnActivate

424

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>
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 property is added. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
Mandatory
False
Name
OnAdd
Public
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

425

ACT XML Tags

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 after the geometry has been updated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Mandatory
False
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False

426

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

427

ACT XML Tags

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 change. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Mandatory
False
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.

428

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

429

ACT XML Tags

MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1

430

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

431

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
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

432

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>

<OnJournalExecuting>
Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Mandatory
False
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnJournalRecording>
Callback that is invoked before writting the journal for an action. (inherited from PropertyBase)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

433

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Mandatory
False
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

434

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>

Remarks
This callback allows the migration of data from the old saved property to the new one.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnPropertyMigrate
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

<OnRemove>
Callback that is invoked when the property is removed. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

435

ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
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 property is shown. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

436

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
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

<OnValidate>
Callback that is invoked when the property is validated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

437

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
This callback is useful for transforming the submitted property value.

Examples
None.

438

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue
Mandatory
False
Name
SetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

439

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_String2Value
Mandatory
False
Name
String2Value
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

440

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>

Details
CallbackType
Ansys_ACT_Core_Callbacks_Value2String
Mandatory
False
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

caption=
Caption of the property. (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

441

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 property's controller. (inherited from PropertyBase)

Type
System_String

Remarks
The constructor of the class referenced by this attribute takes three arguments:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The load associated to the property (of type IUserObject)</li><li>The associated property (of type ISimProperty)</li></ul>

Examples
None.

Details
Mandatory
False

442

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>
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
Name
control
DefaultValue
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

443

ACT XML Tags

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.
DataDefinition
False
AllowedValues
None.

444

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>
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.
MultipleValue
False
MappedValues
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

445

ACT XML Tags

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.
Public
True
Description
None.

446

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>
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.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the property. (inherited from PropertyBase)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

447

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

needupdate=
Indicates whether the context must be refreshed when the property value changes. (inherited from
PropertyBase)

Type
System_Boolean

448

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>

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 PropertyBase)

Type
System_Boolean

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

449

ACT XML Tags

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

Remarks
None.

Examples
None.

450

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>

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.

Examples
None.

Details
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

451

ACT XML Tags

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.

Details
Mandatory
False
Name
unit
DefaultValue
None.

452

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>
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
Name
valuetype
DefaultValue
None.
DataDefinition
False
AllowedValues
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

453

ACT XML Tags

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
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.

454

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<property>
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.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

455

ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<propertygroup>
Class defining a collection of properties.

Remarks
None.

Examples
None.
Table 47: XML Tag Listing
Tag

<Attributes> (p. 458)

No details provided. (inherited from PropertyBase)

Tag

<Callbacks> (p. 458)

No details provided. (inherited from PropertyBase)

Callback <GetValue> (p. 459)

Callback that is invoked when the property value

is acquired. (inherited from PropertyBase)

Tag

No details provided. (inherited from PropertyBase)

<help> (p. 460)

Callback <IsValid> (p. 461)

Callback that is invoked to determine whether the

property is valid. (inherited from PropertyBase)

Callback <IsVisible> (p. 462)

Callback that is invoked to determine whether the

property is visible. (inherited from PropertyBase)

Callback <OnActivate> (p. 463)

Callback that is invoked when the property is

activated. (inherited from PropertyBase)

Callback <OnAdd> (p. 464)

Callback that is invoked when the property is

added. (inherited from PropertyBase)

Callback <OnAfterGeometryUpdate> (p. 464)

Callback that is invoked after the geometry has

been updated. (inherited from PropertyBase)

Callback <OnApply> (p. 465)

Callback that is invoked when the property apply

button is clicked. (inherited from PropertyBase)

Callback <OnBodySuppressStateChange> (p. 466) Callback that is invoked when the body suppress
state change. (inherited from PropertyBase)
Callback <OnCancel> (p. 467)

Callback that is invoked when the property cancel

button is clicked. (inherited from PropertyBase)

Callback <OnDuplicate> (p. 468)

Callback that is invoked when the property is

duplicated. (inherited from PropertyBase)

Callback <OnHide> (p. 469)

Callback that is invoked when the property is

hidden. (inherited from PropertyBase)

Callback <OnInit> (p. 470)

Callback that is invoked when the property is

initialized. (inherited from PropertyBase)

Callback <OnJournalExecuting> (p. 471)

Callback that is invoked before executing an action

written in the journal. (inherited from
PropertyBase)

456

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>
Callback <OnJournalRecording> (p. 472)

Callback that is invoked before writting the journal

for an action. (inherited from PropertyBase)

Callback <OnMigrate> (p. 473)

Callback that is invoked when the property version

has been changed. (inherited from PropertyBase)

Callback <OnRemove> (p. 474)

Callback that is invoked when the property is

removed. (inherited from PropertyBase)

Callback <OnShow> (p. 475)

Callback that is invoked when the property is

shown. (inherited from PropertyBase)

Callback <OnValidate> (p. 476)

Callback that is invoked when the property is

validated. (inherited from PropertyBase)

Tag

No details provided.

<PropertyGroup> (p. 477)

Callback <SetValue> (p. 478)

Callback that is invoked when the property value

is set. (inherited from PropertyBase)

Callback <String2Value> (p. 479)

Callback that is invoked to convert a string to the

property value. (inherited from PropertyBase)

Callback <Value2String> (p. 480)

Callback that is invoked to convert the value

stored by the property into a string. (inherited
from PropertyBase)

Attribute caption= (p. 481)

Caption of the property. (inherited from

PropertyBase)

Attribute class= (p. 482)

Class name of the property's controller. (inherited

from PropertyBase)

Attribute control= (p. 483)

Control type of the object.

Attribute default= (p. 483)

Default value of the property. (inherited from

PropertyBase)

Attribute display= (p. 484)

Display type of the property group.

Attribute elementtype= (p. 485)

Property list element type (workflow). (inherited

from PropertyBase)

Attribute isparameter= (p. 486)

Indicates whether the property is a parameter.

(inherited from PropertyBase)

Attribute keytype= (p. 487)

Property dictionary key type (workflow). (inherited

from PropertyBase)

Attribute name= (p. 488)

Name of the property. (inherited from

PropertyBase)

Attribute needupdate= (p. 489)

Indicates whether the context must be refreshed

when the property value changes. (inherited from
PropertyBase)

Attribute parameterizable= (p. 490)

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. 491)

Specifies the property persistence (workflow).

Indicates whether the property data should be
saved within the project. (inherited from
PropertyBase)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

457

ACT XML Tags

Attribute readonly= (p. 492)

Indicates whether the property is read-only.

(inherited from PropertyBase)

Attribute unit= (p. 493)

Unit type of the property (for 'control' equals to

'float' only). (inherited from PropertyBase)

Attribute valuetype= (p. 493)

Property dictionary value type (workflow).

(inherited from PropertyBase)

Attribute visible= (p. 494)

Indicates whether the property is visible. (inherited

from PropertyBase)

Attribute visibleon= (p. 495)

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. 23)

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)
458

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

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. 24)

Remarks
This callback is useful for transforming the stored property value.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

459

ACT XML Tags

Mandatory
False
Name
GetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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)
Public
True

460

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>
Name
help
ValueName
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

461

ACT XML Tags

RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible
Mandatory
False
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

462

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnActivate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

463

ACT XML Tags

<OnAdd>
Callback that is invoked when the property is added. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
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 after the geometry has been updated. (inherited from PropertyBase)

464

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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

<OnApply>
Callback that is invoked when the property apply button is clicked. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

465

ACT XML Tags

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnApply
Public
True
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 change. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

466

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>

Examples
None.

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

<OnCancel>
Callback that is invoked when the property cancel button is clicked. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

467

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

468

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
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

<OnHide>
Callback that is invoked when the property is hidden. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

469

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
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 property is initialized. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

470

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
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

<OnJournalExecuting>
Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

471

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Mandatory
False
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

472

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Mandatory
False
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
This callback allows the migration of data from the old saved property to the new one.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

473

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnPropertyMigrate
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

<OnRemove>
Callback that is invoked when the property is removed. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

474

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
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 property is shown. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

475

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
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

<OnValidate>
Callback that is invoked when the property is validated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

476

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<PropertyGroup>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_PropertyGroup (p. 456)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

477

ACT XML Tags

Details
ChildType
Ansys_ACT_Core_XmlDataModel_PropertyGroup
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. 24)

Remarks
This callback is useful for transforming the submitted property value.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue
Mandatory
False
Name
SetValue
Public
True
Obsolete
False

478

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_String2Value
Mandatory
False
Name
String2Value
Public
True
Obsolete
False
ObsoleteMessage
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

479

ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_Value2String
Mandatory
False
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.

480

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

caption=
Caption of the property. (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

481

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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The load associated to the property (of type IUserObject)</li><li>The associated property (of type ISimProperty)</li></ul>

Examples
None.

Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.

482

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

control=
Control type of the object.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
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)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

483

ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
default
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

484

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
display
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

485

ACT XML Tags

Examples
None.

Details
Mandatory
False
Name
elementtype
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.

486

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>

Details
Mandatory
False
Name
isparameter
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
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

487

ACT XML Tags

Name
keytype
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
Mandatory
True
Name
name
DefaultValue
None.

488

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>
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
Mandatory
False
Name
needupdate
DefaultValue
True
DataDefinition
False
AllowedValues
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

489

ACT XML Tags

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 PropertyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
parameterizable
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False

490

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>
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
Mandatory
False
Name
persistent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

491

ACT XML Tags

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
Mandatory
False
Name
readonly
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

492

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>

unit=
Unit type of the property (for 'control' equals to 'float' only). (inherited from PropertyBase)

Type
System_String

Remarks
None.

Examples
None.

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)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

493

ACT XML Tags

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
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

494

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertygroup>

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
visible
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

495

ACT XML Tags

Examples
None.

Details
Mandatory
False
Name
visibleon
DefaultValue
None.
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.

Examples
None.
Table 48: XML Tag Listing
Tag

<Attributes> (p. 499)

No details provided. (inherited from PropertyBase)

Tag

<Callbacks> (p. 499)

No details provided. (inherited from PropertyBase)

496

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>
Callback <GetValue> (p. 500)

Callback that is invoked when the property value

is acquired. (inherited from PropertyBase)

Tag

No details provided. (inherited from PropertyBase)

<help> (p. 501)

Callback <IsValid> (p. 501)

Callback that is invoked to determine whether the

property is valid. (inherited from PropertyBase)

Callback <IsVisible> (p. 502)

Callback that is invoked to determine whether the

property is visible. (inherited from PropertyBase)

Callback <OnActivate> (p. 503)

Callback that is invoked when the property is

activated. (inherited from PropertyBase)

Callback <OnAdd> (p. 504)

Callback that is invoked when the property is

added. (inherited from PropertyBase)

Callback <OnAfterGeometryUpdate> (p. 505)

Callback that is invoked after the geometry has

been updated. (inherited from PropertyBase)

Callback <OnApply> (p. 506)

Callback that is invoked when the property apply

button is clicked. (inherited from PropertyBase)

Callback <OnBodySuppressStateChange> (p. 507) Callback that is invoked when the body suppress
state change. (inherited from PropertyBase)
Callback <OnCancel> (p. 508)

Callback that is invoked when the property cancel

button is clicked. (inherited from PropertyBase)

Callback <OnDuplicate> (p. 509)

Callback that is invoked when the property is

duplicated. (inherited from PropertyBase)

Callback <OnHide> (p. 510)

Callback that is invoked when the property is

hidden. (inherited from PropertyBase)

Callback <OnInit> (p. 511)

Callback that is invoked when the property is

initialized. (inherited from PropertyBase)

Callback <OnJournalExecuting> (p. 512)

Callback that is invoked before executing an action

written in the journal. (inherited from
PropertyBase)

Callback <OnJournalRecording> (p. 513)

Callback that is invoked before writting the journal

for an action. (inherited from PropertyBase)

Callback <OnMigrate> (p. 514)

Callback that is invoked when the property version

has been changed. (inherited from PropertyBase)

Callback <OnRemove> (p. 515)

Callback that is invoked when the property is

removed. (inherited from PropertyBase)

Callback <OnShow> (p. 516)

Callback that is invoked when the property is

shown. (inherited from PropertyBase)

Callback <OnValidate> (p. 517)

Callback that is invoked when the property is

validated. (inherited from PropertyBase)

Tag

No details provided.

<PropertyGroup> (p. 518)

Callback <SetValue> (p. 519)

Callback that is invoked when the property value

is set. (inherited from PropertyBase)

Callback <String2Value> (p. 520)

Callback that is invoked to convert a string to the

property value. (inherited from PropertyBase)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

497

ACT XML Tags

Callback <Value2String> (p. 521)

Callback that is invoked to convert the value

stored by the property into a string. (inherited
from PropertyBase)

Attribute allowempty= (p. 522)

Unit type of the property (for float control).

Attribute caption= (p. 523)

Caption of the property. (inherited from

PropertyBase)

Attribute class= (p. 524)

Class name of the property's controller. (inherited

from PropertyBase)

Attribute control= (p. 524)

Control type of the object.

Attribute default= (p. 525)

Default value of the property. (inherited from

PropertyBase)

Attribute display= (p. 526)

Display type of the property group.

Attribute elementtype= (p. 527)

Property list element type (workflow). (inherited

from PropertyBase)

Attribute isparameter= (p. 528)

Indicates whether the property is a parameter.

(inherited from PropertyBase)

Attribute keytype= (p. 529)

Property dictionary key type (workflow). (inherited

from PropertyBase)

Attribute name= (p. 530)

Name of the property. (inherited from

PropertyBase)

Attribute needupdate= (p. 531)

Indicates whether the context must be refreshed

when the property value changes. (inherited from
PropertyBase)

Attribute parameterizable= (p. 532)

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. 533)

Specifies the property persistence (workflow).

Indicates whether the property data should be
saved within the project. (inherited from
PropertyBase)

Attribute readonly= (p. 534)

Indicates whether the property is read-only.

(inherited from PropertyBase)

Attribute unit= (p. 534)

Unit type of the property (for 'control' equals to

'float' only). (inherited from PropertyBase)

Attribute valuetype= (p. 535)

Property dictionary value type (workflow).

(inherited from PropertyBase)

Attribute visible= (p. 536)

Indicates whether the property is visible. (inherited

from PropertyBase)

Attribute visibleon= (p. 537)

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)

498

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

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. 31)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

499

ACT XML Tags

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. 24)

Remarks
This callback is useful for transforming the stored property value.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue
Mandatory
False
Name
GetValue
Public
True
Obsolete
False

500

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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)
Public
True
Name
help
ValueName
None.
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

<IsValid>
Callback that is invoked to determine whether the property is valid. (inherited from PropertyBase)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

501

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid
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

<IsVisible>
Callback that is invoked to determine whether the property is visible. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

502

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible
Mandatory
False
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

503

ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnActivate
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 property is added. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

504

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
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 after the geometry has been updated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

505

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

<OnApply>
Callback that is invoked when the property apply button is clicked. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

506

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnApply
Public
True
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 change. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

507

ACT XML Tags

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

<OnCancel>
Callback that is invoked when the property cancel button is clicked. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

508

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_OnInitProp
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

<OnHide>
Callback that is invoked when the property is hidden. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

510

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
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 property is initialized. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

511

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
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

<OnJournalExecuting>
Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

512

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Mandatory
False
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

513

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Mandatory
False
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
This callback allows the migration of data from the old saved property to the new one.

Examples
None.

514

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnPropertyMigrate
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

<OnRemove>
Callback that is invoked when the property is removed. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

515

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
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 property is shown. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

516

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
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

<OnValidate>
Callback that is invoked when the property is validated. (inherited from PropertyBase)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

517

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<PropertyGroup>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_PropertyGroup (p. 456)

Remarks
None.

Examples
None.

518

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Details
ChildType
Ansys_ACT_Core_XmlDataModel_PropertyGroup
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. 24)

Remarks
This callback is useful for transforming the submitted property value.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue
Mandatory
False
Name
SetValue
Public
True
Obsolete
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

519

ACT XML Tags

ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_String2Value
Mandatory
False
Name
String2Value
Public
True
Obsolete
False
ObsoleteMessage
None.

520

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_Value2String
Mandatory
False
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

521

ACT XML Tags

MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

allowempty=
Unit type of the property (for float control).

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
allowempty
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True

522

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

caption=
Caption of the property. (inherited from PropertyBase)

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

523

ACT XML Tags

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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The load associated to the property (of type IUserObject)</li><li>The associated property (of type ISimProperty)</li></ul>

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

control=
Control type of the object.

524

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

525

ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
default
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

Remarks
None.

526

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Examples
None.

Details
Mandatory
False
Name
display
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.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

527

ACT XML Tags

Details
Mandatory
False
Name
elementtype
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.

Details
Mandatory
False

528

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>
Name
isparameter
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
Mandatory
False
Name
keytype
DefaultValue
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

529

ACT XML Tags

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
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.

530

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>
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
Mandatory
False
Name
needupdate
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

531

ACT XML Tags

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 PropertyBase)

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
parameterizable
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True

532

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>
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
Mandatory
False
Name
persistent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

533

ACT XML Tags

readonly=
Indicates whether the property is read-only. (inherited from PropertyBase)

Type
System_Boolean

Remarks
None.

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)

534

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Type
System_String

Remarks
None.

Examples
None.

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

535

ACT XML Tags

Remarks
None.

Examples
None.

Details
Mandatory
False
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.

536

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<propertytable>

Examples
None.

Details
Mandatory
False
Name
visible
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.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

537

ACT XML Tags

Details
Mandatory
False
Name
visibleon
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 49: XML Tag Listing
Callback <Action> (p. 540)

No details provided.

Tag

<Attributes> (p. 541)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 542)

No details provided. (inherited from SimEntity)

Callback <CanAdd> (p. 542)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <CanDuplicate> (p. 543)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

538

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>
Callback <CanRemove> (p. 544)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Callback <Evaluate> (p. 545)

Callback that is invoked when the step described

by stepInfo is evaluated.

Callback <GetFieldCount> (p. 546)

Callback that is invoked to get the number of fields

for a given element or node ID.

Callback <GetValue> (p. 547)

Callback that is invoked to get the values

associated to a node or an element given by its
ID.

Callback <IsValid> (p. 548)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 549)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGeometryUpdate> (p. 550)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

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

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <OnDuplicate> (p. 553)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <OnEndEval> (p. 554)

Callback that is invoked at the end of the

evaluation process for a given step.

Callback <OnEndPost> (p. 555)

Callback that is invoked at the end of the post

process.

Callback <OnGenerateData> (p. 556)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Callback <OnHide> (p. 557)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 558)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <OnMigrate> (p. 559)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 560)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <OnRemove> (p. 561)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <OnShow> (p. 562)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Callback <OnStartEval> (p. 563)

Callback that is invoked when the evaluation

process for a given step starts.

Callback <OnStartPost> (p. 564)

Callback that is invoked when the post process

starts.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

539

ACT XML Tags

Callback <OnSuppress> (p. 565)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 566)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Tag

No details provided. (inherited from SimEntity)

<Property> (p. 567)

Attribute averaging= (p. 568)

Averaging of the result.

Attribute caption= (p. 569)

Caption of the object. (inherited from SimEntity)

Attribute class= (p. 570)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute contextual= (p. 571)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

Attribute hasimaginary= (p. 571)

Indicates whether the result supports imaginary

values.

Attribute icon= (p. 572)

Icon for the object. (inherited from SimEntity)

Attribute location= (p. 573)

Location of the result.

Attribute name= (p. 574)

Name of the object. (inherited from SimEntity)

Attribute timehistory= (p. 575)

Indicates whether the time history has to be

calculated.

Attribute type= (p. 576)

Type of the result.

Attribute unit= (p. 577)

Unit used by the contour display.

Attribute version= (p. 578)

Version of the object. (inherited from SimEntity)

<Action>
No details provided.

Type
List_Action_

Remarks
None.

Examples
None.

Details
CallbackType
None.
Mandatory
False
Name
Action

540

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

541

ACT XML Tags

Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

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. 24)

Remarks
None.

542

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
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. 24)

Remarks
None.

Examples
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

543

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

544

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

545

ACT XML Tags

Details
CallbackType
Ansys_ACT_Core_Callbacks_Evaluate
Mandatory
False
Name
Evaluate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

546

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetFieldCount
Mandatory
False
Name
GetFieldCount
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_GetValue
Mandatory
False
Name
GetValue
Public
True
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

548

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

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. 24)

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

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

550

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

552

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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

<OnEndEval>
Callback that is invoked at the end of the evaluation process for a given step.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

554

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

Details
CallbackType
Ansys_ACT_Core_Callbacks_StartEndEval
Mandatory
False
Name
OnEndEval
Public
True
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

555

ACT XML Tags

Details
CallbackType
ActionCallback_IUserResult_
Mandatory
False
Name
OnEndPost
Public
False
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. 24)

Remarks
None.

Examples
None.

556

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

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

Examples
None.

558

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

Examples
None.

Release 17.1 - SAS IP, 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_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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

560

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

562

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

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

<OnStartEval>
Callback that is invoked when the evaluation process for a given step starts.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_StartEndEval
Mandatory
False
Name
OnStartEval
Public
True
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<OnStartPost>
Callback that is invoked when the post process starts.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

564

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

Details
CallbackType
ActionCallback_IUserResult_
Mandatory
False
Name
OnStartPost
Public
False
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

565

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

566

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

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

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

567

ACT XML Tags

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
Mandatory
False
Name
averaging
DefaultValue
Unaverage
DataDefinition
False
AllowedValues
None.

568

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>
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 17.1 - SAS IP, 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

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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

Examples
None.

Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.

570

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>
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

hasimaginary=
Indicates whether the result supports imaginary values.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

571

ACT XML Tags

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
hasimaginary
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

572

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

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

location=
Location of the result.

Type
Ansys_ACT_Interfaces_Post_ResultLocationEnum

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

573

ACT XML Tags

Examples
None.

Details
Mandatory
True
Name
location
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.

574

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Result>

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

timehistory=
Indicates whether the time history has to be calculated.

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

575

ACT XML Tags

Name
timehistory
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
Mandatory
True
Name
type
DefaultValue
None.

576

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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
Mandatory
False
Name
unit
DefaultValue
Dimensionless
DataDefinition
False
AllowedValues
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

577

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
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.

578

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 50: XML Tag Listing
Tag

<Attributes> (p. 580)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 581)

No details provided. (inherited from SimEntity)

Callback <CanAdd> (p. 582)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <CanDuplicate> (p. 583)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

Callback <CanRemove> (p. 584)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Tag

The job input files.

<InputFile> (p. 585)

Callback <IsValid> (p. 585)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 586)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGeometryUpdate> (p. 587)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

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

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <oncreatejobinput> (p. 590)

This callback handles the generation of all input

files defined on the rsm job.

Callback <OnDuplicate> (p. 591)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <OnGenerateData> (p. 592)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

579

ACT XML Tags

Callback <OnHide> (p. 593)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 594)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <onjobcancellation> (p. 595)

This callback handles a user-invoked job

cancellation.

Callback <onjobreconnect> (p. 596)

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. 597)

This callback handles the status polling engaged

by the Framework. Return True to indicate the job
has completed.

Callback <OnMigrate> (p. 598)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 599)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <OnRemove> (p. 600)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <OnShow> (p. 601)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Callback <OnSuppress> (p. 602)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 603)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Tag

<OutputFile> (p. 604)

The job output files.

Tag

<Program> (p. 605)

The programs to run by the rsm job. Currently

only one program per job allowed.

Tag

<Property> (p. 606)

No details provided. (inherited from SimEntity)

Attribute caption= (p. 606)

Caption of the object. (inherited from SimEntity)

Attribute class= (p. 607)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute contextual= (p. 608)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

Attribute deletefiles= (p. 609)

Indicates whether ACT should delete all rsmJob

input and output files upon successful completion
or job cancellation.

Attribute icon= (p. 610)

Icon for the object. (inherited from SimEntity)

Attribute name= (p. 611)

Name of the object. (inherited from SimEntity)

Attribute version= (p. 612)

Version of the object. (inherited from SimEntity)

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

580

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<rsmjob>

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

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. 31)

Remarks
None.

Examples
None.

Details
ChildType
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

581

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.

582

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

583

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. 24)

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

584

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 193)

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. 24)

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

585

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. 24)

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

Examples
None.

586

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

587

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. 24)

Remarks
None.

Examples
None.

588

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

589

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. 24)

Remarks
None.

Examples
None.

590

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

591

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. 24)

Remarks
None.

Examples
None.

592

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

593

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. 24)

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

Examples
None.

594

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

595

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. 24)

Remarks
None.

Examples
None.

596

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

597

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. 24)

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

Examples
None.

598

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

600

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

601

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. 24)

Remarks
None.

Examples
None.

602

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

603

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. 373)

Remarks
None.

Examples
None.

604

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 414)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Program
MinOccurence
1
MaxOccurence
1
RealParent
None.
Mandatory
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

605

ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<rsmjob>

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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

Examples
None.

Details
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

607

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

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

608

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<rsmjob>
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
Mandatory
False
Name
deletefiles
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

609

ACT XML Tags

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.
MultipleValue
False
MappedValues
None.

610

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<rsmjob>
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.
Public
True
Description
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

611

ACT XML Tags

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.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Sampling>
Class defining a DesignXxplorer Sampling. <code><sampling>...</sampling></code>

612

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

Remarks
None.

Examples
None.
Table 51: XML Tag Listing
Tag

<Attributes> (p. 615)

No details provided. (inherited from

SimEntity)

Tag

<Callbacks> (p. 616)

No details provided. (inherited from

SimEntity)

Callback <CanAdd> (p. 617)

Callback that is invoked to determine

whether the object can be added.
(inherited from SimEntity)

Callback <CanDuplicate> (p. 618)

Callback that is invoked to determine if

the object can be duplicated. (inherited
from SimEntity)

Callback <CanRemove> (p. 619)

Callback that is invoked to determine if

the object can be removed. (inherited
from SimEntity)

Callback <CanRun> (p. 620)

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. 621)

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. 622)

Callback that is invoked to return a

user-readable string describing the
optimizer and its specific capabilities.
(inherited from DesignExplorer)

Callback <InputParametersEdited> (p. 623)

Callback that is invoked when the

properties of input parameters have
changed. (inherited from
DesignExplorer)

Callback <IsValid> (p. 624)

Callback that is invoked to determine if

the object is valid. (inherited from
SimEntity)

Callback <MethodPropertiesEdited> (p. 625)

Callback that is invoked when the

properties of the optimization method
have changed. (inherited from
DesignExplorer)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

613

ACT XML Tags

Callback <OnAdd> (p. 626)

Callback that is invoked when the object

is newly added. (inherited from
SimEntity)

Callback <OnAfterGeometryUpdate> (p. 626)

Callback that is invoked when the

geometry has been updated. (inherited
from SimEntity)

Callback <OnBodySuppressStateChange> (p. 627)

Callback that is invoked when the body

suppress state changse. (inherited from
SimEntity)

Callback <OnClearData> (p. 628)

Callback that is invoked when object

data are cleared. (inherited from
SimEntity)

Callback <OnCreate> (p. 629)

Callback that is invoked to provide an

instance of IOptimizationMethod (or
ISamplingMethod). (inherited from
DesignExplorer)

Callback <OnDuplicate> (p. 630)

Callback that is invoked when the object

is duplicated. (inherited from SimEntity)

Callback <OnGenerateData> (p. 631)

Callback that is invoked when object

data are generated. (inherited from
SimEntity)

Callback <OnHide> (p. 632)

Callback that is invoked when the object

is hidden. (inherited from SimEntity)

Callback <OnInit> (p. 633)

Callback that is invoked when the object

is initialized. (inherited from SimEntity)

Callback <OnMigrate> (p. 634)

Callback that is invoked when the object

version has been changed. (inherited
from SimEntity)

Callback <OnReady> (p. 635)

Callback that is invoked when the

application is fully loaded and in a
"ready" state. (Inherited from SimEntity)
(inherited from SimEntity)

Callback <OnRelease> (p. 636)

Callback that is invoked to release the

IOptimizationMethod (or the
ISamplingMethod) instance. (inherited
from DesignExplorer)

Callback <OnRemove> (p. 637)

Callback that is invoked when the object

is removed. (inherited from SimEntity)

Callback <OnShow> (p. 638)

Callback that is invoked when the object

is shown. (inherited from SimEntity)

Callback <OnSuppress> (p. 639)

Callback that is invoked when the object

is suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 640)

Callback that is invoked when the object

is unsuppressed. (inherited from
SimEntity)

Tag

No details provided. (inherited from

SimEntity)

614

<Property> (p. 641)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>
Callback <QuickHelp> (p. 642)

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. 643)

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. 644)

Caption of the object. (inherited from

SimEntity)

Attribute class= (p. 645)

Class name of the controller of the

object. (inherited from SimEntity)

Attribute contextual= (p. 646)

Indicates whether the object has to be

displayed in the contextual menu.
(inherited from SimEntity)

Attribute CustomTable= (p. 646)

Supports custom table points.

Attribute icon= (p. 647)

Icon for the object. (inherited from

SimEntity)

Attribute logfile= (p. 648)

Provides messages to generate a log file.

(inherited from DesignExplorer)

Attribute maximumnumberofdoublelistparameters= (p. 649) Indicates the maximum number of

double list parameters supported.
(inherited from DesignExplorer)
Attribute maximumnumberofdoubleparameters= (p. 650)

Indicates the maximum number of

double parameters supported. (inherited
from DesignExplorer)

Attribute maximumnumberofinputparameters= (p. 651)

Indicates the maximum number of input

parameters supported. (inherited from
DesignExplorer)

Attribute maximumnumberofintegerlistparameters= (p. 652) Indicates the maximum number of

integer list parameters supported.
(inherited from DesignExplorer)
Attribute name= (p. 653)

Name of the object. (inherited from

SimEntity)

Attribute version= (p. 654)

Version of the object. (inherited from

SimEntity)

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

615

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. 31)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
616

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

617

ACT XML Tags

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. 24)

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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks

618

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>
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. 24)

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
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

619

ACT XML Tags

<CanRun>
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)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__bool_
Mandatory
False
Name
CanRun
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

620

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

<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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_
Mandatory
False
Name
Configuration
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

621

ACT XML Tags

<Description>
Callback that is invoked to return a user-readable string describing the optimizer and its specific capabilities. (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_
Mandatory
False
Name
Description
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

622

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

<InputParametersEdited>
Callback that is invoked when the properties of input parameters have changed. (inherited from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
InputParametersEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

623

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. 24)

Remarks
None.

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

624

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
MethodPropertiesEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

625

ACT XML Tags

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

Examples
None.

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)

626

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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. 24)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

627

ACT XML Tags

Remarks
None.

Examples
None.

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. 24)

Remarks
None.

628

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

Examples
None.

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

<OnCreate>
Callback that is invoked to provide an instance of IOptimizationMethod (or ISamplingMethod). (inherited
from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Release 17.1 - SAS IP, 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
FuncCallback_IUserObject__object_
Mandatory
False
Name
OnCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

630

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

632

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

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. 24)

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

Examples
None.

Release 17.1 - SAS IP, 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_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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

Examples
None.

634

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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

<OnRelease>
Callback that is invoked to release the IOptimizationMethod (or the ISamplingMethod) instance. (inherited
from DesignExplorer)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

636

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
OnRelease
Public
True
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

638

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

640

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

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

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

641

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_
Mandatory
False
Name
QuickHelp
Public
True
Obsolete
False

642

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__string_
Mandatory
False
Name
Status
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

643

ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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.

644

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

Examples
None.

Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

645

ACT XML Tags

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

CustomTable=
Supports custom table points.

646

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

Type
System_Boolean

Remarks
None.

Examples
None.

Details
Mandatory
False
Name
CustomTable
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)

Type
System_String

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

647

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

logfile=
Provides messages to generate a log file. (inherited from DesignExplorer)

Type
System_Boolean

Remarks
None.

648

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>

Examples
None.

Details
Mandatory
False
Name
logfile
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.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

649

ACT XML Tags

Details
Mandatory
False
Name
maximumnumberofdoublelistparameters
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.

Details
Mandatory
False

650

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>
Name
maximumnumberofdoubleparameters
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
Mandatory
False
Name
maximumnumberofinputparameters
DefaultValue
100

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

651

ACT XML Tags

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
Mandatory
False
Name
maximumnumberofintegerlistparameters
DefaultValue
100
DataDefinition
False
AllowedValues
None.

652

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Sampling>
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

653

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
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.

654

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<script>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<script>
Specifies the IronPython script referenced by the extension.

Remarks
None.

Examples
None.
Table 52: XML Tag Listing
Attribute compiled= (p. 655) Specifies whether the script will be compiled as a
binary file.
Attribute src= (p. 656)

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
Mandatory
False
MultipleValue
False
Name
compiled
DefaultValue
False
DataDefinition
False
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

655

ACT XML Tags

AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
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
Mandatory
False
MultipleValue
False
Name
src
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.

656

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<simdata>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<separator>
Class defining the separator for items in a toolbar.

Remarks
None.

Examples
None.

<simdata>
Class defining a general section that stores all user object definitions.

Remarks
None.

Examples
None.
Table 53: XML Tag Listing
Tag

<Object> (p. 657) No details provided.

Attribute context= (p. 658) Context or combination of contexts (separated

using '|').

<Object>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Object (p. 266)

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

657

ACT XML Tags

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Object
MinOccurence
0
MaxOccurence
-1
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
Mandatory
True
MultipleValue
True
Name
context
DefaultValue
None.

658

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

<Solver>
Class specifying a third-party solver to be used in the simulation.

Remarks
None.

Examples
None.
Table 54: XML Tag Listing
Tag

<Attributes> (p. 661)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 661)

No details provided. (inherited from SimEntity)

Callback <CanAdd> (p. 662)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <CanDuplicate> (p. 663)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

Callback <CanRemove> (p. 664)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Callback <GetFiles> (p. 665)

Callback that is invoked to return a list of file

strings used by a custom solver.

Callback <GetReader> (p. 666)

Callback that is invoked to get the reader class

name and associated options.

Callback <GetSteps> (p. 667)

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. 668)

Callback that is invoked to determine whether the

analysis is valid.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

659

ACT XML Tags

Callback <IsValid> (p. 669)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 670)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGeometryUpdate> (p. 671)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

Callback <OnBeforeSolve> (p. 671)

Callback that is invoked before the solve process.

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

Callback that is invoked before any post-processing

evaluation.

Callback <OnClearData> (p. 674)

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <OnDuplicate> (p. 675)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <OnGenerateData> (p. 676)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Callback <OnHide> (p. 677)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 678)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <OnMigrate> (p. 679)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 680)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <OnRemove> (p. 681)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <OnShow> (p. 682)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Callback <OnSolve> (p. 683)

Callback that is invoked when the solve process

is run.

Callback <OnSuppress> (p. 684)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 685)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Callback <OnWriteInputFile> (p. 686)

Callback that is invoked to write the solver input

file.

Tag

No details provided. (inherited from SimEntity)

<Property> (p. 687)

Attribute analysis= (p. 688)

Type of analysis.

Attribute caption= (p. 689)

Caption of the object. (inherited from SimEntity)

Attribute class= (p. 690)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute contextual= (p. 691)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

660

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>
Attribute icon= (p. 691)

Icon for the object. (inherited from SimEntity)

Attribute name= (p. 692)

Name of the object. (inherited from SimEntity)

Attribute physics= (p. 693)

Type of physics.

Attribute toolbox= (p. 694)

Name of the toolbox.

Attribute version= (p. 695)

Version of the object. (inherited from SimEntity)

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

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. 31)

Release 17.1 - SAS IP, 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
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Mandatory
False
Name
CanAdd
662

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False
Name
CanDuplicate
Public
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

663

ACT XML Tags

Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False

664

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<GetFiles>
Callback that is invoked to return a list of file strings used by a custom solver.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetFiles
Mandatory
False
Name
GetFiles
Public
False
Obsolete
False
ObsoleteMessage
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

665

ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<GetReader>
Callback that is invoked to get the reader class name and associated options.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetReader
Mandatory
False
Name
GetReader
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.

666

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSteps
Mandatory
False
Name
GetSteps
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

667

ACT XML Tags

MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsSolverAnalysisValid
Mandatory
False
Name
IsAnalysisValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1

668

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
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. 24)

Remarks
None.

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

669

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. 24)

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

Examples
None.

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

670

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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

<OnBeforeSolve>
Callback that is invoked before the solve process.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

671

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolve
Mandatory
False
Name
OnBeforeSolve
Public
True
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. 24)

672

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>

Remarks
None.

Examples
None.

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

<OnCheckResults>
Callback that is invoked before any post-processing evaluation.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

673

ACT XML Tags

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnCheckResults
Mandatory
False
Name
OnCheckResults
Public
True
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. 24)

Remarks
None.

Examples
None.

674

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

676

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

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

Examples
None.

678

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

Examples
None.

Release 17.1 - SAS IP, 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_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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

680

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

682

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>

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

<OnSolve>
Callback that is invoked when the solve process is run.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_OnSolve
Mandatory
False
Name
OnSolve
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. 24)

Remarks
None.

Examples
None.

684

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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

<OnWriteInputFile>
Callback that is invoked to write the solver input file.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
This callback is called after "OnBeforeSolve" and before "OnSolve" in a full solve process.<br /> If the
user ask only to write the input file, the callback will be called after "OnBeforeSolve".

Examples
None.

686

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnWriteInputFile
Mandatory
False
Name
OnWriteInputFile
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

687

ACT XML Tags

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.

688

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

689

ACT XML Tags

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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

Examples
None.

Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.

690

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>
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

icon=
Icon for the object. (inherited from SimEntity)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

691

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

692

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>

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

physics=
Type of physics.

Type
System_String

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

693

ACT XML Tags

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.

Examples
None.

694

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Solver>

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.

Details
Mandatory
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

695

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

<Step>
Class defining a step in a guided process a (wizard or AIM custom template).

Remarks
None.

Examples
None.
Table 55: XML Tag Listing
Tag

<Attributes> (p. 698)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 698)

No details provided. (inherited from SimEntity)

Callback <CanAdd> (p. 699)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <CanDuplicate> (p. 700)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

Callback <CanRemove> (p. 701)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Tag

<ComponentData> (p. 702)

Data of the components in the step's layout.

Tag

<ComponentStyle> (p. 703)

Styles of the components in the step's layout.

Tag

<Description> (p. 703)

Gets or sets the description of the step.

696

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>
Callback <IsValid> (p. 704)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 705)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGeometryUpdate> (p. 706)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

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

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <OnDuplicate> (p. 709)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <OnGenerateData> (p. 710)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Callback <OnHide> (p. 710)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 711)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <OnMigrate> (p. 712)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 713)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <onrefresh> (p. 714)

Callback that is invoked when the step is

initialized.

Callback <OnRemove> (p. 715)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <onreset> (p. 716)

Callback that is invoked when we return to the

previous step.

Callback <OnShow> (p. 717)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Callback <OnSuppress> (p. 718)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 719)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Callback <onupdate> (p. 720)

Callback that is invoked when the step is finalized.

Tag

No details provided. (inherited from SimEntity)

<Property> (p. 721)

Attribute caption= (p. 722)

Caption of the object. (inherited from SimEntity)

Attribute class= (p. 723)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute Context= (p. 724)

Gets or sets the context name.

Attribute contextual= (p. 725)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

Attribute Enabled= (p. 725)

Gets or sets the Enabled flag.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

697

ACT XML Tags

Attribute helpFile= (p. 726)

File containing help HTML content.

Attribute icon= (p. 727)

Icon for the object. (inherited from SimEntity)

Attribute Layout= (p. 728)

Gets or sets the layout to use for this step.

Attribute name= (p. 729)

Name of the object. (inherited from SimEntity)

Attribute version= (p. 730)

Version of the object. (inherited from SimEntity)

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

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. 31)

698

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Mandatory
False
Name
CanAdd
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

699

ACT XML Tags

Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False
Name
CanDuplicate
Public
True

700

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

701

ACT XML Tags

ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<ComponentData>
Data of the components in the step's layout.

Type
Ansys_ACT_Core_XmlDataModel_ComponentData (p. 51)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

702

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>

<ComponentStyle>
Styles of the components in the step's layout.

Type
Ansys_ACT_Core_XmlDataModel_ComponentStyle (p. 59)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Description>
Gets or sets the description of the step.

Type
System_String

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

703

ACT XML Tags

Details
Description
None.
Public
True
Name
Description
ValueName
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.

704

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>
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. 24)

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

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

705

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Mandatory
False
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0

706

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Mandatory
False
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

707

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

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

708

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>
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. 24)

Remarks
None.

Examples
None.

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

709

ACT XML Tags

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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)

710

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

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. 24)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

711

ACT XML Tags

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

Examples
None.

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

712

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>

Examples
None.

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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

713

ACT XML Tags

Examples
None.

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

<onrefresh>
Callback that is invoked when the step is initialized.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

714

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>

Details
CallbackType
ActionCallback_IWizardStep_
Mandatory
False
Name
onrefresh
Public
True
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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

<onreset>
Callback that is invoked when we return to the previous step.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

716

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>

Details
CallbackType
ActionCallback_IWizardStep_
Mandatory
False
Name
onreset
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

718

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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

<onupdate>
Callback that is invoked when the step is finalized.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

720

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>

Details
CallbackType
ActionCallback_IWizardStep_
Mandatory
False
Name
onupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

721

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.

722

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

Examples
None.

Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

723

ACT XML Tags

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

724

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>
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

Enabled=
Gets or sets the Enabled flag.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

725

ACT XML Tags

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.

Type
System_String

726

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>

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

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

727

ACT XML Tags

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.

Examples
None.

728

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Step>

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.

Details
Mandatory
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

729

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

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

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
True
Name
version
DefaultValue
None.

730

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Target>
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 56: XML Tag Listing
Attribute location= (p. 731) Sub-type of the target location when
ype==Analysis.
Attribute name= (p. 732)

Name of the parent.

Attribute type= (p. 733)

Type of the target location.

location=
Sub-type of the target location when ype==Analysis.

Type
Ansys_ACT_Interfaces_UserObject_ObjectLocationEnum

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

731

ACT XML Tags

Examples
None.

Details
Mandatory
False
Name
location
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.

Examples
None.

732

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Target>

Details
Mandatory
False
Name
name
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.

Details
Mandatory
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

733

ACT XML Tags

Name
type
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 57: XML Tag Listing
Tag

<Attributes> (p. 736)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 736)

No details provided. (inherited from SimEntity)

Callback <CanAdd> (p. 737)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <canconsumedata> (p. 738)

Callback that is invoked for task

connection/consumption.

Callback <CanDuplicate> (p. 739)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

Callback <CanRemove> (p. 740)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Tag

The user-defined custom context menu entries.

734

<ContextMenus> (p. 741)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>
Tag

<Inputs> (p. 742)

User-defined task input connections.

Callback <IsValid> (p. 742)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 743)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGeometryUpdate> (p. 744)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

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

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <ondelete> (p. 747)

Callback that is invoked for task deletion.

Callback <OnDuplicate> (p. 748)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <onedit> (p. 749)

Callback that is invoked for task EDIT entry.

Callback <OnGenerateData> (p. 750)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Callback <OnHide> (p. 751)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 752)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <oninitialize> (p. 753)

Callback that is invoked for task creation.

Callback <OnMigrate> (p. 754)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 755)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <onrefresh> (p. 756)

Callback that is invoked for task refresh.

Callback <OnRemove> (p. 757)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <onreport> (p. 758)

Callback that is invoked for task reporting.

Callback <onreset> (p. 759)

Callback that is invoked for task reset.

Callback <OnShow> (p. 760)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Callback <onstatus> (p. 761)

Callback that is invoked for task status.

Callback <OnSuppress> (p. 762)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 763)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Callback <onupdate> (p. 764)

Callback that is invoked for task update.

Tag

<Outputs> (p. 765)

User-defined task output connections.

Tag

<Parameters> (p. 766)

User-defined parameters to be exposed on the

task.

Tag

<Property> (p. 767)

No details provided. (inherited from SimEntity)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

735

ACT XML Tags

Tag

<RsmJob> (p. 767)

List of task-level RSM Jobs.

Attribute caption= (p. 768)

Caption of the object. (inherited from SimEntity)

Attribute class= (p. 769)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute contextual= (p. 770)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

Attribute enableGenericTransfer= (p. 771)

Indicates whether or not the task should expose

the general transfer type as an output.

Attribute icon= (p. 771)

Icon for the object. (inherited from SimEntity)

Attribute name= (p. 772)

Name of the object. (inherited from SimEntity)

Attribute version= (p. 773)

Version of the object. (inherited from SimEntity)

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

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)
736

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

737

ACT XML Tags

Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<canconsumedata>
Callback that is invoked for task connection/consumption.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_IUserObject__IUserObject__bool_
Mandatory
False

738

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>
Name
canconsumedata
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False
Name
CanDuplicate

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

739

ACT XML Tags

Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Mandatory
False
Name
CanRemove
Public
True

740

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<ContextMenus>
The user-defined custom context menu entries.

Type
Ansys_ACT_Core_XmlDataModel_ContextMenus (p. 61)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_ContextMenus
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

741

ACT XML Tags

TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Inputs>
User-defined task input connections.

Type
Ansys_ACT_Core_XmlDataModel_Inputs (p. 195)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Inputs
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. 24)

Remarks
None.

Examples
None.
742

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

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. 24)

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

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

743

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

744

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

745

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

746

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

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

<ondelete>
Callback that is invoked for task deletion.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

747

ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
ondelete
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

748

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

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

<onedit>
Callback that is invoked for task EDIT entry.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

749

ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
onedit
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. 24)

Remarks
None.

Examples
None.

750

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

751

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. 24)

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

Examples
None.

752

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

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

<oninitialize>
Callback that is invoked for task creation.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

753

ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
oninitialize
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

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

Examples
None.

754

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

755

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

<onrefresh>
Callback that is invoked for task refresh.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

756

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
onrefresh
Public
True
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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

<onreport>
Callback that is invoked for task reporting.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

758

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

Details
CallbackType
ActionCallback_IUserObject__object_
Mandatory
False
Name
onreport
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<onreset>
Callback that is invoked for task reset.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

759

ACT XML Tags

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
onreset
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. 24)

Remarks
None.

Examples
None.

760

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

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

<onstatus>
Callback that is invoked for task status.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

761

ACT XML Tags

Details
CallbackType
FuncCallback_IUserObject__object_
Mandatory
False
Name
onstatus
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. 24)

Remarks
None.

Examples
None.

762

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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

<onupdate>
Callback that is invoked for task update.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

764

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
onupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Outputs>
User-defined task output connections.

Type
Ansys_ACT_Core_XmlDataModel_Outputs (p. 375)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

765

ACT XML Tags

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. 411)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Parameters
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False

766

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

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. 579)

Remarks
Currently only one entry is allowed.

Examples
None.
Release 17.1 - SAS IP, 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_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.

768

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>
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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

Examples
None.

Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

769

ACT XML Tags

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

770

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>
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

icon=
Icon for the object. (inherited from SimEntity)
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

771

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

772

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<task>

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

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

773

ACT XML Tags

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

<taskgroup>
Class defining a collection of tasks.

Remarks
None.

Examples
None.
Table 58: XML Tag Listing
Tag

<Attributes> (p. 776)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 776)

No details provided. (inherited from SimEntity)

774

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroup>
Callback <CanAdd> (p. 777)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <CanDuplicate> (p. 778)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

Callback <CanRemove> (p. 779)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Tag

<IncludeGroup> (p. 780)

The task group's List of nested task groups.

Tag

<IncludeTask> (p. 781)

List of tasks for the task group.

Callback <IsValid> (p. 781)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 782)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGeometryUpdate> (p. 783)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

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

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <OnDuplicate> (p. 786)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <OnGenerateData> (p. 787)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Callback <OnHide> (p. 788)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 789)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <OnMigrate> (p. 790)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 791)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <OnRemove> (p. 792)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <OnShow> (p. 793)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Callback <OnSuppress> (p. 794)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Callback <OnUnsuppress> (p. 795)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Tag

No details provided. (inherited from SimEntity)

<Property> (p. 796)

Attribute abbreviation= (p. 797)

Task group abbreviation used for directory and

naming purposes.

Attribute caption= (p. 798)

Caption of the object. (inherited from SimEntity)

Attribute category= (p. 799)

Category to which the task group applies.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

775

ACT XML Tags

Attribute class= (p. 800)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute contextual= (p. 801)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

Attribute icon= (p. 801)

Icon for the object. (inherited from SimEntity)

Attribute isparametricgroup= (p. 802)

Indicates whether the taskgroup operates only on

parameters.

Attribute name= (p. 803)

Name of the object. (inherited from SimEntity)

Attribute version= (p. 804)

Version of the object. (inherited from SimEntity)

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

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)

776

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroup>

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

777

ACT XML Tags

Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False

778

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroup>
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
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. 24)

Remarks
None.

Examples
None.

Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Mandatory
False
Name
CanRemove

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

779

ACT XML Tags

Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<IncludeGroup>
The task group's List of nested task groups.

Type
Ansys_ACT_Core_XmlDataModel_IncludeGroup (p. 184)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_IncludeGroup
MinOccurence
0
MaxOccurence
-1
RealParent
None.

780

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroup>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<IncludeTask>
List of tasks for the task group.

Type
Ansys_ACT_Core_XmlDataModel_IncludeTask (p. 187)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_IncludeTask
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. 24)

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

781

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. 24)

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

Examples
None.

782

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroup>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

783

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. 24)

Remarks
None.

Examples
None.

784

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroup>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

785

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

786

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroup>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

787

ACT XML Tags

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. 24)

Remarks
None.

Examples
None.

788

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroup>

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. 24)

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

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

789

ACT XML Tags

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

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

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

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

Examples
None.

790

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroup>

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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

791

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. 24)

Remarks
None.

Examples
None.

792

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroup>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

793

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. 24)

Remarks
None.

Examples
None.

794

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroup>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

795

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

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

Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)

Remarks
None.

Examples
None.

796

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

797

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.

798

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

799

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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

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

800

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

801

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

isparametricgroup=
Indicates whether the taskgroup operates only on parameters.

Type
System_Boolean

802

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroup>

Remarks
None.

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.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

803

ACT XML Tags

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.

804

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<taskgroups>

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

<taskgroups>
Class defining the task groups collection.

Remarks
None.

Examples
None.
Table 59: XML Tag Listing
Tag <TaskGroup> (p. 805) No details
provided.

<TaskGroup>
No details provided.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

805

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_TaskGroup (p. 774)

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 60: XML Tag Listing
Tag <Task> (p. 806) No details
provided.

<Task>
No details provided.

806

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Templates>

Type
Ansys_ACT_Core_XmlDataModel_Task (p. 734)

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 61: XML Tag Listing
Tag <ControlTemplate> (p. 807) Defines a control template for the creation of groups of
properties.

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

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

807

ACT XML Tags

Type
Ansys_ACT_Core_XmlDataModel_ControlTemplate (p. 62)

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 62: XML Tag Listing
Tag

<Separator> (p. 809) Separator for the

toolbar.

Attribute caption= (p. 809)

Caption of the
toolbar.

Attribute name= (p. 810)

Name of the
toolbar.

808

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<toolbar>

<Separator>
Separator for the toolbar.

Type
Ansys_ACT_Core_XmlDataModel_Separator (p. 657)

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.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

809

ACT XML Tags

Details
Mandatory
False
MultipleValue
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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
Mandatory
True

810

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<UIDefinition>
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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 63: XML Tag Listing
Tag <ComponentDefinition> (p. 811) No details
provided.
Tag <Layout> (p. 812)

No details
provided.

<ComponentDefinition>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_UI_ComponentDefinition (p. 52)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

811

ACT XML Tags

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. 224)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
812

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Wizard>
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

<Wizard>
Class defining a guided process (a wizard or AIM custom template) within the extension.

Remarks
None.

Examples
None.
Table 64: XML Tag Listing
Tag

<Callbacks> (p. 813)

Callback <canstart> (p. 814)

Specifies the callbacks that will invoke functions from the IronPython
extension script.
Callback that is invoked to determine whether the wizard can be
started.

Tag

<Description> (p. 815) Description of the wizard.

Tag

<Step> (p. 816)

No details provided.

Attribute caption= (p. 816)

Caption of the wizard.

Attribute context= (p. 817)

Context or combination of contexts (separated using '|').

Attribute icon= (p. 818)

Icon for the wizard.

Attribute layout= (p. 819)

Layout to be used to display the wizard.

Attribute name= (p. 820)

Name of the wizard.

Attribute version= (p. 821)

Major version of the wizard.

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

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

Remarks
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

813

ACT XML Tags

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 wizard can be started.

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

Details
CallbackType
FuncCallback_string__bool_
Name
canstart
Public
True
Obsolete
False

814

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Wizard>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute

<Description>
Description of the wizard.

Type
System_String

Remarks
None.

Examples
None.

Details
Description
Description of the wizard.
Name
Description
ValueName
description
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

815

ACT XML Tags

<Step>
No details provided.

Type
Ansys_ACT_Core_XmlDataModel_Step (p. 696)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_Step
MinOccurence
1
MaxOccurence
-1
RealParent
None.
Mandatory
True
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

caption=
Caption of the wizard.

Type
System_String

Remarks
None.

Examples
None.

816

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Wizard>

Details
Mandatory
False
MultipleValue
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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
Mandatory
True

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

817

ACT XML Tags

MultipleValue
True
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

icon=
Icon for the wizard.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
icon

818

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Wizard>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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.

Examples
None.

Details
Mandatory
False
MultipleValue
False
Name
layout
DefaultValue
None.
DataDefinition
False

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

819

ACT XML Tags

AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

name=
Name of the wizard.

Type
System_String

Remarks
None.

Examples
None.

Details
Mandatory
True
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.

820

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Wizard>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

version=
Major version of the wizard.

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
True
MultipleValue
False
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

821

ACT XML Tags

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 65: XML Tag Listing
Tag

<Attributes> (p. 824)

No details provided. (inherited from SimEntity)

Tag

<Callbacks> (p. 825)

No details provided. (inherited from SimEntity)

Callback <CanAdd> (p. 825)

Callback that is invoked to determine whether the

object can be added. (inherited from SimEntity)

Callback <CanDuplicate> (p. 826)

Callback that is invoked to determine if the object

can be duplicated. (inherited from SimEntity)

Callback <CanRemove> (p. 827)

Callback that is invoked to determine if the object

can be removed. (inherited from SimEntity)

Callback <IsValid> (p. 828)

Callback that is invoked to determine if the object

is valid. (inherited from SimEntity)

Callback <OnAdd> (p. 829)

Callback that is invoked when the object is newly

added. (inherited from SimEntity)

Callback <OnAfterGeometryUpdate> (p. 830)

Callback that is invoked when the geometry has

been updated. (inherited from SimEntity)

Callback <onaftertaskcanduplicate> (p. 831)

Callback that is invoked after a task determines

duplication viability.

Callback <onaftertaskcanusetransfer> (p. 832)

Callback that is invoked after a task determines

transfer data viability.

Callback <onaftertaskcreation> (p. 833)

Callback that is invoked after a task has been

created.

Callback <onaftertaskdeletion> (p. 834)

Callback that is invoked after a task is deleted.

Callback <onaftertaskduplicate> (p. 835)

Callback that is invoked after a task has been

duplicated.

Callback <onaftertaskpropertyretrieval> (p. 836) CCallback that is invoked after a task provides its
property-containing objects.
Callback <onaftertaskrefresh> (p. 837)

Callback that is invoked after a task has been

refreshed.

Callback <onaftertaskreset> (p. 838)

Callback that is invoked after a task has been reset.

Callback <onaftertasksourceschanged> (p. 839)

Callback that is invoked after a task handles a

source change.

822

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>
Callback <onaftertaskstatus> (p. 840)

Callback that is invoked after a task determines

its status.

Callback <onaftertaskupdate> (p. 841)

Callback that is invoked after a task has been

updated.

Callback <onbeforetaskcanduplicate> (p. 842)

Callback that is invoked before a task determines

duplication viability.

Callback <onbeforetaskcanusetransfer> (p. 843)

Callback that is invoked before a task determines

transfer data viability.

Callback <onbeforetaskcreation> (p. 844)

Callback that is invoked before a task is created.

Callback <onbeforetaskdeletion> (p. 845)

Callback that is invoked before a task is deleted.

Callback <onbeforetaskduplicate> (p. 846)

Callback that is invoked before a task is duplicated.

Callback <onbeforetaskpropertyretrieval> (p. 847) Callback that is invoked before a task provides its
property-containing objects.
Callback <onbeforetaskrefresh> (p. 848)

Callback that is invoked before a task is refreshed.

Callback <onbeforetaskreset> (p. 849)

Callback that is invoked before a task is reset.

Callback <onbeforetasksourceschanged> (p. 850) Callback that is invoked before a task handles a
source change.
Callback <onbeforetaskstatus> (p. 851)

Callback that is invoked before a task determines

its status.

Callback <onbeforetaskupdate> (p. 852)

Callback that is invoked before a task is updated.

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

Callback that is invoked when object data are

cleared. (inherited from SimEntity)

Callback <OnDuplicate> (p. 855)

Callback that is invoked when the object is

duplicated. (inherited from SimEntity)

Callback <OnGenerateData> (p. 856)

Callback that is invoked when object data are

generated. (inherited from SimEntity)

Callback <OnHide> (p. 857)

Callback that is invoked when the object is hidden.

(inherited from SimEntity)

Callback <OnInit> (p. 858)

Callback that is invoked when the object is

initialized. (inherited from SimEntity)

Callback <OnMigrate> (p. 859)

Callback that is invoked when the object version

has been changed. (inherited from SimEntity)

Callback <OnReady> (p. 860)

Callback that is invoked when the application is

fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)

Callback <OnRemove> (p. 861)

Callback that is invoked when the object is

removed. (inherited from SimEntity)

Callback <OnShow> (p. 862)

Callback that is invoked when the object is shown.

(inherited from SimEntity)

Callback <OnSuppress> (p. 863)

Callback that is invoked when the object is

suppressed. (inherited from SimEntity)

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

823

ACT XML Tags

Callback <OnUnsuppress> (p. 864)

Callback that is invoked when the object is

unsuppressed. (inherited from SimEntity)

Tag

<Property> (p. 865)

No details provided. (inherited from SimEntity)

Tag

<TaskGroups> (p. 866)

Task groupings to be exposed as organized blocks

within the workflow.

Tag

<Tasks> (p. 867)

Tasks xposed by this workflow.

Attribute caption= (p. 867)

Caption of the object. (inherited from SimEntity)

Attribute class= (p. 868)

Class name of the controller of the object.

(inherited from SimEntity)

Attribute context= (p. 869)

Contexts (application) to which this workflow

applies.

Attribute contextual= (p. 870)

Indicates whether the object has to be displayed

in the contextual menu. (inherited from SimEntity)

Attribute icon= (p. 871)

Icon for the object. (inherited from SimEntity)

Attribute name= (p. 872)

Name of the object. (inherited from SimEntity)

Attribute version= (p. 873)

Version of the object. (inherited from SimEntity)

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

Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 23)

Remarks
None.

Examples
None.

Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False

824

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute

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

Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 31)

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. 24)

Remarks
None.

Examples
None.
Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

825

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. 24)

Remarks
None.

Examples
None.

826

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>

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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

827

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. 24)

Remarks
None.

Examples
None.

828

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>

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. 24)

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

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

829

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. 24)

Remarks
None.

Examples
None.

830

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>

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. 370)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

831

ACT XML Tags

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. 370)

Remarks
None.

Examples
None.

832

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>

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. 370)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

833

ACT XML Tags

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. 370)

Remarks
None.

Examples
None.

834

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>

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. 370)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

835

ACT XML Tags

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. 370)

Remarks
None.

Examples
None.

836

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>

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. 370)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

837

ACT XML Tags

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. 370)

Remarks
None.

Examples
None.

838

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>

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. 370)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

839

ACT XML Tags

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. 370)

Remarks
None.

Examples
None.

840

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>

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. 370)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

841

ACT XML Tags

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

<onbeforetaskcanduplicate>
Callback that is invoked before a task determines duplication viability.

Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 370)

Remarks
None.

Examples
None.

842

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 370)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

843

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. 370)

Remarks
None.

Examples
None.

844

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 370)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

845

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. 370)

Remarks
None.

Examples
None.

846

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 370)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

847

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. 370)

Remarks
None.

Examples
None.

848

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 370)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

849

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. 370)

Remarks
None.

Examples
None.

850

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 370)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

851

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. 370)

Remarks
None.

Examples
None.

852

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

854

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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_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. 24)

Remarks
None.

Examples
None.

856

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, 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
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. 24)

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

Examples
None.

858

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

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

Examples
None.

Release 17.1 - SAS IP, 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_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 SimEntity) (inherited from SimEntity)

Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 24)

Remarks
None.

Examples
None.

860

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

861

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. 24)

Remarks
None.

Examples
None.

862

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 24)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

863

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. 24)

Remarks
None.

Examples
None.

864

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 417)

Remarks
None.

Examples
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

865

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. 805)

Remarks
None.

Examples
None.

Details
ChildType
Ansys_ACT_Core_XmlDataModel_TaskGroups
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False

866

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
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. 806)

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 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

867

ACT XML Tags

Details
Mandatory
False
MultipleValue
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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:<br /><ul><li>The ExtAPI
variable (of type IMechanicalExtAPI)</li><li>The associated load (of type IUserLoad)</li></ul>

Examples
None.

Details
Mandatory
False

868

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>
MultipleValue
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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
Mandatory
True
MultipleValue
True
Name
context

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

869

ACT XML Tags

DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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
MultipleValue
False
Name
contextual
DefaultValue
True
DataDefinition
False

870

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>
AllowedValues
None.
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
MultipleValue
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

871

ACT XML Tags

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
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.

872

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

<Workflow>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

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

Type
System_Int32

Remarks
None.

Examples
None.

Details
Mandatory
True
MultipleValue
False
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.

873

874

Release 17.1 - SAS IP, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.