ACT XML Reference Guide

ANSYS ACT XML Reference Guide
ANSYS, Inc.
Southpointe
2600 ANSYS Drive
Canonsburg, PA 15317
ansysinfo@ansys.com
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

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

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

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
<OnAfterRemove> ................................................................................................................. 205
<OnAfterSolve> ...................................................................................................................... 206
<OnBeforeGeometryUpdate> ................................................................................................. 207
<OnBeforeSolve> ................................................................................................................... 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
vii

<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
<GetPreCommands> .............................................................................................................. 238
<IsValid> ................................................................................................................................ 240
<OnAdd> ............................................................................................................................... 241
<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

<Callbacks> ............................................................................................................................ 269
<CanAdd> .............................................................................................................................. 270
<CanDuplicate> ..................................................................................................................... 271
<CanRemove> ........................................................................................................................ 272
<GetCommands> ................................................................................................................... 273
<GetNodalValuesForDisplay> ................................................................................................. 274
<GetPreCommands> .............................................................................................................. 276
<IsValid> ................................................................................................................................ 278
<OnAdd> ............................................................................................................................... 279
<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
ix

<OnAdd> ............................................................................................................................... 320
<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

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

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
<OnApply> ............................................................................................................................ 427
<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

<help> ................................................................................................................................... 460
<IsValid> ................................................................................................................................ 461
<IsVisible> .............................................................................................................................. 462
<OnActivate> ......................................................................................................................... 463
<OnAdd> ............................................................................................................................... 464
<OnApply> ............................................................................................................................ 465
<OnCancel> ........................................................................................................................... 467
<OnDuplicate> ....................................................................................................................... 468
<OnHide> .............................................................................................................................. 469
<OnInit> ................................................................................................................................ 470
<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
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
<OnApply> ............................................................................................................................ 506
<OnCancel> ........................................................................................................................... 508
xiii

<OnDuplicate> ....................................................................................................................... 509
<OnHide> .............................................................................................................................. 510
<OnInit> ................................................................................................................................ 511
<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
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
<OnClearData> ...................................................................................................................... 552
<OnDuplicate> ....................................................................................................................... 553
<OnEndEval> ......................................................................................................................... 554
<OnEndPost> ......................................................................................................................... 555
<OnGenerateData> ................................................................................................................ 556
<OnHide> .............................................................................................................................. 557
<OnInit> ................................................................................................................................ 558
xiv

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

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

<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
<OnBeforeSolve> ................................................................................................................... 671
<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
xvii

<OnAdd> ............................................................................................................................... 705
<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
<OnClearData> ...................................................................................................................... 746
<ondelete> ............................................................................................................................ 747
<OnDuplicate> ....................................................................................................................... 748
<onedit> ................................................................................................................................ 749
<OnGenerateData> ................................................................................................................ 750
<OnHide> .............................................................................................................................. 751
<OnInit> ................................................................................................................................ 752
xviii

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

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

<onbeforetaskduplicate> ....................................................................................................... 846
<onbeforetaskpropertyretrieval> ............................................................................................ 847
<onbeforetaskrefresh> ........................................................................................................... 848
<onbeforetaskreset> .............................................................................................................. 849
<onbeforetasksourceschanged> ............................................................................................. 850
<onbeforetaskstatus> ............................................................................................................. 851
<onbeforetaskupdate> ........................................................................................................... 852
<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
xxi
xxii
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)
<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).
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)
<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.
<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.
Attribute caption= (p. 5)
Attribute icon= (p. 6)
Attribute name= (p. 7)
Name of the action

callback.
caption=
Type
System_String
Remarks
None.
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=
Type
System_String
Remarks
None.
Examples
None.
<ActionCallback>
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the action callback.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
ACT XML Tags

Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Application>
Class defining a new application.
Remarks
The name of the application will be a new context available for customization.
Examples
None.
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.
<Application>
Attribute MainPanel= (p. 15)
Name of the first panel to display.
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 <callbacks> 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>
Type
System_String
Remarks
None.
ACT XML Tags
Examples
None.
Details
Description
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
<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
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnApplicationInitialized
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
11
ACT XML Tags

MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnApplicationStarted>
Callback that is invoked when the application starts.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnApplicationStarted
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
12
<Application>
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<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
class=
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
context=
Defines a context or combination of contexts (separated using '|') in which the application can be
launched.
Type
System_String_ARRAY_
14
<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
MainPanel=
Name of the first panel to display.
Type
System_String
Remarks
None.
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
name=
Name of the application.
Type
System_String
Remarks
None.
Examples
None.
16
<argument>
Details
Mandatory
True
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
<argument>
This class defines the Argument XML Tag.
Remarks
None.
Examples
None.
The argument name.
Attribute separator= (p. 18)
The argument-value
separator.
Attribute value= (p. 19)
The argument value.
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
separator=
The argument-value separator.
18
<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
value=
The argument value.
Type
System_String
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
<assembly>
Class defining the assembly to be loaded.
Remarks
This tag is typically used to import a specific namespace from a C# dll.
20
<assembly>
Examples
Example 1: <code type="xml"> <assembly src="CSharp.dll" namespace="CSharp" /> </code>
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
21
ACT XML Tags

Description
None.
TypeId
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
22
<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
<attributes>
Class defining the set of attributes for the object.
23
ACT XML Tags
Remarks
None.
Examples
None.
<Callback>
Remarks
None.
Examples
None.
<CallbackGetCommands>
Class providing the commands to add to the solver input file.
Remarks
None.
Examples
None.
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
<CallbackGetCommands>
Examples
None.
Details
Mandatory
True
Name
location
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
order=
Order of the call.
Type
System_Int32
Remarks
None.
Examples
None.
25
ACT XML Tags
Details
Mandatory
False
Name
order
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<CallbackGetPostPreSolveCommands>
Class collecting all commands to add to the solver input file.
Remarks
None.
Examples
None.
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
<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
timedependent=
Specifies if the callback will be called for each step.
Type
System_Boolean
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
<CallbackOnActiveObjectChange>
Callback that is invoked when the active object changes.
Remarks
None.
28
<CallbackOnActiveObjectChange>
Examples
None.
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
29
ACT XML Tags

Description
None.
TypeId
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
30
<Callbacks>
<Callbacks>
Class specifying the callbacks that will invoke functions from the IronPython extension script.
Remarks
The <callbacks> element and its children specify the Python functions that are invoked based on
system- and user-generated events.
Examples
None.
Tag <Action> (p. 31)
No details
provided.
<Action>
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
31
ACT XML Tags
<Component>
Class defining a new component in a layout.
Remarks
None.
Examples
None.
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.
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
<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
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
33
ACT XML Tags

MultipleValue
False
Name
BottomAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
BottomOffset=
Bottom offset related to the bottom attachment.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
BottomOffset
34
<Component>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
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
35
ACT XML Tags

AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
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
<Component>
Public
True
Description
None.
TypeId
CustomHTMLFile=
Custom html file for the component layout.
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
CustomHTMLFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
37
ACT XML Tags

TypeId
CustomJSFile=
Custom jscript file for the component layout.
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
CustomJSFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Height=
Height value for the component.
38
<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
HeightType=
Height type for the component.
Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType
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
LeftAttachment=
Left attachment of the layout.
Type
System_String
Remarks
40
<Component>
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
LeftAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
LeftOffset=
Left offset related to the left attachment.
Type
System_Int32
Remarks
None.
Examples
None.
41
ACT XML Tags
Details
Mandatory
False
MultipleValue
False
Name
LeftOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
MaxHeight=
Maximum height for the component.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
42
<Component>
MultipleValue
False
Name
MaxHeight
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
MaxWidth=
Maximum width for the component.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
MaxWidth
43
ACT XML Tags

DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the component.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
44
<Component>
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
RightAttachment=
Right attachment of the layout.
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
RightAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
45
ACT XML Tags

Public
True
Description
None.
TypeId
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
<Component>
TypeId
TopAttachment=
Top attachment of the layout.
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
TopAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
TopOffset=
Top offset related to the top attachment.
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
visible=
Initial visibility of the component.
Type
System_Boolean
48
<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
Width=
Width value for the component.
Type
System_Int32
Remarks
None.
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
WidthType=
Width type for the component.
Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType
Remarks
None.
Examples
None.
50
<ComponentData>
Details
Mandatory
True
MultipleValue
False
Name
WidthType
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
<ComponentData>
Class defining the data for the component.
Remarks
None.
Examples
None.
Attribute component= (p. 51)
No details
provided.
component=
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
<ComponentDefinition>
Class defining the display of the component.
Remarks
None.
52
Examples
None.
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.
53
ACT XML Tags

MappedValues
None.
Public
True
Description
None.
TypeId
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
Description
None.
TypeId
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
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
HTMLFile=
Default HTML file to use for this component.
56
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
JSFile=
Default JS file to use for this component.
Type
System_String
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
Name=
Name of the component definition.
Type
System_String
Remarks
This will identify the component type.
58
<ComponentStyle>
Examples
None.
Details
Mandatory
True
MultipleValue
False
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
<ComponentStyle>
Class defining the styles for the component.
Remarks
None.
Examples
None.
Attribute component= (p. 60)
Name of the component for which styles are being

defined.
Attribute filter= (p. 60)
Filter for the component styles.
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
filter=
Filter for the component styles.
60
<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
<contextmenus>
Remarks
None.
61
ACT XML Tags
Examples
None.
Tag <UIEntry> (p. 62)
No details
provided.
<UIEntry>
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
<ControlTemplate>
Class defining a control template for the creation of groups of properties.
Remarks
None.
62
<ControlTemplate>
Examples
None.
Tag
<PropertyTable> (p. 63)
Name of the control

template.
Attribute version= (p. 64)
Version of the control

template.
<PropertyTable>
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
name=
Name of the control template.
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
version=
Version of the control template.
Type
System_Int32
64
<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
<entity>
Class defining a custom data entity definition based on an ACT XML Extension file.
Remarks
None.
65
ACT XML Tags
Examples
None.
Tag
No details provided. (inherited from SimEntity)
Tag
<Callbacks> (p. 67)
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)

can be removed. (inherited from SimEntity)
Callback <IsValid> (p. 71)

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)

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

(inherited from SimEntity)
Callback <OnInit> (p. 79)

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)

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

Callback <OnSuppress> (p. 83)

suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 84)

unsuppressed. (inherited from SimEntity)
Tag
66
<Property> (p. 85)
<entity>
Caption 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.
Icon for the object. (inherited from SimEntity)
Name of the object. (inherited from SimEntity)
Version of the object. (inherited from SimEntity)
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
67
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
68
<entity>
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False
69
ACT XML Tags

Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Mandatory
False
Name
CanRemove
70
<entity>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Mandatory
False
Name
IsValid
Public
True
71
ACT XML Tags

Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
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
<entity>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Mandatory
False
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
73
ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Mandatory
False
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
74
<entity>
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
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
75
ACT XML Tags

MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
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
<entity>
RealParent
TypeId
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
77
ACT XML Tags

TypeId
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
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
TypeId
78
<entity>
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
79
ACT XML Tags
Type
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
TypeId
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from SimEntity) (inherited from SimEntity)
80
<entity>
Type
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
TypeId
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
81
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Remarks
None.
82
<entity>
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Remarks
None.
Examples
None.
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
TypeId
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Remarks
None.
Examples
None.
84
<entity>
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 417)
Remarks
None.
Examples
None.
85
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
86
<entity>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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.
87
ACT XML Tags

Public
True
Description
None.
TypeId
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
<entity>
TypeId
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
icon=
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
name=
Type
System_String
90
<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
version=
Type
System_Int32
Remarks
None.
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
<entry>
Class defining a user-interface GUI operatio.
Remarks
None.
Examples
None.
Tag
<Callbacks> (p. 93)
Callbacks
Callback <onclick> (p. 93)
Callback that is invoked on click.
Display text of GUI operation.
92
<entry>
Icon for the object.
Name of GUI operation.
Attribute priority= (p. 97)
UI-level priority (for grouping and ordering

purposes)
Type of GUI operation.
Version of GUI operation...for backwards

compatiblity
<Callbacks>
Callbacks
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<onclick>
Callback that is invoked on click.
Type
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
Mandatory
False
TypeId
caption=
Display text of GUI operation.
Type
System_String
Remarks
None.
94
<entry>
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Icon for the object.
Type
System_String
Remarks
None.
Examples
None.
95
ACT XML Tags
Details
Mandatory
False
MultipleValue
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of GUI operation.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
96
<entry>
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
priority=
UI-level priority (for grouping and ordering purposes)
Type
System_Single
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
priority
97
ACT XML Tags

DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
type=
Type of GUI operation.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
type
DefaultValue
None.
DataDefinition
False
98
<entry>
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
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.
99
ACT XML Tags

Public
True
Description
None.
TypeId
<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.
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.
Caption of the entry.
Attribute Icon= (p. 103)
Icon of the entry.
Name of the entry.
Attribute userobject= (p. 105) Related user object name.
<Callbacks>
Type
Remarks
None.
Examples
None.
100
<entry>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<OnClick>
Callback that is invoked to return when the object is clicked.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IDataModelObject_
Name
OnClick
Public
True
Obsolete
False
ObsoleteMessage
None.
101
ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Separator>
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
102
<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
Icon=
Icon of the entry.
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
name=
Name of the entry.
Type
System_String
104
<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
userobject=
Related user object name.
Type
System_String
Remarks
None.
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
<Extension>
Class defining an ACT extension.
Remarks
This is the base tag or "root" element under which all other tags/elements fall.
Examples
None.
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
<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.
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.

Name of the extension.
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
107
ACT XML Tags

MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<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
<assembly>
Defines one or more assemblies to be loaded.
Type
Ansys_ACT_Core_XmlDataModel_Assembly (p. 20)
108
<Extension>
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<author>
Defines the author of the extension.
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Author of the extension.
Name
author
ValueName
authorName
109
ACT XML Tags

Public
True
TypeId
<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
<Guid>
Defines a unique identifier for the extension.
Type
Ansys_ACT_Core_XmlDataModel_Guid (p. 182)
Remarks
None.
Examples
None.
110
<Extension>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<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
111
ACT XML Tags

TypeId
<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
<script>
Specifies one or more IronPython scripts referenced by the extension.
Type
Ansys_ACT_Core_XmlDataModel_Script (p. 655)
Remarks
None.
Examples
None.
112
<Extension>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<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
113
ACT XML Tags

TypeId
<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
<UIDefinition>
Defines one or more user interfaces for the extension.
Type
Ansys_ACT_Core_XmlDataModel_UI_UIDefinition (p. 811)
Remarks
None.
Examples
None.
114
<Extension>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<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
115
ACT XML Tags

TypeId
<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
debug=
To start this extension in debug mode if in scripted mode.
Type
System_Boolean
Remarks
None.
Examples
None.
116
<Extension>
Details
Mandatory
False
MultipleValue
False
Name
debug
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Icon for the extension.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
117
ACT XML Tags

MultipleValue
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
loadAsDefault=
Specifies if the extension should be loaded automatically.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
loadAsDefault
118
<Extension>
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
False
Description
None.
TypeId
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
119
ACT XML Tags

AllowedValues
None.
MappedValues
None.
Public
False
Description
None.
TypeId
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
<Extension>
Public
True
Description
None.
TypeId
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.
121
ACT XML Tags

TypeId
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
<ExtensionObject>
Class extending the extension object definition. (Inherited from DesignXplorer SimEntity)
122
<ExtensionObject>
Remarks
None.
Examples
None.
Tag
Tag
<Callbacks> (p. 125)



Callback <HostObjectModified> (p. 128)
Callback that is invoked to return when the

properties of host object have changed.












123
ACT XML Tags



Tag
<Property> (p. 144)
Tag
<Target> (p. 145)
Defines the target location for the object.


<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
124
<ExtensionObject>
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
125
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
126
<ExtensionObject>
Details
CallbackType
Mandatory
False
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
127
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<HostObjectModified>
Callback that is invoked to return when the properties of host object have changed.
Type
Remarks
None.
Examples
None.
128
<ExtensionObject>
Details
CallbackType
Mandatory
False
Name
HostObjectModified
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
129
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
130
<ExtensionObject>
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
131
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
132
<ExtensionObject>
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
133
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
134
<ExtensionObject>
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
135
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
136
<ExtensionObject>
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
Examples
None.
137
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
138
<ExtensionObject>
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
139
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
140
<ExtensionObject>
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
141
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
142
<ExtensionObject>
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
143
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
None.
Examples
None.
144
<ExtensionObject>
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Target>
Type
Ansys_ACT_Core_XmlDataModel_Target (p. 731)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
145
ACT XML Tags

TypeId
caption=
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
class=
146
<ExtensionObject>
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
147
ACT XML Tags
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
148
<ExtensionObject>
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
149
ACT XML Tags
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
150
<filter>
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<filter>
Class defining a filter for the object.
Remarks
None.
Examples
None.
Attribute name= (p. 151) Name of the filter.
Specifies the path of the reference IronPython

script.
name=
Name of the filter.
Type
System_String
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
src=
Specifies the path of the reference IronPython script.
Type
System_String
Remarks
None.
152
<Geometry>
Examples
None.
Details
Mandatory
False
Name
src
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Geometry>
Class defining a geometry feature.
Remarks
None.
Examples
None.
Tag
Tag
153
ACT XML Tags






Callback <OnAfterGenerate> (p. 161)
Callback that is invoked at the end of the

generation process.



Callback <OnEdit> (p. 165)
Callback that is invoked when the object is edited.
Callback <OnGenerate> (p. 166)

generated.









Tag
<Property> (p. 176)
154
<Geometry>


<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
155
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanAdd
156
<Geometry>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanDuplicate
Public
True
157
ACT XML Tags

Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
158
<Geometry>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
159
ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
160
<Geometry>
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAfterGenerate>
Callback that is invoked at the end of the generation process.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
161
ACT XML Tags

MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
162
<Geometry>
RealParent
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
163
ACT XML Tags

TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
164
<Geometry>
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnEdit>
Callback that is invoked when the object is edited.
165
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnEdit
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerate>
Callback that is invoked when the object is generated.
Type
166
<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
TypeId
<OnGenerateData>
Type
Remarks
None.
167
ACT XML Tags
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
168
<Geometry>
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
Examples
None.
169
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
170
<Geometry>
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
171
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
172
<Geometry>
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
173
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
174
<Geometry>
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
175
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
None.
Examples
None.
176
<Geometry>
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
177
ACT XML Tags

MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
178
<Geometry>
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
179
ACT XML Tags

TypeId
icon=
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
name=
180
<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
version=
Type
System_Int32
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
<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
<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>
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.
183
ACT XML Tags

TypeId
<includegroup>
Class defining the include group tag (used by task groups).
Remarks
None.
Examples
None.
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)
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
<includegroup>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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
185
ACT XML Tags

MappedValues
None.
Public
True
Description
None.
TypeId
name=
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
<includetask>
Description
None.
TypeId
<includetask>
Class defining the include task tag (used by task groups).
Remarks
None.
Examples
None.
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)
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.
187
ACT XML Tags

DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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
<includetask>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
189
ACT XML Tags

Public
True
Description
None.
TypeId
<input>
Class defining an input-level data connection definition.
Remarks
None.
Examples
None.
Attribute count= (p. 190)
Maximum number of simultaneous input

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

IOItem)
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
<input>
DefaultValue
-1
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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
191
ACT XML Tags

AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
type=
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
<inputfile>
MappedValues
None.
Public
True
Description
None.
TypeId
<inputfile>
This class difines the InputFile XML Tag.
Remarks
None.
Examples
None.
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
193
ACT XML Tags

Name
id
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
The file name. (inherited from File)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
194
<inputs>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<inputs>
Class defining the inputs collection for a task.
Remarks
None.
Examples
None.
Tag <Input> (p. 195) No details
provided.
<Input>
Type
Ansys_ACT_Core_XmlDataModel_Input (p. 190)
Remarks
None.
Examples
None.
195
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Input
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Interface>
Class defining the user interface for the extension.
Remarks
This interface element information pertains specifically to the GUI.
Examples
None.
Tag
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

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.
OnAfterGeometryUpdate.
Callback <OnAfterRemove> (p. 205)
OnAfterRemove.
Callback <OnAfterSolve> (p. 206)
Called when an analysis has been solved.
Callback <OnBeforeGeometryUpdate> (p. 207)
OnBeforeGeometryUpdate.
196
<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 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.
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)
Context or combination of contexts (separated

using '|') for the interface.
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
197
ACT XML Tags

MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<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
<GetPostCommands>
Called to collect all "post" commands to add to the solver input file.
198
<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
Mandatory
False
TypeId
<GetPreCommands>
Called to collect all "pre" commands to add to the solver input file.
Type
199
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Name
GetPreCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="pre".
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<GetSolveCommands>
Called to collect all "solve" commands to add to the solver input file.
Type
Remarks
If timeDependent is true, the callback take as argument : analysis, step, stream
200
<Interface>
Examples
None.
Details
CallbackType
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="solve".
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<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.
201
ACT XML Tags
Details
Description
Add a folder to find images.
Name
images
ValueName
None.
Public
True
TypeId
<IsAnalysisValid>
Called to know if an analysis is valid.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsAnalysisValid
Name
IsAnalysisValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
202
<Interface>
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<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
203
ACT XML Tags

MaxOccurence
-1
RealParent
Mandatory
False
TypeId
OnAfterGeometryUpdate.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
204
<Interface>
RealParent
Mandatory
False
TypeId
<OnAfterRemove>
OnAfterRemove.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnAfterRemove
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
205
ACT XML Tags

Mandatory
False
TypeId
<OnAfterSolve>
Called when an analysis has been solved.
Type
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
Mandatory
False
206
<Interface>
TypeId
<OnBeforeGeometryUpdate>
OnBeforeGeometryUpdate.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnBeforeGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
207
ACT XML Tags
<OnBeforeSolve>
Called when an analysis starts to solve.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnBeforeSolve
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Called when the body suppress state change.
208
<Interface>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnDraw>
Type
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
Mandatory
False
TypeId
<OnDraw2D>
Type
Remarks
None.
210
<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
Mandatory
False
TypeId
<OnInit>
Called when the given context is initialized.
Type
Remarks
None.
Examples
None.
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
Mandatory
False
TypeId
<OnLoad>
Called when a project is loaded.
Type
Remarks
None.
Examples
None.
212
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnLoadSave
Name
OnLoad
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnMeshCleaned>
Called when the mesh is cleaned.
Type
Remarks
None.
Examples
None.
213
ACT XML Tags
Details
CallbackType
Name
OnMeshCleaned
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnMeshGenerated>
Called when the mesh is generated.
Type
Remarks
None.
Examples
None.
214
<Interface>
Details
CallbackType
Name
OnMeshGenerated
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnPostFinished>
Called when the post process end for a given analysis.
Type
Remarks
None.
Examples
None.
215
ACT XML Tags
Details
CallbackType
Name
OnPostFinished
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnPostStarted>
Called when the post process start for a given analysis.
Type
Remarks
None.
Examples
None.
216
<Interface>
Details
CallbackType
Name
OnPostStarted
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnReady>
OnReady.
Type
Remarks
None.
Examples
None.
217
ACT XML Tags
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnSave>
Called when a project is saved.
Type
Remarks
None.
Examples
None.
218
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnLoadSave
Name
OnSave
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnTerminate>
Called when the given context is terminated.
Type
Remarks
None.
Examples
None.
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
Mandatory
False
TypeId
<Resume>
Called when a project is loaded. Usefull to retreive aditional data.
Type
Remarks
None.
Examples
None.
220
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_ResumeExt
Name
Resume
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Save>
Called when a project is saved. Usefull to save aditional data.
Type
Remarks
None.
Examples
None.
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
Mandatory
False
TypeId
<toolbar>
Defines one or more toolbars.
Type
Ansys_ACT_Core_XmlDataModel_Toolbar (p. 808)
Remarks
None.
Examples
None.
222
<Interface>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
context=
Context or combination of contexts (separated using '|') for the interface.
Type
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
223
ACT XML Tags

AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
<Layout>
Class defining the a new panel layout.
Remarks
None.
Examples
None.
Tag
<Component> (p. 224) Defines the component for which the panel layout is being
defined.
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
<Layout>
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
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.
225
ACT XML Tags

Public
True
Description
None.
TypeId
<License>
Class defining a license to be used in the execution of an extension.
Remarks
None.
Examples
None.
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
<Licenses>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Licenses>
Class defining a licenses collection for the extension.
Remarks
None.
Examples
None.
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.
227
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Load>
Class defining a simulation load or boundary.
Remarks
The <load> element and its children allow you to configure the properties of a custom load and
specify the IronPython functions that are invoked based on system and user-generated events.
Examples
None.
Callback <Action> (p. 230)
Tag
Tag



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 that is invoked to collect all "post"

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

Callback that is invoked to collect all "solve"



Callback that is invoked after the generation is

completed.



Callback that is invoked when the load object is

generated.









Tag
<Property> (p. 256)

Attribute color= (p. 259)
Color of the scoped entities.
229
ACT XML Tags


Attribute IsLoad= (p. 261)
Indicates whether the load object should be

considered as a load boundary.
Attribute IsSupport= (p. 262)

considered as a support boundary.
Attribute unit= (p. 264)
Default unit used by the contour display.
<Action>
Type
List_Action_
Remarks
None.
Examples
None.
Details
CallbackType
None.
Mandatory
False
Name
Action
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
230
<Load>
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
231
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
232
<Load>
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
233
ACT XML Tags

Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanRemove
234
<Load>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<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
235
ACT XML Tags

Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetNodalValuesForDisplay>
Callback that is invoked to get nodal values associated with the load.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetNodeValues
Mandatory
False
Name
GetNodalValuesForDisplay
Public
True
Obsolete
False
236
<Load>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetPostCommands>
Callback that is invoked to collect all "post" commands to add to the solver input file.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Mandatory
False
Name
GetPostCommands
Public
True
Obsolete
True
ObsoleteMessage
237
ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetPreCommands>
Callback that is invoked to collect all "pre" commands to add to the solver input file.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
GetPreCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
238
<Load>
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetSolveCommands>
Callback that is invoked to collect all "solve" commands to add to the solver input file.
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
239
ACT XML Tags

MaxOccurence
-1
RealParent
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
240
<Load>
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
241
ACT XML Tags

TypeId
<OnAfterGenerate>
Callback that is invoked after the generation is completed.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
242
<Load>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
243
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnClearData>
Type
244
<Load>
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnDuplicate>
Type
Remarks
None.
245
ACT XML Tags
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnGenerate>
Callback that is invoked when the load object is generated.
Type
Remarks
None.
Examples
None.
246
<Load>
Details
CallbackType
Mandatory
False
Name
OnGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
247
ACT XML Tags
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
248
<Load>
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnInit>
Type
Remarks
Examples
None.
249
ACT XML Tags
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
250
<Load>
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
251
ACT XML Tags
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
252
<Load>
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
253
ACT XML Tags
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
254
<Load>
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
255
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
None.
Examples
None.
256
<Load>
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
257
ACT XML Tags

MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
258
<Load>
Public
True
Description
None.
TypeId
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
259
ACT XML Tags

Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
260
<Load>
icon=
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
IsLoad=
Indicates whether the load object should be considered as a load boundary.
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
IsSupport=
Indicates whether the load object should be considered as a support boundary.
Type
System_Boolean
262
<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
name=
Type
System_String
Remarks
None.
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
unit=
Type
System_String
Remarks
None.
Examples
None.
264
<Load>
Details
Mandatory
False
Name
unit
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
265
ACT XML Tags

Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Object>
Class defining an object.
Remarks
None.
Examples
None.
Tag
Tag



Callback <GetCommands> (p. 273)
Called to collect all commands to add to the solver

input file.
266
<Object>
Callback <GetNodalValuesForDisplay> (p. 274)
Called to get nodal values associated to the load.
Called to collect all "post" commands to add to

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

solver input file.
Called to collect all "solve" commands to add to



Called when the generation is completed.



Called when the load object is generated.









Tag
<Property> (p. 294)
Tag
<Target> (p. 295)
267
ACT XML Tags


Attribute color= (p. 297)
Color of scoped entities.

Attribute IsLoad= (p. 300)

considered as a load boundary.
Attribute IsSupport= (p. 301)

considered as a support boundary.
<Action>
Type
List_Action_
Remarks
None.
Examples
None.
Details
CallbackType
None.
Mandatory
False
Name
Action
Public
False
Obsolete
False
ObsoleteMessage
None.
268
<Object>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
269
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
270
<Object>
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
271
ACT XML Tags

Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanRemove
272
<Object>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<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
273
ACT XML Tags

Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetNodalValuesForDisplay>
Called to get nodal values associated to the load.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetNodeValues
Mandatory
False
Name
GetNodalValuesForDisplay
Public
True
Obsolete
False
274
<Object>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetPostCommands>
Called to collect all "post" commands to add to the solver input file.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
GetPostCommands
Public
True
Obsolete
True
ObsoleteMessage
275
ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetPreCommands>
Called to collect all "pre" commands to add to the solver input file.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
GetPreCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
276
<Object>
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetSolveCommands>
Called to collect all "solve" commands to add to the solver input file.
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
277
ACT XML Tags

MaxOccurence
-1
RealParent
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
278
<Object>
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
279
ACT XML Tags

TypeId
<OnAfterGenerate>
Called when the generation is completed.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
280
<Object>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
281
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Type
282
<Object>
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
283
ACT XML Tags
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerate>
Called when the load object is generated.
Type
Remarks
None.
Examples
None.
284
<Object>
Details
CallbackType
Mandatory
False
Name
OnGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
285
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
286
<Object>
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
Examples
None.
287
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
288
<Object>
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
289
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
290
<Object>
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
291
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
292
<Object>
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
293
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
None.
Examples
None.
294
<Object>
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Target>
Type
Ansys_ACT_Core_XmlDataModel_Target (p. 731)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
295
ACT XML Tags

TypeId
caption=
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
class=
296
<Object>
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
color=
Color of scoped entities.
Type
System_String
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
contextual=
Type
System_Boolean
Remarks
298
<Object>
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
299
ACT XML Tags
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
IsLoad=
Indicates whether the load object should be considered as a load boundary.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
300
<Object>
Name
IsLoad
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
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
301
ACT XML Tags

DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
302
<Object>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
unit=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
unit
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
303
ACT XML Tags

Public
True
Description
None.
TypeId
version=
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
<Optimizer>
TypeId
<Optimizer>
Class defining an optimizer.
Remarks
None.
Examples
None.
Tag
No details provided. (inherited from

SimEntity)
Tag

SimEntity)
Callback that is invoked to determine

whether the object can be added.
Callback that is invoked to determine if

the object can be duplicated. (inherited
from SimEntity)

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)

DXConvergenceDescription object
describing the convergence data
provided.
Callback <Description> (p. 316)

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

Callback <InputParametersEdited> (p. 317)
Callback that is invoked when the

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

the object is valid. (inherited from
SimEntity)
Callback <MethodPropertiesEdited> (p. 319)

properties of the optimization method
have changed. (inherited from
DesignExplorer)
Callback <ObjectivesOrConstraintsEdited> (p. 320)

definition of objectives or constraints
have changed.
Callback that is invoked when the object

is newly added. (inherited from
SimEntity)

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

is duplicated. (inherited from SimEntity)

data are generated. (inherited from
SimEntity)

is hidden. (inherited from SimEntity)

is initialized. (inherited from SimEntity)

version has been changed. (inherited
from SimEntity)

application is fully loaded and in a
"ready" state. (Inherited from SimEntity)
306
<Optimizer>
Callback <OnRelease> (p. 331)
Callback that is invoked to release the

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

is removed. (inherited from SimEntity)

is shown. (inherited from SimEntity)

is suppressed. (inherited from SimEntity)

is unsuppressed. (inherited from
SimEntity)
Callback <ParameterRelationshipsEdited> (p. 336)

definition of parameter relationships
have changed.
Tag

SimEntity)
<Property> (p. 337)
Callback <QuickHelp> (p. 338)

user-readable string helping to
understand the state of the optimizer
(or the sampling) when CanRun is false.
Callback <Status> (p. 339)

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.
Caption of the object. (inherited from

SimEntity)
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.
Indicates whether the object has to be

displayed in the contextual menu.
Attribute convergencedata= (p. 347)
Provides convergence data.
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.
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.

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.
Attribute maximumnumberofdoubleparameters= (p. 357)
Indicates the maximum number of

double parameters supported. (inherited
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.
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.
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.
Version of the object. (inherited from

SimEntity)
308
<Optimizer>
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
309
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
310
<Optimizer>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
311
ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
312
<Optimizer>
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<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
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__bool_
Mandatory
False
Name
CanRun
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
313
ACT XML Tags

MaxOccurence
-1
RealParent
TypeId
<Configuration>
Callback that is invoked to return a userreadable string summarizing the current configuration of the
optimizer (or the sampling). (inherited from DesignExplorer)
Type
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
<Optimizer>
RealParent
TypeId
<ConvergenceDescription>
Callback that is invoked to return a DXConvergenceDescription object describing the convergence data
provided.
Type
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
315
ACT XML Tags

TypeId
<Description>
Callback that is invoked to return a user-readable string describing the optimizer and its specific capabilities. (inherited from DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Description
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
316
<Optimizer>
<InputParametersEdited>
Callback that is invoked when the properties of input parameters have changed. (inherited from DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
InputParametersEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
317
ACT XML Tags
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
318
<Optimizer>
<MethodPropertiesEdited>
Callback that is invoked when the properties of the optimization method have changed. (inherited from
DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
MethodPropertiesEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
319
ACT XML Tags
<ObjectivesOrConstraintsEdited>
Callback that is invoked when the definition of objectives or constraints have changed.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
ObjectivesOrConstraintsEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
320
<Optimizer>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
321
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
322
<Optimizer>
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
323
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnCreate>
Callback that is invoked to provide an instance of IOptimizationMethod (or ISamplingMethod). (inherited
Type
Remarks
None.
Examples
None.
324
<Optimizer>
Details
CallbackType
Mandatory
False
Name
OnCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
325
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
326
<Optimizer>
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
327
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
Examples
None.
328
<Optimizer>
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
329
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
330
<Optimizer>
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRelease>
Callback that is invoked to release the IOptimizationMethod (or the ISamplingMethod) instance. (inherited
Type
Remarks
None.
Examples
None.
331
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnRelease
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
332
<Optimizer>
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
333
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
334
<Optimizer>
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
335
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<ParameterRelationshipsEdited>
Callback that is invoked when the definition of parameter relationships have changed.
Type
Remarks
None.
Examples
None.
336
<Optimizer>
Details
CallbackType
Mandatory
False
Name
ParameterRelationshipsEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
None.
Examples
None.
337
ACT XML Tags
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<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
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
QuickHelp
Public
True
Obsolete
False
338
<Optimizer>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<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
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Status
Public
True
Obsolete
False
ObsoleteMessage
None.
339
ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
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
<Optimizer>
Public
True
Description
None.
TypeId
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.
341
ACT XML Tags

TypeId
caption=
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
class=
342
<Optimizer>
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
constrainthandling=
Supports constraint handling.
Type
System_Boolean
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
constraintimportance=
Supports the Importance property of a constraint.
Type
System_Boolean
Remarks
None.
344
<Optimizer>
Examples
None.
Details
Mandatory
False
Name
constraintimportance
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
constraintoninputparameter=
Supports constraints defined on an input parameter.
Type
System_Boolean
Remarks
None.
Examples
None.
345
ACT XML Tags
Details
Mandatory
False
Name
constraintoninputparameter
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
346
<Optimizer>
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
convergencedata=
Provides convergence data.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
convergencedata
DefaultValue
False
347
ACT XML Tags

DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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
<Optimizer>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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.
349
ACT XML Tags

Public
True
Description
None.
TypeId
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
<Optimizer>
TypeId
icon=
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
insideboundsconstraint=
Supports the Inside Bounds constraint type.
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
lessthanconstraint=
Supports the Less Than constraint type.
Type
System_Boolean
352
<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
logfile=
Provides messages to generate a log file. (inherited from DesignExplorer)
Type
System_Boolean
Remarks
None.
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
maximizeobjective=
Supports the Maximize objective type.
Type
System_Boolean
Remarks
None.
Examples
None.
354
<Optimizer>
Details
Mandatory
False
Name
maximizeobjective
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
maximumnumberofconstraints=
Defines the maximum number of constraints supported by the optimizer.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
355
ACT XML Tags

Name
maximumnumberofconstraints
DefaultValue
100
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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
<Optimizer>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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.
357
ACT XML Tags

MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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
<Optimizer>
Public
True
Description
None.
TypeId
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.
359
ACT XML Tags

TypeId
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
minimizeobjective=
Supports the Minimize objective type.
360
<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
minimumnumberofconstraints=
Defines the minimum number of constraints required.
Type
System_Int32
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
minimumnumberofobjectives=
Defines the minimum number of objectives required.
Type
System_Int32
Remarks
None.
362
<Optimizer>
Examples
None.
Details
Mandatory
False
Name
minimumnumberofobjectives
DefaultValue
1
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
363
ACT XML Tags
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
objectiveimportance=
Supports the Importance property of an objective.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
364
<Optimizer>
Name
objectiveimportance
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
objectiveoninputparameter=
Supports objectives defined on an Input Parameter.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
objectiveoninputparameter
DefaultValue
True
365
ACT XML Tags

DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
parameterrelationship=
Supports parameter relationships.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
parameterrelationship
DefaultValue
False
DataDefinition
False
AllowedValues
None.
366
<Optimizer>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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.
367
ACT XML Tags

Public
True
Description
None.
TypeId
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
<Optimizer>
TypeId
version=
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
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.
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
<output>
MappedValues
None.
Public
True
Description
None.
TypeId
<output>
Class defining an output-level data connection definition.
Remarks
None.
Examples
None.
Attribute format= (p. 371) Connection format type. (inherited from
IOItem)
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
371
ACT XML Tags

Name
format
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
type=
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
<outputfile>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<outputfile>
This class defines the OutputFile XML Tag.
Remarks
None.
Examples
None.
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.
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
name=
The file name. (inherited from File)
Type
System_String
Remarks
None.
Examples
None.
374
<outputs>
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<outputs>
Class defining the outputs collection for a task.
Remarks
None.
Examples
None.
Tag <Output> (p. 375) No details
provided.
<Output>
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
<Panel>
Class defining a panel to be displayed in the application.
Remarks
None.
Examples
None.
Tag
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.
376
<Panel>
Attribute layout= (p. 381)
Layout of the panel.
Name of the panel.
<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (Inherited from
SimEntity)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<OnPanelHidden>
Callback that is invoked when the panel is hidden.
Type
Remarks
None.
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
TypeId
<OnPanelInitialized>
Callback that is invoked when the panel is initialized.
Type
Remarks
None.
Examples
None.
378
<Panel>
Details
CallbackType
Mandatory
False
Name
OnPanelInitialized
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnPanelShown>
Callback that is invoked when the panel is shown.
Type
Remarks
None.
Examples
None.
379
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnPanelShown
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
class=
Type
System_String
Remarks
None.
Examples
None.
380
<Panel>
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
layout=
Layout of the panel.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
381
ACT XML Tags

Name
layout
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the panel.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
382
<parameter>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<parameter>
Class defining a single parameter definition for a task.
Remarks
None.
Examples
None.
Tag
Tag






383
ACT XML Tags












Tag
<Property> (p. 403)


Attribute control= (p. 407)
Underlying data type of the parameter.
Attribute usage= (p. 409)
Usage of the parameter.
<Attributes>
Type
Remarks
None.
384
<parameter>
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
385
ACT XML Tags

Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
386
<parameter>
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
387
ACT XML Tags
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsValid>
388
<parameter>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
389
ACT XML Tags
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
390
<parameter>
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
391
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
392
<parameter>
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
393
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
394
<parameter>
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
395
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
Examples
None.
396
<parameter>
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
397
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
398
<parameter>
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
399
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
400
<parameter>
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
401
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
402
<parameter>
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
None.
Examples
None.
403
ACT XML Tags
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
404
<parameter>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
405
ACT XML Tags

Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
406
<parameter>
TypeId
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
icon=
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
name=
Type
System_String
408
<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
usage=
Usage of the parameter.
Type
System_String
Remarks
None.
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
version=
Type
System_Int32
Remarks
None.
Examples
None.
410
<parameters>
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<parameters>
Class defining the collection of task parameters.
Remarks
None.
Examples
None.
Tag <Parameter> (p. 411) No details
provided.
<Parameter>
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
<platform>
This class defines the Platform XML Tag.
Remarks
None.
Examples
None.
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)
<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
path=
The platform-supported path (e.g., to an exe)
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
<program>
This class defines the Program XML Tag.
Remarks
None.
414
<program>
Examples
None.
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
<Platform>
The program's supported platforms.
Type
Ansys_ACT_Core_XmlDataModel_Platform (p. 412)
415
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Platform
MinOccurence
1
MaxOccurence
-1
RealParent
None.
Mandatory
True
TypeId
<projectdata>
Remarks
None.
Examples
None.
Tag <DataEntity> (p. 416) No details
provided.
<DataEntity>
Type
Ansys_ACT_Core_XmlDataModel_DataEntity (p. 65)
416
<property>
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_DataEntity
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<property>
Class defining a property of any user object.
Remarks
None.
Examples
None.
Tag
No details provided. (inherited from PropertyBase)
Tag
Callback <GetValue> (p. 421)
Callback that is invoked when the property value

is acquired. (inherited from PropertyBase)
Tag
<help> (p. 422)

property is valid. (inherited from PropertyBase)
Callback <IsVisible> (p. 423)

property is visible. (inherited from PropertyBase)
417
ACT XML Tags

Callback <OnActivate> (p. 424)
Callback that is invoked when the property is

activated. (inherited from PropertyBase)

added. (inherited from PropertyBase)
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)
state change. (inherited from PropertyBase)
Callback <OnCancel> (p. 429)
Callback that is invoked when the property cancel


duplicated. (inherited from PropertyBase)

hidden. (inherited from PropertyBase)

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 that is invoked when the property version

has been changed. (inherited from PropertyBase)

removed. (inherited from PropertyBase)

shown. (inherited from PropertyBase)
Callback <OnValidate> (p. 437)

validated. (inherited from PropertyBase)
Callback <SetValue> (p. 438)

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)
Caption of the property. (inherited from

PropertyBase)
Class name of the property's controller. (inherited

from PropertyBase)
Control type of the object.
Attribute default= (p. 444)
Default value of the property. (inherited from

PropertyBase)
418
<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)
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.

Unit type of the property (for 'control' equals to

'float' only). (inherited from PropertyBase)
Attribute valuetype= (p. 453)
Property dictionary value type (workflow).

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>
Type
Remarks
None.
Examples
None.
419
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
420
<property>
TypeId
<GetValue>
Callback that is invoked when the property value is acquired. (inherited from PropertyBase)
Type
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
TypeId
421
ACT XML Tags
<help>
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
<IsValid>
Callback that is invoked to determine whether the property is valid. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid
422
<property>
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsVisible>
Callback that is invoked to determine whether the property is visible. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible
Mandatory
False
423
ACT XML Tags

Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnActivate>
Callback that is invoked when the property is activated. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnActivate
424
<property>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Callback that is invoked when the property is added. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
Mandatory
False
Name
OnAdd
Public
True
425
ACT XML Tags

Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Callback that is invoked after the geometry has been updated. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
426
<property>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnApply>
Callback that is invoked when the property apply button is clicked. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
427
ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Callback that is invoked when the body suppress state change. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
428
<property>
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnCancel>
Callback that is invoked when the property cancel button is clicked. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
429
ACT XML Tags

MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Callback that is invoked when the property is duplicated. (inherited from PropertyBase)
Type
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
<property>
RealParent
TypeId
<OnHide>
Callback that is invoked when the property is hidden. (inherited from PropertyBase)
Type
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
431
ACT XML Tags

TypeId
<OnInit>
Callback that is invoked when the property is initialized. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
432
<property>
<OnJournalExecuting>
Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnJournalRecording>
Callback that is invoked before writting the journal for an action. (inherited from PropertyBase)
433
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Callback that is invoked when the property version has been changed. (inherited from PropertyBase)
Type
434
<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
TypeId
<OnRemove>
Callback that is invoked when the property is removed. (inherited from PropertyBase)
Type
Remarks
None.
435
ACT XML Tags
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Callback that is invoked when the property is shown. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
436
<property>
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnValidate>
Callback that is invoked when the property is validated. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
437
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<SetValue>
Callback that is invoked when the property value is set. (inherited from PropertyBase)
Type
Remarks
This callback is useful for transforming the submitted property value.
Examples
None.
438
<property>
Details
CallbackType
Mandatory
False
Name
SetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<String2Value>
Callback that is invoked to convert a string to the property value. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
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
TypeId
<Value2String>
Callback that is invoked to convert the value stored by the property into a string. (inherited from
PropertyBase)
Type
Remarks
None.
Examples
None.
440
<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
TypeId
caption=
Caption of the property. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
441
ACT XML Tags
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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
<property>
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
control=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
control
DefaultValue
None.
443
ACT XML Tags

DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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
<property>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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.
445
ACT XML Tags

Public
True
Description
None.
TypeId
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
<property>
TypeId
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
name=
Name of the property. (inherited from PropertyBase)
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
needupdate=
Indicates whether the context must be refreshed when the property value changes. (inherited from
PropertyBase)
Type
System_Boolean
448
<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
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.
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
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
<property>
Details
Mandatory
False
Name
persistent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
readonly=
Indicates whether the property is read-only. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
451
ACT XML Tags

Name
readonly
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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
<property>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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.
453
ACT XML Tags

MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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
<property>
Public
True
Description
None.
TypeId
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
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
visibleon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
455
ACT XML Tags

TypeId
<propertygroup>
Class defining a collection of properties.
Remarks
None.
Examples
None.
Tag
Tag

Tag
<help> (p. 460)











PropertyBase)
456
<propertygroup>





Tag
<PropertyGroup> (p. 477)



from PropertyBase)

PropertyBase)

from PropertyBase)

PropertyBase)
Attribute display= (p. 484)
Display type of the property group.

from PropertyBase)


from PropertyBase)

PropertyBase)

PropertyBase)

from PropertyBase)

PropertyBase)
457
ACT XML Tags





from PropertyBase)

<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
458
<propertygroup>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<GetValue>
Type
Remarks
Examples
None.
Details
CallbackType
459
ACT XML Tags

Mandatory
False
Name
GetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<help>
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Public
True
460
<propertygroup>
Name
help
ValueName
None.
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
461
ACT XML Tags

RealParent
TypeId
<IsVisible>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
462
<propertygroup>
TypeId
<OnActivate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnActivate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
463
ACT XML Tags
<OnAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
464
<propertygroup>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnApply>
Type
465
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
466
<propertygroup>
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnCancel>
Type
Remarks
None.
Examples
None.
467
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
468
<propertygroup>
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
469
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
None.
Examples
None.
470
<propertygroup>
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
471
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
472
<propertygroup>
Details
CallbackType
Mandatory
False
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
473
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
474
<propertygroup>
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
475
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnValidate>
Type
Remarks
None.
Examples
None.
476
<propertygroup>
Details
CallbackType
Mandatory
False
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<PropertyGroup>
Type
Ansys_ACT_Core_XmlDataModel_PropertyGroup (p. 456)
Remarks
None.
Examples
None.
477
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_PropertyGroup
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<SetValue>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
SetValue
Public
True
Obsolete
False
478
<propertygroup>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<String2Value>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
String2Value
Public
True
Obsolete
False
ObsoleteMessage
None.
479
ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Value2String>
PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
480
<propertygroup>
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
481
ACT XML Tags

Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
482
<propertygroup>
TypeId
control=
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
default=
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
display=
Type
Ansys_ACT_Interfaces_UserObject_PropertyDisplayEnum
484
<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
elementtype=
Type
System_String
Remarks
None.
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
isparameter=
Type
System_Boolean
Remarks
None.
Examples
None.
486
<propertygroup>
Details
Mandatory
False
Name
isparameter
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
keytype=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
487
ACT XML Tags

Name
keytype
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
488
<propertygroup>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
needupdate=
PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
needupdate
DefaultValue
True
DataDefinition
False
AllowedValues
None.
489
ACT XML Tags

MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
parameterizable=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
parameterizable
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
490
<propertygroup>
MappedValues
None.
Public
True
Description
None.
TypeId
persistent=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
persistent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
491
ACT XML Tags

Description
None.
TypeId
readonly=
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
492
<propertygroup>
unit=
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
valuetype=
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
visible=
Type
System_Boolean
494
<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
visibleon=
Type
Remarks
None.
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
<propertytable>
Class encapsulateing a list of child properties under one table.
Remarks
None.
Examples
None.
Tag
Tag
496
<propertytable>

Tag
<help> (p. 501)











PropertyBase)





Tag
<PropertyGroup> (p. 518)


497
ACT XML Tags


from PropertyBase)
Attribute allowempty= (p. 522)
Unit type of the property (for float control).

PropertyBase)

from PropertyBase)

PropertyBase)
Attribute display= (p. 526)

from PropertyBase)


from PropertyBase)

PropertyBase)

PropertyBase)

from PropertyBase)

PropertyBase)




from PropertyBase)

498
<propertytable>
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
499
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<GetValue>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
GetValue
Public
True
Obsolete
False
500
<propertytable>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<help>
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Public
True
Name
help
ValueName
None.
TypeId
<IsValid>
501
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsVisible>
Type
502
<propertytable>
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnActivate>
Type
Remarks
None.
503
ACT XML Tags
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnActivate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
None.
Examples
None.
504
<propertytable>
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
505
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnApply>
Type
Remarks
None.
Examples
None.
506
<propertytable>
Details
CallbackType
Mandatory
False
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
507
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnCancel>
Type
Remarks
None.
Examples
None.
508
<propertytable>
Details
CallbackType
Mandatory
False
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
509
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
510
<propertytable>
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
None.
Examples
None.
511
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
512
<propertytable>
Details
CallbackType
Mandatory
False
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
513
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
514
<propertytable>
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
515
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
516
<propertytable>
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnValidate>
Type
Remarks
None.
Examples
None.
517
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<PropertyGroup>
Type
Ansys_ACT_Core_XmlDataModel_PropertyGroup (p. 456)
Remarks
None.
Examples
None.
518
<propertytable>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_PropertyGroup
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<SetValue>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
SetValue
Public
True
Obsolete
False
519
ACT XML Tags

ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<String2Value>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
String2Value
Public
True
Obsolete
False
ObsoleteMessage
None.
520
<propertytable>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Value2String>
PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
521
ACT XML Tags

MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
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
<propertytable>
Description
None.
TypeId
caption=
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
523
ACT XML Tags
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
control=
524
<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
default=
Type
System_String
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
display=
Type
Ansys_ACT_Interfaces_UserObject_PropertyDisplayEnum
Remarks
None.
526
<propertytable>
Examples
None.
Details
Mandatory
False
Name
display
DefaultValue
Caption
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
elementtype=
Type
System_String
Remarks
None.
Examples
None.
527
ACT XML Tags
Details
Mandatory
False
Name
elementtype
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
isparameter=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
528
<propertytable>
Name
isparameter
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
keytype=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
keytype
DefaultValue
None.
529
ACT XML Tags

DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
530
<propertytable>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
needupdate=
PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
needupdate
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
531
ACT XML Tags

Public
True
Description
None.
TypeId
parameterizable=
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
<propertytable>
Description
None.
TypeId
persistent=
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
533
ACT XML Tags
readonly=
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
unit=
534
<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
valuetype=
Type
System_String
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
visible=
Type
System_Boolean
Remarks
None.
536
<propertytable>
Examples
None.
Details
Mandatory
False
Name
visible
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visibleon=
Type
Remarks
None.
Examples
None.
537
ACT XML Tags
Details
Mandatory
False
Name
visibleon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
<Result>
Class defining a result.
Remarks
None.
Examples
None.
Tag
Tag


538
<Result>

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 that is invoked to get the values

associated to a node or an element given by its
ID.





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 <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.
539
ACT XML Tags



Tag
<Property> (p. 567)
Attribute averaging= (p. 568)
Averaging of the result.


Attribute hasimaginary= (p. 571)
Indicates whether the result supports imaginary

values.
Attribute location= (p. 573)
Location of the result.
Attribute timehistory= (p. 575)
Indicates whether the time history has to be

calculated.
Type of the result.
Unit used by the contour display.
<Action>
Type
List_Action_
Remarks
None.
Examples
None.
Details
CallbackType
None.
Mandatory
False
Name
Action
540
<Result>
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
541
ACT XML Tags

Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
542
<Result>
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
543
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
544
<Result>
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Evaluate>
Callback that is invoked when the step described by stepInfo is evaluated.
Type
Remarks
None.
Examples
None.
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
TypeId
<GetFieldCount>
Callback that is invoked to get the number of fields for a given element or node ID.
Type
Remarks
None.
Examples
None.
546
<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
TypeId
<GetValue>
Callback that is invoked to get the values associated to a node or an element given by its ID.
Type
Remarks
None.
Examples
None.
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
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
548
<Result>
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
549
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
550
<Result>
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
551
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
552
<Result>
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
553
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnEndEval>
Callback that is invoked at the end of the evaluation process for a given step.
Type
Remarks
None.
Examples
None.
554
<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
TypeId
<OnEndPost>
Callback that is invoked at the end of the post process.
Type
Remarks
None.
Examples
None.
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
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
556
<Result>
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
557
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
Examples
None.
558
<Result>
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
559
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
560
<Result>
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
561
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
562
<Result>
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnStartEval>
Callback that is invoked when the evaluation process for a given step starts.
Type
Remarks
None.
Examples
None.
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
TypeId
<OnStartPost>
Callback that is invoked when the post process starts.
Type
Remarks
None.
Examples
None.
564
<Result>
Details
CallbackType
ActionCallback_IUserResult_
Mandatory
False
Name
OnStartPost
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
565
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
566
<Result>
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
None.
Examples
None.
567
ACT XML Tags
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
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
<Result>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
569
ACT XML Tags

Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
570
<Result>
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
hasimaginary=
Indicates whether the result supports imaginary values.
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
icon=
Type
System_String
572
<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
location=
Location of the result.
Type
Ansys_ACT_Interfaces_Post_ResultLocationEnum
Remarks
None.
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
name=
Type
System_String
Remarks
None.
Examples
None.
574
<Result>
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
timehistory=
Indicates whether the time history has to be calculated.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
575
ACT XML Tags

Name
timehistory
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
type=
Type of the result.
Type
Ansys_ACT_Interfaces_Post_ResultTypeEnum
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
type
DefaultValue
None.
576
<Result>
DataDefinition
False
AllowedValues
System.String[]
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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.
577
ACT XML Tags

MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
578
<rsmjob>
Public
True
Description
None.
TypeId
<rsmjob>
This class defines an rsm job.
Remarks
None.
Examples
None.
Tag
Tag



Tag
The job input files.
<InputFile> (p. 585)




Callback <oncreatejobinput> (p. 590)
This callback handles the generation of all input

files defined on the rsm job.


579
ACT XML Tags



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.






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)


Attribute deletefiles= (p. 609)
Indicates whether ACT should delete all rsmJob

input and output files upon successful completion
or job cancellation.
<Attributes>
580
<rsmjob>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
581
ACT XML Tags

MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
582
<rsmjob>
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
583
ACT XML Tags

MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
584
<rsmjob>
RealParent
TypeId
<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
<IsValid>
Type
Remarks
None.
585
ACT XML Tags
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
586
<rsmjob>
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
587
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
588
<rsmjob>
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
589
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<oncreatejobinput>
This callback handles the generation of all input files defined on the rsm job.
Type
Remarks
None.
Examples
None.
590
<rsmjob>
Details
CallbackType
ActionCallback_IUserObject__List_string__
Mandatory
True
Name
oncreatejobinput
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
1
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
591
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
592
<rsmjob>
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
593
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
Examples
None.
594
<rsmjob>
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onjobcancellation>
This callback handles a user-invoked job cancellation.
Type
Remarks
None.
Examples
None.
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
TypeId
<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
Remarks
None.
Examples
None.
596
<rsmjob>
Details
CallbackType
ActionCallback_IUserObject__List_string__
Mandatory
True
Name
onjobreconnect
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
1
MaxOccurence
-1
RealParent
TypeId
<onjobstatus>
This callback handles the status polling engaged by the Framework. Return True to indicate the job has
completed.
Type
Remarks
None.
Examples
None.
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
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
598
<rsmjob>
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
599
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
600
<rsmjob>
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
601
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
602
<rsmjob>
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
603
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OutputFile>
The job output files.
Type
Ansys_ACT_Core_XmlDataModel_OutputFile (p. 373)
Remarks
None.
Examples
None.
604
<rsmjob>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_OutputFile
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<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
605
ACT XML Tags

TypeId
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
606
<rsmjob>
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
607
ACT XML Tags

Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
608
<rsmjob>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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.
609
ACT XML Tags

MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
610
<rsmjob>
Public
True
Description
None.
TypeId
name=
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.
611
ACT XML Tags

TypeId
version=
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
<Sampling>
Class defining a DesignXxplorer Sampling. <code><sampling>...</sampling></code>
612
<Sampling>
Remarks
None.
Examples
None.
Tag

SimEntity)
Tag

SimEntity)
Callback that is invoked to determine

whether the object can be added.

the object can be duplicated. (inherited
from SimEntity)

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)

userreadable string summarizing the
current configuration of the optimizer
(or the sampling). (inherited from
DesignExplorer)
Callback <Description> (p. 622)

optimizer and its specific capabilities.
Callback <InputParametersEdited> (p. 623)

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

the object is valid. (inherited from
SimEntity)
Callback <MethodPropertiesEdited> (p. 625)

properties of the optimization method
have changed. (inherited from
DesignExplorer)
613
ACT XML Tags


is newly added. (inherited from
SimEntity)

geometry has been updated. (inherited
from SimEntity)
Callback <OnBodySuppressStateChange> (p. 627)
Callback that is invoked when the body

suppress state changse. (inherited from
SimEntity)

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)

is duplicated. (inherited from SimEntity)

data are generated. (inherited from
SimEntity)

is hidden. (inherited from SimEntity)

is initialized. (inherited from SimEntity)

version has been changed. (inherited
from SimEntity)

application is fully loaded and in a
"ready" state. (Inherited from SimEntity)
Callback <OnRelease> (p. 636)
Callback that is invoked to release the

IOptimizationMethod (or the
ISamplingMethod) instance. (inherited

is removed. (inherited from SimEntity)

is shown. (inherited from SimEntity)

is suppressed. (inherited from SimEntity)

is unsuppressed. (inherited from
SimEntity)
Tag

SimEntity)
614
<Property> (p. 641)
<Sampling>
Callback <QuickHelp> (p. 642)

user-readable string helping to
understand the state of the optimizer
(or the sampling) when CanRun is false.
Callback <Status> (p. 643)

status of the optimization (or the
sampling) resolution. (inherited from
DesignExplorer)
Caption of the object. (inherited from

SimEntity)
Class name of the controller of the

object. (inherited from SimEntity)
Indicates whether the object has to be

displayed in the contextual menu.
Attribute CustomTable= (p. 646)
Supports custom table points.
Icon for the object. (inherited from

SimEntity)
Attribute logfile= (p. 648)
Provides messages to generate a log file.

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

double list parameters supported.
Attribute maximumnumberofdoubleparameters= (p. 650)
Indicates the maximum number of

double parameters supported. (inherited
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.
Name of the object. (inherited from

SimEntity)
Version of the object. (inherited from

SimEntity)
<Attributes>
Type
615
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
616
<Sampling>
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
617
ACT XML Tags

RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
618
<Sampling>
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
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
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
TypeId
620
<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
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Configuration
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
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
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Description
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
622
<Sampling>
<InputParametersEdited>
Callback that is invoked when the properties of input parameters have changed. (inherited from DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
InputParametersEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
623
ACT XML Tags
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
624
<Sampling>
<MethodPropertiesEdited>
Callback that is invoked when the properties of the optimization method have changed. (inherited from
DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
MethodPropertiesEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
625
ACT XML Tags
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
626
<Sampling>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
627
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Type
Remarks
None.
628
<Sampling>
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnCreate>
Callback that is invoked to provide an instance of IOptimizationMethod (or ISamplingMethod). (inherited
Type
Remarks
None.
629
ACT XML Tags
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
630
<Sampling>
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
631
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
632
<Sampling>
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
Examples
None.
633
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
634
<Sampling>
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
635
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRelease>
Callback that is invoked to release the IOptimizationMethod (or the ISamplingMethod) instance. (inherited
Type
Remarks
None.
Examples
None.
636
<Sampling>
Details
CallbackType
Mandatory
False
Name
OnRelease
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
637
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
638
<Sampling>
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
639
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
640
<Sampling>
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
None.
Examples
None.
641
ACT XML Tags
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<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
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
QuickHelp
Public
True
Obsolete
False
642
<Sampling>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<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
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Status
Public
True
Obsolete
False
ObsoleteMessage
None.
643
ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
644
<Sampling>
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
645
ACT XML Tags

TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
CustomTable=
Supports custom table points.
646
<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
icon=
Type
System_String
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
logfile=
Provides messages to generate a log file. (inherited from DesignExplorer)
Type
System_Boolean
Remarks
None.
648
<Sampling>
Examples
None.
Details
Mandatory
False
Name
logfile
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
maximumnumberofdoublelistparameters=
Indicates the maximum number of double list parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
649
ACT XML Tags
Details
Mandatory
False
Name
maximumnumberofdoublelistparameters
DefaultValue
100
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
maximumnumberofdoubleparameters=
Indicates the maximum number of double parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
650
<Sampling>
Name
maximumnumberofdoubleparameters
DefaultValue
100
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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
651
ACT XML Tags

DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
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
<Sampling>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
653
ACT XML Tags

Public
True
Description
None.
TypeId
version=
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
<script>
TypeId
<script>
Specifies the IronPython script referenced by the extension.
Remarks
None.
Examples
None.
Attribute compiled= (p. 655) Specifies whether the script will be compiled as a
binary file.
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
655
ACT XML Tags

AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
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
<simdata>
Public
True
Description
None.
TypeId
<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.
Tag
<Object> (p. 657) No details provided.
Attribute context= (p. 658) Context or combination of contexts (separated

using '|').
<Object>
Type
Ansys_ACT_Core_XmlDataModel_Object (p. 266)
Remarks
None.
657
ACT XML Tags
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Object
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
context=
Context or combination of contexts (separated using '|').
Type
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
<Solver>
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
<Solver>
Class specifying a third-party solver to be used in the simulation.
Remarks
None.
Examples
None.
Tag
Tag



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)

analysis is valid.
659
ACT XML Tags




Callback <OnBeforeSolve> (p. 671)
Callback that is invoked before the solve process.
Callback <OnCheckResults> (p. 673)
Callback that is invoked before any post-processing

evaluation.









Callback <OnSolve> (p. 683)
Callback that is invoked when the solve process

is run.


Callback <OnWriteInputFile> (p. 686)
Callback that is invoked to write the solver input

file.
Tag
<Property> (p. 687)
Attribute analysis= (p. 688)
Type of analysis.


660
<Solver>
Attribute physics= (p. 693)
Type of physics.
Attribute toolbox= (p. 694)
Name of the toolbox.
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
661
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanAdd
662
<Solver>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanDuplicate
Public
True
663
ACT XML Tags

Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
664
<Solver>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetFiles>
Callback that is invoked to return a list of file strings used by a custom solver.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetFiles
Mandatory
False
Name
GetFiles
Public
False
Obsolete
False
ObsoleteMessage
None.
665
ACT XML Tags

ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetReader>
Callback that is invoked to get the reader class name and associated options.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetReader
Mandatory
False
Name
GetReader
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
666
<Solver>
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<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
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
667
ACT XML Tags

MaxOccurence
-1
RealParent
TypeId
<IsAnalysisValid>
Callback that is invoked to determine whether the analysis is valid.
Type
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
<Solver>
RealParent
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
669
ACT XML Tags

TypeId
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
670
<Solver>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnBeforeSolve>
Callback that is invoked before the solve process.
671
ACT XML Tags
Type
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
TypeId
Type
672
<Solver>
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnCheckResults>
Callback that is invoked before any post-processing evaluation.
Type
Remarks
None.
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
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
674
<Solver>
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
675
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
676
<Solver>
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
677
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
Examples
None.
678
<Solver>
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
679
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
680
<Solver>
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
681
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
682
<Solver>
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSolve>
Callback that is invoked when the solve process is run.
Type
Remarks
None.
Examples
None.
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
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
684
<Solver>
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
685
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnWriteInputFile>
Callback that is invoked to write the solver input file.
Type
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
<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
TypeId
<Property>
Type
Remarks
None.
Examples
None.
687
ACT XML Tags
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
analysis=
Type of analysis.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
analysis
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
688
<Solver>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
689
ACT XML Tags

Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
690
<Solver>
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
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
name=
Type
System_String
692
<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
physics=
Type of physics.
Type
System_String
Remarks
None.
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
toolbox=
Name of the toolbox.
Type
System_String
Remarks
None.
Examples
None.
694
<Solver>
Details
Mandatory
False
Name
toolbox
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
695
ACT XML Tags

Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Step>
Class defining a step in a guided process a (wizard or AIM custom template).
Remarks
None.
Examples
None.
Tag
Tag



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










Callback <onrefresh> (p. 714)
Callback that is invoked when the step is

initialized.

Callback <onreset> (p. 716)
Callback that is invoked when we return to the

previous step.



Callback <onupdate> (p. 720)
Callback that is invoked when the step is finalized.
Tag
<Property> (p. 721)

Attribute Context= (p. 724)
Gets or sets the context name.

Attribute Enabled= (p. 725)
Gets or sets the Enabled flag.
697
ACT XML Tags

Attribute helpFile= (p. 726)
File containing help HTML content.
Attribute Layout= (p. 728)
Gets or sets the layout to use for this step.
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
698
<Step>
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanAdd
699
ACT XML Tags

Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanDuplicate
Public
True
700
<Step>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
701
ACT XML Tags

ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<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
702
<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
<Description>
Gets or sets the description of the step.
Type
System_String
Remarks
None.
Examples
None.
703
ACT XML Tags
Details
Description
None.
Public
True
Name
Description
ValueName
None.
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
704
<Step>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
705
ACT XML Tags

MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
706
<Step>
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
707
ACT XML Tags

RealParent
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
708
<Step>
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
709
ACT XML Tags
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
710
<Step>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
711
ACT XML Tags
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
712
<Step>
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
713
ACT XML Tags
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onrefresh>
Callback that is invoked when the step is initialized.
Type
Remarks
None.
Examples
None.
714
<Step>
Details
CallbackType
ActionCallback_IWizardStep_
Mandatory
False
Name
onrefresh
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
715
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onreset>
Callback that is invoked when we return to the previous step.
Type
Remarks
None.
Examples
None.
716
<Step>
Details
CallbackType
Mandatory
False
Name
onreset
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
717
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
718
<Step>
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
719
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onupdate>
Callback that is invoked when the step is finalized.
Type
Remarks
None.
Examples
None.
720
<Step>
Details
CallbackType
Mandatory
False
Name
onupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
None.
Examples
None.
721
ACT XML Tags
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
722
<Step>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
723
ACT XML Tags

Public
True
Description
None.
TypeId
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
<Step>
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Enabled=
Gets or sets the Enabled flag.
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
helpFile=
File containing help HTML content.
Type
System_String
726
<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
icon=
Type
System_String
Remarks
None.
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
Layout=
Gets or sets the layout to use for this step.
Type
System_String
Remarks
None.
Examples
None.
728
<Step>
Details
Mandatory
False
Name
Layout
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
729
ACT XML Tags

Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
730
<Target>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Target>
Class defining the target location for the object.
Remarks
None.
Examples
None.
Attribute location= (p. 731) Sub-type of the target location when
ype==Analysis.
Name of the parent.
Type of the target location.
location=
Sub-type of the target location when ype==Analysis.
Type
Ansys_ACT_Interfaces_UserObject_ObjectLocationEnum
Remarks
None.
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
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
<Target>
Details
Mandatory
False
Name
name
DefaultValue
Default
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
type=
Type of the target location.
Type
Ansys_ACT_Interfaces_UserObject_ObjectTypeEnum
Remarks
None.
Examples
None.
Details
Mandatory
True
733
ACT XML Tags

Name
type
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<task>
Class defining a task that encapsulates a single process or application.
Remarks
None.
Examples
None.
Tag
Tag

Callback <canconsumedata> (p. 738)
Callback that is invoked for task

connection/consumption.


Tag
The user-defined custom context menu entries.
734
<ContextMenus> (p. 741)
<task>
Tag
<Inputs> (p. 742)
User-defined task input connections.




Callback <ondelete> (p. 747)
Callback that is invoked for task deletion.

Callback <onedit> (p. 749)
Callback that is invoked for task EDIT entry.



Callback <oninitialize> (p. 753)
Callback that is invoked for task creation.


Callback <onrefresh> (p. 756)
Callback that is invoked for task refresh.

Callback <onreport> (p. 758)
Callback that is invoked for task reporting.
Callback <onreset> (p. 759)
Callback that is invoked for task reset.

Callback <onstatus> (p. 761)
Callback that is invoked for task status.


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)
735
ACT XML Tags

Tag
<RsmJob> (p. 767)
List of task-level RSM Jobs.


Attribute enableGenericTransfer= (p. 771)
Indicates whether or not the task should expose

the general transfer type as an output.
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
736
<task>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
737
ACT XML Tags

Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<canconsumedata>
Callback that is invoked for task connection/consumption.
Type
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__IUserObject__bool_
Mandatory
False
738
<task>
Name
canconsumedata
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanDuplicate
739
ACT XML Tags

Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
740
<task>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<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
741
ACT XML Tags

TypeId
<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
<IsValid>
Type
Remarks
None.
Examples
None.
742
<task>
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
743
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
744
<task>
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
745
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
746
<task>
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<ondelete>
Callback that is invoked for task deletion.
Type
Remarks
None.
Examples
None.
747
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
ondelete
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
748
<task>
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onedit>
Callback that is invoked for task EDIT entry.
Type
Remarks
None.
Examples
None.
749
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
onedit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
750
<task>
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
751
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
Examples
None.
752
<task>
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<oninitialize>
Callback that is invoked for task creation.
Type
Remarks
None.
Examples
None.
753
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
oninitialize
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
754
<task>
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
755
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onrefresh>
Callback that is invoked for task refresh.
Type
Remarks
None.
Examples
None.
756
<task>
Details
CallbackType
Mandatory
False
Name
onrefresh
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
757
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onreport>
Callback that is invoked for task reporting.
Type
Remarks
None.
Examples
None.
758
<task>
Details
CallbackType
ActionCallback_IUserObject__object_
Mandatory
False
Name
onreport
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onreset>
Callback that is invoked for task reset.
Type
Remarks
None.
Examples
None.
759
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
onreset
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
760
<task>
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onstatus>
Callback that is invoked for task status.
Type
Remarks
None.
Examples
None.
761
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
onstatus
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
762
<task>
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
763
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onupdate>
Callback that is invoked for task update.
Type
Remarks
None.
Examples
None.
764
<task>
Details
CallbackType
Mandatory
False
Name
onupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Outputs>
User-defined task output connections.
Type
Ansys_ACT_Core_XmlDataModel_Outputs (p. 375)
Remarks
None.
Examples
None.
765
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Outputs
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<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
<task>
TypeId
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<RsmJob>
List of task-level RSM Jobs.
Type
Ansys_ACT_Core_XmlDataModel_RsmJob (p. 579)
Remarks
Currently only one entry is allowed.
Examples
None.
767
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_RsmJob
MinOccurence
0
MaxOccurence
1
RealParent
None.
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
768
<task>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
769
ACT XML Tags

Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
770
<task>
TypeId
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
icon=
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
name=
Type
System_String
772
<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
version=
Type
System_Int32
Remarks
None.
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
<taskgroup>
Class defining a collection of tasks.
Remarks
None.
Examples
None.
Tag
Tag
774
<taskgroup>



Tag
<IncludeGroup> (p. 780)
The task group's List of nested task groups.
Tag
<IncludeTask> (p. 781)
List of tasks for the task group.














Tag
<Property> (p. 796)
Attribute abbreviation= (p. 797)
Task group abbreviation used for directory and

naming purposes.
Attribute category= (p. 799)
Category to which the task group applies.
775
ACT XML Tags



Attribute isparametricgroup= (p. 802)
Indicates whether the taskgroup operates only on

parameters.
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
776
<taskgroup>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
777
ACT XML Tags

Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
778
<taskgroup>
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanRemove
779
ACT XML Tags

Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<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
<taskgroup>
Mandatory
False
TypeId
<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
<IsValid>
Type
Remarks
None.
781
ACT XML Tags
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
782
<taskgroup>
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
783
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
784
<taskgroup>
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
785
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
786
<taskgroup>
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
787
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
788
<taskgroup>
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Type
Remarks
Examples
None.
789
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
790
<taskgroup>
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
791
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
792
<taskgroup>
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
793
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
794
<taskgroup>
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
795
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
None.
Examples
None.
796
<taskgroup>
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
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.
797
ACT XML Tags

MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
798
<taskgroup>
Public
True
Description
None.
TypeId
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.
799
ACT XML Tags

TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
800
<taskgroup>
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
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
isparametricgroup=
Indicates whether the taskgroup operates only on parameters.
Type
System_Boolean
802
<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
name=
Type
System_String
Remarks
None.
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
version=
Type
System_Int32
Remarks
None.
Examples
None.
804
<taskgroups>
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<taskgroups>
Class defining the task groups collection.
Remarks
None.
Examples
None.
Tag <TaskGroup> (p. 805) No details
provided.
<TaskGroup>
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
<tasks>
Class defining the tasks collection.
Remarks
None.
Examples
None.
Tag <Task> (p. 806) No details
provided.
<Task>
806
<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
<Templates>
Class defining a collection of control templates.
Remarks
None.
Examples
None.
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.
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
<toolbar>
Class defining a toolbar in the UI of the application.
Remarks
None.
Examples
None.
Tag
<Separator> (p. 809) Separator for the

toolbar.
Caption of the
toolbar.
Name of the
toolbar.
808
<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
caption=
Caption of the toolbar.
Type
System_String
Remarks
None.
Examples
None.
809
ACT XML Tags
Details
Mandatory
False
MultipleValue
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the toolbar.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
810
<UIDefinition>
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
<UIDefinition>
Class defining a set of interface layouts that can be used for guided processes (wizards).
Remarks
None.
Examples
None.
Tag <ComponentDefinition> (p. 811) No details
provided.
Tag <Layout> (p. 812)
No details
provided.
Type
Ansys_ACT_Core_XmlDataModel_UI_ComponentDefinition (p. 52)
811
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Layout>
Type
Ansys_ACT_Core_XmlDataModel_UI_Layout (p. 224)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
812
<Wizard>
RealParent
None.
Mandatory
False
TypeId
<Wizard>
Class defining a guided process (a wizard or AIM custom template) within the extension.
Remarks
None.
Examples
None.
Tag
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)
Caption of the wizard.
Icon for the wizard.
Attribute layout= (p. 819)
Layout to be used to display the wizard.
Name of the wizard.
Major version of the wizard.
<Callbacks>
Type
Remarks
None.
813
ACT XML Tags
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<canstart>
Callback that is invoked to determine whether the wizard can be started.
Type
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_string__bool_
Name
canstart
Public
True
Obsolete
False
814
<Wizard>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<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
815
ACT XML Tags
<Step>
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
caption=
Caption of the wizard.
Type
System_String
Remarks
None.
Examples
None.
816
<Wizard>
Details
Mandatory
False
MultipleValue
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
context=
Type
Remarks
This block will be taken into account only for the specified context(s).
Examples
None.
Details
Mandatory
True
817
ACT XML Tags

MultipleValue
True
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Icon for the wizard.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
icon
818
<Wizard>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
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
819
ACT XML Tags

AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
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
<Wizard>
Public
True
Description
None.
TypeId
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.
821
ACT XML Tags

TypeId
<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.
Tag
Tag






Callback <onaftertaskcanduplicate> (p. 831)
Callback that is invoked after a task determines

duplication viability.
Callback <onaftertaskcanusetransfer> (p. 832)

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)

duplicated.
Callback <onaftertaskpropertyretrieval> (p. 836) CCallback that is invoked after a task provides its
property-containing objects.
Callback <onaftertaskrefresh> (p. 837)

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
<Workflow>
Callback <onaftertaskstatus> (p. 840)

its status.
Callback <onaftertaskupdate> (p. 841)

updated.
Callback <onbeforetaskcanduplicate> (p. 842)
Callback that is invoked before a task determines

duplication viability.
Callback <onbeforetaskcanusetransfer> (p. 843)

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)

its status.
Callback <onbeforetaskupdate> (p. 852)
Callback that is invoked before a task is updated.










823
ACT XML Tags


Tag
<Property> (p. 865)
Tag
<TaskGroups> (p. 866)
Task groupings to be exposed as organized blocks

within the workflow.
Tag
<Tasks> (p. 867)
Tasks xposed by this workflow.

Contexts (application) to which this workflow

applies.

<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
824
<Workflow>
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
825
ACT XML Tags
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
826
<Workflow>
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
827
ACT XML Tags
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
828
<Workflow>
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAdd>
Type
Remarks
Examples
None.
829
ACT XML Tags
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
830
<Workflow>
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskcanduplicate>
Callback that is invoked after a task determines duplication viability.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 370)
Remarks
None.
Examples
None.
831
ACT XML Tags
Details
CallbackType
FuncCallback_object__object_
Name
onaftertaskcanduplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskcanusetransfer>
Callback that is invoked after a task determines transfer data viability.
Type
Remarks
None.
Examples
None.
832
<Workflow>
Details
CallbackType
FuncCallback_IUserObject__IUserObject__object__object_
Name
onaftertaskcanusetransfer
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskcreation>
Callback that is invoked after a task has been created.
Type
Remarks
None.
Examples
None.
833
ACT XML Tags
Details
CallbackType
Name
onaftertaskcreation
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskdeletion>
Callback that is invoked after a task is deleted.
Type
Remarks
None.
Examples
None.
834
<Workflow>
Details
CallbackType
Name
onaftertaskdeletion
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskduplicate>
Callback that is invoked after a task has been duplicated.
Type
Remarks
None.
Examples
None.
835
ACT XML Tags
Details
CallbackType
Name
onaftertaskduplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskpropertyretrieval>
CCallback that is invoked after a task provides its property-containing objects.
Type
Remarks
None.
Examples
None.
836
<Workflow>
Details
CallbackType
FuncCallback_IUserObject__object__object_
Name
onaftertaskpropertyretrieval
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskrefresh>
Callback that is invoked after a task has been refreshed.
Type
Remarks
None.
Examples
None.
837
ACT XML Tags
Details
CallbackType
Name
onaftertaskrefresh
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskreset>
Callback that is invoked after a task has been reset.
Type
Remarks
None.
Examples
None.
838
<Workflow>
Details
CallbackType
Name
onaftertaskreset
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertasksourceschanged>
Callback that is invoked after a task handles a source change.
Type
Remarks
None.
Examples
None.
839
ACT XML Tags
Details
CallbackType
Name
onaftertasksourceschanged
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskstatus>
Callback that is invoked after a task determines its status.
Type
Remarks
None.
Examples
None.
840
<Workflow>
Details
CallbackType
FuncCallback_IUserObject__object__object_
Name
onaftertaskstatus
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskupdate>
Callback that is invoked after a task has been updated.
Type
Remarks
None.
Examples
None.
841
ACT XML Tags
Details
CallbackType
Name
onaftertaskupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskcanduplicate>
Callback that is invoked before a task determines duplication viability.
Type
Remarks
None.
Examples
None.
842
<Workflow>
Details
CallbackType
Name
onbeforetaskcanduplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskcanusetransfer>
Callback that is invoked before a task determines transfer data viability.
Type
Remarks
None.
Examples
None.
843
ACT XML Tags
Details
CallbackType
ActionCallback_IUserObject__IUserObject_
Name
onbeforetaskcanusetransfer
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskcreation>
Callback that is invoked before a task is created.
Type
Remarks
None.
Examples
None.
844
<Workflow>
Details
CallbackType
Name
onbeforetaskcreation
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskdeletion>
Callback that is invoked before a task is deleted.
Type
Remarks
None.
Examples
None.
845
ACT XML Tags
Details
CallbackType
Name
onbeforetaskdeletion
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskduplicate>
Callback that is invoked before a task is duplicated.
Type
Remarks
None.
Examples
None.
846
<Workflow>
Details
CallbackType
Name
onbeforetaskduplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskpropertyretrieval>
Callback that is invoked before a task provides its property-containing objects.
Type
Remarks
None.
Examples
None.
847
ACT XML Tags
Details
CallbackType
Name
onbeforetaskpropertyretrieval
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskrefresh>
Callback that is invoked before a task is refreshed.
Type
Remarks
None.
Examples
None.
848
<Workflow>
Details
CallbackType
Name
onbeforetaskrefresh
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskreset>
Callback that is invoked before a task is reset.
Type
Remarks
None.
Examples
None.
849
ACT XML Tags
Details
CallbackType
Name
onbeforetaskreset
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetasksourceschanged>
Callback that is invoked before a task handles a source change.
Type
Remarks
None.
Examples
None.
850
<Workflow>
Details
CallbackType
Name
onbeforetasksourceschanged
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskstatus>
Callback that is invoked before a task determines its status.
Type
Remarks
None.
Examples
None.
851
ACT XML Tags
Details
CallbackType
Name
onbeforetaskstatus
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskupdate>
Callback that is invoked before a task is updated.
Type
Remarks
None.
Examples
None.
852
<Workflow>
Details
CallbackType
Name
onbeforetaskupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
853
ACT XML Tags
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
854
<Workflow>
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
855
ACT XML Tags
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
856
<Workflow>
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
857
ACT XML Tags
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnInit>
Type
Remarks
Examples
None.
858
<Workflow>
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
859
ACT XML Tags
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
860
<Workflow>
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
861
ACT XML Tags
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
862
<Workflow>
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
863
ACT XML Tags
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
864
<Workflow>
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Property>
Type
Remarks
None.
Examples
None.
865
ACT XML Tags
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<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
<Workflow>
TypeId
<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
caption=
Type
System_String
Remarks
None.
Examples
None.
867
ACT XML Tags
Details
Mandatory
False
MultipleValue
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
868
<Workflow>
MultipleValue
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
context=
Contexts (application) to which this workflow applies.
Type
Remarks
None.
Examples
None.
Details
Mandatory
True
MultipleValue
True
Name
context
869
ACT XML Tags

DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
contextual
DefaultValue
True
DataDefinition
False
870
<Workflow>
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
871
ACT XML Tags

Public
True
Description
None.
TypeId
name=
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
<Workflow>
TypeId
version=
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
873
874

ACT XML Reference Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ACT XML Reference Guide

Uploaded by

Copyright:

Available Formats

ANSYS ACT XML Reference Guide

Copyright and Trademark Information

U.S. Government Rights