ACT XML Reference Guide

ANSYS ACT XML Reference Guide
ANSYS, Inc. Release 17.0

Southpointe January 2016
2600 ANSYS Drive ANSYS Customization
Canonsburg, PA 15317 ANSYS, Inc. is
ansysinfo@ansys.com certified to ISO
9001:2008.
http://www.ansys.com
(T) 724-746-3304
(F) 724-514-9494
Copyright and Trademark Information
2015 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 CONFID-
ENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products
and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement
that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products
and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions
of that software license agreement.
ANSYS, Inc. 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> ............................................................................................................................... 8
<description> ............................................................................................................................ 9
<OnApplicationFinished> ......................................................................................................... 10
<OnApplicationInitialized> ....................................................................................................... 11
<OnApplicationStarted> .......................................................................................................... 12
<Panel> ................................................................................................................................... 13
class= ....................................................................................................................................... 13
context= .................................................................................................................................. 14
MainPanel= .............................................................................................................................. 15
name= ..................................................................................................................................... 16
<argument> ................................................................................................................................... 17
name= ..................................................................................................................................... 17
separator= ................................................................................................................................ 18
value= ...................................................................................................................................... 19
<assembly> .................................................................................................................................... 20
context= .................................................................................................................................. 20
namespace= ............................................................................................................................. 21
src= .......................................................................................................................................... 22
<attributes> ................................................................................................................................... 23
<Callback> ..................................................................................................................................... 23
<CallbackGetCommands> .............................................................................................................. 24
location= .................................................................................................................................. 24
order= ...................................................................................................................................... 25
<CallbackGetPostPreSolveCommands> .......................................................................................... 26
order= ...................................................................................................................................... 26
timedependent= ...................................................................................................................... 27
<CallbackOnActiveObjectChange> ................................................................................................. 28
name= ..................................................................................................................................... 28
type= ....................................................................................................................................... 29
<Callbacks> .................................................................................................................................... 30
<CallbackGetPostPreSolveCommands> .................................................................................... 30
<Component> ............................................................................................................................... 31
<Attributes> ............................................................................................................................. 32
BottomAttachment= ................................................................................................................ 32
BottomOffset= ......................................................................................................................... 33
ComponentType= .................................................................................................................... 34
CustomCSSFile= ....................................................................................................................... 35
CustomHTMLFile= .................................................................................................................... 36
CustomJSFile= .......................................................................................................................... 37
Height= .................................................................................................................................... 38
HeightType= ............................................................................................................................ 39
LeftAttachment= ...................................................................................................................... 40
LeftOffset= ............................................................................................................................... 41
Release 17.0 - 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= ............................................................................................................................. 41
MaxWidth= .............................................................................................................................. 42
name= ..................................................................................................................................... 43
RightAttachment= .................................................................................................................... 44
RightOffset= ............................................................................................................................. 45
TopAttachment= ...................................................................................................................... 46
TopOffset= ............................................................................................................................... 47
visible= .................................................................................................................................... 48
Width= ..................................................................................................................................... 49
WidthType= ............................................................................................................................. 50
<ComponentData> ........................................................................................................................ 50
component= ............................................................................................................................ 51
<ComponentDefinition> ................................................................................................................ 52
Class= ...................................................................................................................................... 52
CSSFile= ................................................................................................................................... 53
DataModelClass= ..................................................................................................................... 54
HTMLFile= ................................................................................................................................ 55
JSFile= ...................................................................................................................................... 56
Name= ..................................................................................................................................... 57
<ComponentStyle> ........................................................................................................................ 57
component= ............................................................................................................................ 58
filter= ....................................................................................................................................... 59
<contextmenus> ............................................................................................................................ 60
<UIEntry> ................................................................................................................................. 60
<ControlTemplate> ........................................................................................................................ 61
<PropertyTable> ...................................................................................................................... 61
name= ..................................................................................................................................... 62
version= ................................................................................................................................... 63
<entity> ......................................................................................................................................... 63
<Attributes> ............................................................................................................................. 65
<Callbacks> .............................................................................................................................. 66
<CanAdd> ................................................................................................................................ 66
<CanDuplicate> ....................................................................................................................... 67
<CanRemove> ......................................................................................................................... 68
<IsValid> .................................................................................................................................. 69
<OnAdd> ................................................................................................................................. 70
<OnAfterGeometryUpdate> ..................................................................................................... 71
<OnBodySuppressStateChange> .............................................................................................. 72
<OnClearData> ........................................................................................................................ 73
<OnDuplicate> ......................................................................................................................... 74
<OnGenerateData> .................................................................................................................. 75
<OnHide> ................................................................................................................................ 76
<OnInit> .................................................................................................................................. 77
<OnMigrate> ........................................................................................................................... 78
<OnReady> .............................................................................................................................. 79
<OnRemove> ........................................................................................................................... 80
<OnShow> ............................................................................................................................... 81
<OnSuppress> ......................................................................................................................... 82
<OnUnsuppress> ..................................................................................................................... 83
<Property> ............................................................................................................................... 84
caption= .................................................................................................................................. 85
class= ....................................................................................................................................... 86
iv of ANSYS, Inc. and its subsidiaries and affiliates.
contextual= .............................................................................................................................. 87
datatype= ................................................................................................................................ 88
icon= ....................................................................................................................................... 88
name= ..................................................................................................................................... 89
version= ................................................................................................................................... 90
<entry> .......................................................................................................................................... 91
<Attributes> ............................................................................................................................. 93
<Callbacks> .............................................................................................................................. 93
<CanAdd> ................................................................................................................................ 94
<CanDuplicate> ....................................................................................................................... 95
<CanRemove> ......................................................................................................................... 96
<IsValid> .................................................................................................................................. 97
<OnAdd> ................................................................................................................................. 98
<OnAfterGeometryUpdate> ..................................................................................................... 99
<OnBodySuppressStateChange> ............................................................................................ 100
<OnClearData> ...................................................................................................................... 101
<onclick> ............................................................................................................................... 102
<OnDuplicate> ....................................................................................................................... 103
<OnGenerateData> ................................................................................................................ 104
<OnHide> .............................................................................................................................. 104
<OnInit> ................................................................................................................................ 105
<OnMigrate> .......................................................................................................................... 106
<OnReady> ............................................................................................................................ 107
<OnRemove> ......................................................................................................................... 108
<OnShow> ............................................................................................................................. 109
<OnSuppress> ....................................................................................................................... 110
<OnUnsuppress> ................................................................................................................... 111
<Property> ............................................................................................................................. 112
caption= ................................................................................................................................ 113
class= ..................................................................................................................................... 114
contextual= ............................................................................................................................ 115
icon= ...................................................................................................................................... 116
name= ................................................................................................................................... 116
priority= ................................................................................................................................. 117
type= ..................................................................................................................................... 118
version= ................................................................................................................................. 119
<entry> ........................................................................................................................................ 120
<Callbacks> ............................................................................................................................ 121
<OnClick> .............................................................................................................................. 121
<Separator> ........................................................................................................................... 122
caption= ................................................................................................................................ 123
Icon= ...................................................................................................................................... 124
name= ................................................................................................................................... 125
userobject= ............................................................................................................................ 126
<Extension> ................................................................................................................................. 126
<Application> ........................................................................................................................ 127
<appStoreId> ......................................................................................................................... 128
<assembly> ............................................................................................................................ 129
<author> ................................................................................................................................ 129
<description> ......................................................................................................................... 130
<Guid> ................................................................................................................................... 131
<Interface> ............................................................................................................................ 131
of ANSYS, Inc. and its subsidiaries and affiliates. v
<Licenses> ............................................................................................................................. 132

<script> ................................................................................................................................. 133
<simdata> .............................................................................................................................. 133
<Templates> .......................................................................................................................... 134
<UIDefinition> ....................................................................................................................... 135
<Wizard> ............................................................................................................................... 135
<Workflow> ........................................................................................................................... 136
debug= .................................................................................................................................. 137
icon= ...................................................................................................................................... 137
loadAsDefault= ....................................................................................................................... 138
masked= ................................................................................................................................ 139
minorversion= ........................................................................................................................ 140
name= ................................................................................................................................... 141
version= ................................................................................................................................. 142
<extensionobject> ....................................................................................................................... 143
<Attributes> ........................................................................................................................... 144
<Callbacks> ............................................................................................................................ 145
<CanAdd> .............................................................................................................................. 146
<CanDuplicate> ..................................................................................................................... 147
<CanRemove> ........................................................................................................................ 148
<HostObjectModified> ........................................................................................................... 149
<IsValid> ................................................................................................................................ 150
<OnAdd> ............................................................................................................................... 151
<OnAfterGeometryUpdate> ................................................................................................... 151
<OnClearData> ...................................................................................................................... 153
<OnDuplicate> ....................................................................................................................... 154
<OnGenerateData> ................................................................................................................ 155
<OnHide> .............................................................................................................................. 156
<OnInit> ................................................................................................................................ 157
<OnMigrate> .......................................................................................................................... 158
<OnReady> ............................................................................................................................ 159
<OnRemove> ......................................................................................................................... 160
<OnShow> ............................................................................................................................. 161
<OnSuppress> ....................................................................................................................... 162
<OnUnsuppress> ................................................................................................................... 163
<Property> ............................................................................................................................. 164
<Target> ................................................................................................................................ 165
caption= ................................................................................................................................ 166
class= ..................................................................................................................................... 166
contextual= ............................................................................................................................ 167
icon= ...................................................................................................................................... 168
name= ................................................................................................................................... 169
version= ................................................................................................................................. 170
<filter> ......................................................................................................................................... 171
name= ................................................................................................................................... 171
src= ........................................................................................................................................ 172
<Geometry> ................................................................................................................................. 173
<Attributes> ........................................................................................................................... 175
<Callbacks> ............................................................................................................................ 175
<CanAdd> .............................................................................................................................. 176
<CanDuplicate> ..................................................................................................................... 177
vi of ANSYS, Inc. and its subsidiaries and affiliates.
<CanRemove> ........................................................................................................................ 178

<IsValid> ................................................................................................................................ 179
<OnAdd> ............................................................................................................................... 180
<OnAfterGenerate> ................................................................................................................ 181
<OnClearData> ...................................................................................................................... 184
<OnDuplicate> ....................................................................................................................... 185
<OnEdit> ............................................................................................................................... 186
<OnGenerate> ....................................................................................................................... 186
<OnGenerateData> ................................................................................................................ 187
<OnHide> .............................................................................................................................. 188
<OnInit> ................................................................................................................................ 189
<OnMigrate> .......................................................................................................................... 190
<OnReady> ............................................................................................................................ 191
<OnRemove> ......................................................................................................................... 192
<OnShow> ............................................................................................................................. 193
<OnSuppress> ....................................................................................................................... 194
<OnUnsuppress> ................................................................................................................... 195
<Property> ............................................................................................................................. 196
caption= ................................................................................................................................ 197
class= ..................................................................................................................................... 198
contextual= ............................................................................................................................ 199
icon= ...................................................................................................................................... 200
name= ................................................................................................................................... 200
version= ................................................................................................................................. 201
<guid> ......................................................................................................................................... 202
shortid= ................................................................................................................................. 203
<includegroup> ........................................................................................................................... 204
caption= ................................................................................................................................ 204
external= ................................................................................................................................ 205
name= ................................................................................................................................... 206
<includetask> .............................................................................................................................. 207
caption= ................................................................................................................................ 207
external= ................................................................................................................................ 208
name= ................................................................................................................................... 209
<input> ........................................................................................................................................ 210
count= ................................................................................................................................... 210
format= .................................................................................................................................. 211
type= ..................................................................................................................................... 212
<inputfile> ................................................................................................................................... 213
id= ......................................................................................................................................... 213
name= ................................................................................................................................... 214
<inputs> ...................................................................................................................................... 215
<Input> .................................................................................................................................. 216
<Interface> .................................................................................................................................. 216
<Callbacks> ............................................................................................................................ 217
<filter> ................................................................................................................................... 218
<GetPostCommands> ............................................................................................................ 219
<GetPreCommands> .............................................................................................................. 220
<GetSolveCommands> ........................................................................................................... 221
<images> ............................................................................................................................... 222
of ANSYS, Inc. and its subsidiaries and affiliates. vii
<IsAnalysisValid> .................................................................................................................... 222

<OnActiveObjectChange> ...................................................................................................... 223
<OnAfterRemove> ................................................................................................................. 225
<OnAfterSolve> ...................................................................................................................... 226
<Called before the geometry is updated.> .............................................................................. 227
<OnBeforeSolve> ................................................................................................................... 228
<OnDraw> ............................................................................................................................. 230
<OnDraw2D> ......................................................................................................................... 231
<OnInit> ................................................................................................................................ 232
<OnLoad> .............................................................................................................................. 233
<OnMeshCleaned> ................................................................................................................. 234
<OnMeshGenerated> ............................................................................................................. 235
<OnPostFinished> .................................................................................................................. 236
<OnPostStarted> .................................................................................................................... 237
<OnReady> ............................................................................................................................ 238
<OnSave> .............................................................................................................................. 239
<OnTerminate> ...................................................................................................................... 240
<Resume> .............................................................................................................................. 241
<Save> ................................................................................................................................... 242
<toolbar> ............................................................................................................................... 243
context= ................................................................................................................................ 244
<Layout> ...................................................................................................................................... 245
<Component> ........................................................................................................................ 245
name= ................................................................................................................................... 246
<License> ..................................................................................................................................... 247
name= ................................................................................................................................... 247
<Licenses> ................................................................................................................................... 248
<License> ............................................................................................................................... 248
<Load> ........................................................................................................................................ 249
<Attributes> ........................................................................................................................... 251
<Callbacks> ............................................................................................................................ 252
<CanAdd> .............................................................................................................................. 252
<CanDuplicate> ..................................................................................................................... 253
<CanRemove> ........................................................................................................................ 254
<GetCommands> ................................................................................................................... 255
<GetNodalValuesForDisplay> ................................................................................................. 256
<GetPreCommands> .............................................................................................................. 258
<IsValid> ................................................................................................................................ 260
<OnAdd> ............................................................................................................................... 261
<OnClearData> ...................................................................................................................... 265
<OnDuplicate> ....................................................................................................................... 266
<OnGenerate> ....................................................................................................................... 267
<OnGenerateData> ................................................................................................................ 268
<OnHide> .............................................................................................................................. 269
<OnInit> ................................................................................................................................ 270
viii of ANSYS, Inc. and its subsidiaries and affiliates.
<OnMigrate> .......................................................................................................................... 271

<OnReady> ............................................................................................................................ 272
<OnRemove> ......................................................................................................................... 273
<OnShow> ............................................................................................................................. 274
<OnSuppress> ....................................................................................................................... 275
<OnUnsuppress> ................................................................................................................... 276
<Property> ............................................................................................................................. 277
caption= ................................................................................................................................ 278
class= ..................................................................................................................................... 279
color= .................................................................................................................................... 280
contextual= ............................................................................................................................ 281
icon= ...................................................................................................................................... 282
IsLoad= .................................................................................................................................. 282
IsSupport= ............................................................................................................................. 283
name= ................................................................................................................................... 284
unit= ...................................................................................................................................... 285
version= ................................................................................................................................. 286
<Object> ...................................................................................................................................... 287
<Attributes> ........................................................................................................................... 289
<Callbacks> ............................................................................................................................ 290
<CanAdd> .............................................................................................................................. 290
<CanDuplicate> ..................................................................................................................... 291
<CanRemove> ........................................................................................................................ 292
<GetCommands> ................................................................................................................... 293
<GetNodalValuesForDisplay> ................................................................................................. 294
<GetPreCommands> .............................................................................................................. 296
<IsValid> ................................................................................................................................ 298
<OnAdd> ............................................................................................................................... 299
<OnClearData> ...................................................................................................................... 303
<OnDuplicate> ....................................................................................................................... 304
<OnGenerate> ....................................................................................................................... 305
<OnGenerateData> ................................................................................................................ 306
<OnHide> .............................................................................................................................. 307
<OnInit> ................................................................................................................................ 308
<OnMigrate> .......................................................................................................................... 309
<OnReady> ............................................................................................................................ 310
<OnRemove> ......................................................................................................................... 311
<OnShow> ............................................................................................................................. 312
<OnSuppress> ....................................................................................................................... 313
<OnUnsuppress> ................................................................................................................... 314
<Property> ............................................................................................................................. 315
<Target> ................................................................................................................................ 316
caption= ................................................................................................................................ 317
class= ..................................................................................................................................... 317
color= .................................................................................................................................... 318
contextual= ............................................................................................................................ 319
icon= ...................................................................................................................................... 320
of ANSYS, Inc. and its subsidiaries and affiliates. ix
IsLoad= .................................................................................................................................. 321

IsSupport= ............................................................................................................................. 322
name= ................................................................................................................................... 323
unit= ...................................................................................................................................... 324
version= ................................................................................................................................. 325
<Optimizer> ................................................................................................................................. 326
<Attributes> ........................................................................................................................... 329
<Callbacks> ............................................................................................................................ 330
<CanAdd> .............................................................................................................................. 331
<CanDuplicate> ..................................................................................................................... 332
<CanRemove> ........................................................................................................................ 332
<CanRun> .............................................................................................................................. 333
<Configuration> ..................................................................................................................... 334
<ConvergenceDescription> .................................................................................................... 335
<Description> ........................................................................................................................ 336
<InputParametersEdited> ....................................................................................................... 337
<IsValid> ................................................................................................................................ 338
<MethodPropertiesEdited> .................................................................................................... 339
<ObjectivesOrConstraintsEdited> ........................................................................................... 340
<OnAdd> ............................................................................................................................... 341
<OnClearData> ...................................................................................................................... 344
<OnCreate> ........................................................................................................................... 345
<OnDuplicate> ....................................................................................................................... 346
<OnGenerateData> ................................................................................................................ 347
<OnHide> .............................................................................................................................. 348
<OnInit> ................................................................................................................................ 349
<OnMigrate> .......................................................................................................................... 350
<OnReady> ............................................................................................................................ 351
<OnRelease> .......................................................................................................................... 352
<OnRemove> ......................................................................................................................... 353
<OnShow> ............................................................................................................................. 354
<OnSuppress> ....................................................................................................................... 355
<OnUnsuppress> ................................................................................................................... 356
<ParameterRelationshipsEdited> ............................................................................................ 357
<Property> ............................................................................................................................. 358
<QuickHelp> .......................................................................................................................... 359
<Status> ................................................................................................................................ 360
basedondirectoptimizationonly= ............................................................................................ 361
basedonresponsesurfaceonly= ............................................................................................... 362
caption= ................................................................................................................................ 363
class= ..................................................................................................................................... 363
constrainthandling= ............................................................................................................... 364
constraintimportance= ........................................................................................................... 365
constraintoninputparameter= ................................................................................................. 366
contextual= ............................................................................................................................ 367
convergencedata= .................................................................................................................. 368
equaltoconstraint= ................................................................................................................. 369
greaterthanconstraint= ........................................................................................................... 370
historychartxaxistype= ........................................................................................................... 371
icon= ...................................................................................................................................... 372
x of ANSYS, Inc. and its subsidiaries and affiliates.
insideboundsconstraint= ........................................................................................................ 372

lessthanconstraint= ................................................................................................................ 373
logfile= ................................................................................................................................... 374
maximizeobjective= ............................................................................................................... 375
maximumnumberofconstraints= ............................................................................................. 376
maximumnumberofdoublelistparameters= ............................................................................. 377
maximumnumberofdoubleparameters= ................................................................................. 378
maximumnumberofinputparameters= .................................................................................... 379
maximumnumberofintegerlistparameters= ............................................................................. 380
maximumnumberofobjectives= .............................................................................................. 381
minimizeobjective= ................................................................................................................ 381
minimumnumberofconstraints= ............................................................................................. 382
minimumnumberofobjectives= .............................................................................................. 383
name= ................................................................................................................................... 384
objectiveimportance= ............................................................................................................ 385
objectiveoninputparameter= .................................................................................................. 386
parameterrelationship= .......................................................................................................... 387
seekobjective= ....................................................................................................................... 388
startingpointrequired= ........................................................................................................... 389
version= ................................................................................................................................. 390
<output> ..................................................................................................................................... 390
format= .................................................................................................................................. 391
type= ..................................................................................................................................... 392
<outputfile> ................................................................................................................................. 393
id= ......................................................................................................................................... 393
name= ................................................................................................................................... 394
<outputs> .................................................................................................................................... 395
<Output> ............................................................................................................................... 395
<Panel> ........................................................................................................................................ 396
<Callbacks> ............................................................................................................................ 396
<OnPanelHidden> .................................................................................................................. 397
<OnPanelInitialized> .............................................................................................................. 398
<OnPanelShown> .................................................................................................................. 399
class= ..................................................................................................................................... 400
layout= ................................................................................................................................... 401
name= ................................................................................................................................... 402
<parameter> ................................................................................................................................ 402
<Attributes> ........................................................................................................................... 404
<Callbacks> ............................................................................................................................ 405
<CanAdd> .............................................................................................................................. 405
<CanDuplicate> ..................................................................................................................... 406
<CanRemove> ........................................................................................................................ 407
<IsValid> ................................................................................................................................ 408
<OnAdd> ............................................................................................................................... 409
<OnClearData> ...................................................................................................................... 412
<OnDuplicate> ....................................................................................................................... 413
<OnGenerateData> ................................................................................................................ 414
<OnHide> .............................................................................................................................. 415
<OnInit> ................................................................................................................................ 416
<OnMigrate> .......................................................................................................................... 417
of ANSYS, Inc. and its subsidiaries and affiliates. xi
<OnReady> ............................................................................................................................ 418

<OnRemove> ......................................................................................................................... 419
<OnShow> ............................................................................................................................. 420
<OnSuppress> ....................................................................................................................... 421
<OnUnsuppress> ................................................................................................................... 422
<Property> ............................................................................................................................. 423
caption= ................................................................................................................................ 424
class= ..................................................................................................................................... 425
contextual= ............................................................................................................................ 426
control= ................................................................................................................................. 427
icon= ...................................................................................................................................... 427
name= ................................................................................................................................... 428
usage= ................................................................................................................................... 429
version= ................................................................................................................................. 430
<parameters> ............................................................................................................................... 431
<Parameter> .......................................................................................................................... 431
<platform> ................................................................................................................................... 432
name= ................................................................................................................................... 432
path= ..................................................................................................................................... 433
<program> ................................................................................................................................... 434
<Argument> .......................................................................................................................... 435
<Platform> ............................................................................................................................. 435
<projectdata> .............................................................................................................................. 436
<DataEntity> .......................................................................................................................... 436
<property> .................................................................................................................................. 437
<Attributes> ........................................................................................................................... 439
<Callbacks> ............................................................................................................................ 440
<GetValue> ............................................................................................................................ 441
<IsValid> ................................................................................................................................ 442
<IsVisible> .............................................................................................................................. 442
<OnActivate> ......................................................................................................................... 443
<OnAdd> ............................................................................................................................... 444
<OnApply> ............................................................................................................................ 446
<OnCancel> ........................................................................................................................... 448
<OnDuplicate> ....................................................................................................................... 449
<OnHide> .............................................................................................................................. 450
<OnInit> ................................................................................................................................ 451
<OnMigrate> .......................................................................................................................... 452
<OnRemove> ......................................................................................................................... 453
<OnShow> ............................................................................................................................. 454
<OnValidate> ......................................................................................................................... 455
<SetValue> ............................................................................................................................. 456
<String2Value> ...................................................................................................................... 457
<Value2String> ...................................................................................................................... 458
caption= ................................................................................................................................ 459
class= ..................................................................................................................................... 460
control= ................................................................................................................................. 461
default= ................................................................................................................................. 462
elementtype= ......................................................................................................................... 463
isparameter= .......................................................................................................................... 464
xii of ANSYS, Inc. and its subsidiaries and affiliates.
keytype= ................................................................................................................................ 465

name= ................................................................................................................................... 465
needupdate= ......................................................................................................................... 466
parameterizable= ................................................................................................................... 467
persistent= ............................................................................................................................. 468
readonly= ............................................................................................................................... 469
unit= ...................................................................................................................................... 470
valuetype= ............................................................................................................................. 471
visible= .................................................................................................................................. 472
visibleon= .............................................................................................................................. 473
<propertygroup> ......................................................................................................................... 474
<Attributes> ........................................................................................................................... 476
<Callbacks> ............................................................................................................................ 476
<GetValue> ............................................................................................................................ 477
<IsValid> ................................................................................................................................ 478
<IsVisible> .............................................................................................................................. 479
<OnActivate> ......................................................................................................................... 480
<OnAdd> ............................................................................................................................... 481
<OnApply> ............................................................................................................................ 483
<OnCancel> ........................................................................................................................... 485
<OnDuplicate> ....................................................................................................................... 486
<OnHide> .............................................................................................................................. 487
<OnInit> ................................................................................................................................ 488
<OnMigrate> .......................................................................................................................... 488
<OnRemove> ......................................................................................................................... 489
<OnShow> ............................................................................................................................. 490
<OnValidate> ......................................................................................................................... 491
<Property> ............................................................................................................................. 492
<SetValue> ............................................................................................................................. 493
<String2Value> ...................................................................................................................... 494
<Value2String> ...................................................................................................................... 495
caption= ................................................................................................................................ 496
class= ..................................................................................................................................... 497
control= ................................................................................................................................. 498
default= ................................................................................................................................. 498
display= ................................................................................................................................. 499
elementtype= ......................................................................................................................... 500
isparameter= .......................................................................................................................... 501
keytype= ................................................................................................................................ 502
name= ................................................................................................................................... 503
needupdate= ......................................................................................................................... 504
persistent= ............................................................................................................................. 506
readonly= ............................................................................................................................... 507
unit= ...................................................................................................................................... 507
valuetype= ............................................................................................................................. 508
visible= .................................................................................................................................. 509
visibleon= .............................................................................................................................. 510
<propertytable> ........................................................................................................................... 511
<Attributes> ........................................................................................................................... 513
of ANSYS, Inc. and its subsidiaries and affiliates. xiii
<Callbacks> ............................................................................................................................ 514

<GetValue> ............................................................................................................................ 515
<IsValid> ................................................................................................................................ 516
<IsVisible> .............................................................................................................................. 517
<OnActivate> ......................................................................................................................... 518
<OnAdd> ............................................................................................................................... 518
<OnApply> ............................................................................................................................ 520
<OnCancel> ........................................................................................................................... 522
<OnDuplicate> ....................................................................................................................... 523
<OnHide> .............................................................................................................................. 524
<OnInit> ................................................................................................................................ 525
<OnMigrate> .......................................................................................................................... 526
<OnRemove> ......................................................................................................................... 527
<OnShow> ............................................................................................................................. 528
<OnValidate> ......................................................................................................................... 529
<PropertyTable> ..................................................................................................................... 530
<SetValue> ............................................................................................................................. 531
<String2Value> ...................................................................................................................... 532
<Value2String> ...................................................................................................................... 533
allowempty= .......................................................................................................................... 534
caption= ................................................................................................................................ 535
class= ..................................................................................................................................... 536
control= ................................................................................................................................. 536
default= ................................................................................................................................. 537
display= ................................................................................................................................. 538
elementtype= ......................................................................................................................... 539
isparameter= .......................................................................................................................... 540
keytype= ................................................................................................................................ 541
name= ................................................................................................................................... 542
needupdate= ......................................................................................................................... 543
persistent= ............................................................................................................................. 545
readonly= ............................................................................................................................... 546
unit= ...................................................................................................................................... 546
valuetype= ............................................................................................................................. 547
visible= .................................................................................................................................. 548
visibleon= .............................................................................................................................. 549
<Result> ....................................................................................................................................... 550
<Attributes> ........................................................................................................................... 552
<Callbacks> ............................................................................................................................ 553
<CanAdd> .............................................................................................................................. 553
<CanDuplicate> ..................................................................................................................... 554
<CanRemove> ........................................................................................................................ 555
<Evaluate> ............................................................................................................................. 556
<GetFieldCount> .................................................................................................................... 557
<GetValue> ............................................................................................................................ 558
<IsValid> ................................................................................................................................ 559
<OnAdd> ............................................................................................................................... 560
xiv of ANSYS, Inc. and its subsidiaries and affiliates.
<OnClearData> ...................................................................................................................... 563

<OnDuplicate> ....................................................................................................................... 564
<OnEndEval> ......................................................................................................................... 565
<OnEndPost> ......................................................................................................................... 566
<OnGenerateData> ................................................................................................................ 567
<OnHide> .............................................................................................................................. 568
<OnInit> ................................................................................................................................ 569
<OnMigrate> .......................................................................................................................... 570
<OnReady> ............................................................................................................................ 571
<OnRemove> ......................................................................................................................... 572
<OnShow> ............................................................................................................................. 573
<OnStartEval> ........................................................................................................................ 574
<OnStartPost> ........................................................................................................................ 575
<OnSuppress> ....................................................................................................................... 576
<OnUnsuppress> ................................................................................................................... 577
<Property> ............................................................................................................................. 578
averaging= ............................................................................................................................. 579
caption= ................................................................................................................................ 580
class= ..................................................................................................................................... 581
contextual= ............................................................................................................................ 582
hasimaginary= ....................................................................................................................... 582
icon= ...................................................................................................................................... 583
location= ................................................................................................................................ 584
name= ................................................................................................................................... 585
timehistory= ........................................................................................................................... 586
type= ..................................................................................................................................... 587
unit= ...................................................................................................................................... 588
version= ................................................................................................................................. 589
<rsmjob> ..................................................................................................................................... 590
<Attributes> ........................................................................................................................... 592
<Callbacks> ............................................................................................................................ 593
<CanAdd> .............................................................................................................................. 594
<CanDuplicate> ..................................................................................................................... 595
<CanRemove> ........................................................................................................................ 595
<InputFile> ............................................................................................................................ 596
<IsValid> ................................................................................................................................ 597
<OnAdd> ............................................................................................................................... 598
<OnClearData> ...................................................................................................................... 601
<oncreatejobinput> ............................................................................................................... 602
<OnDuplicate> ....................................................................................................................... 603
<OnGenerateData> ................................................................................................................ 604
<OnHide> .............................................................................................................................. 605
<OnInit> ................................................................................................................................ 606
<onjobcancellation> .............................................................................................................. 606
<onjobreconnect> ................................................................................................................. 607
<onjobstatus> ........................................................................................................................ 608
<OnMigrate> .......................................................................................................................... 609
<OnReady> ............................................................................................................................ 610
<OnRemove> ......................................................................................................................... 611
<OnShow> ............................................................................................................................. 612
of ANSYS, Inc. and its subsidiaries and affiliates. xv
<OnSuppress> ....................................................................................................................... 613

<OnUnsuppress> ................................................................................................................... 614
<OutputFile> .......................................................................................................................... 615
<Program> ............................................................................................................................. 616
<Property> ............................................................................................................................. 617
caption= ................................................................................................................................ 617
class= ..................................................................................................................................... 618
contextual= ............................................................................................................................ 619
deletefiles= ............................................................................................................................ 620
icon= ...................................................................................................................................... 621
name= ................................................................................................................................... 622
version= ................................................................................................................................. 623
<Sampling> ................................................................................................................................. 624
<Attributes> ........................................................................................................................... 626
<Callbacks> ............................................................................................................................ 627
<CanAdd> .............................................................................................................................. 628
<CanDuplicate> ..................................................................................................................... 629
<CanRemove> ........................................................................................................................ 629
<CanRun> .............................................................................................................................. 630
<Configuration> ..................................................................................................................... 631
<Description> ........................................................................................................................ 632
<InputParametersEdited> ....................................................................................................... 633
<IsValid> ................................................................................................................................ 634
<MethodPropertiesEdited> .................................................................................................... 635
<OnAdd> ............................................................................................................................... 636
<OnClearData> ...................................................................................................................... 639
<OnCreate> ........................................................................................................................... 640
<OnDuplicate> ....................................................................................................................... 641
<OnGenerateData> ................................................................................................................ 642
<OnHide> .............................................................................................................................. 643
<OnInit> ................................................................................................................................ 644
<OnMigrate> .......................................................................................................................... 645
<OnReady> ............................................................................................................................ 646
<OnRelease> .......................................................................................................................... 647
<OnRemove> ......................................................................................................................... 648
<OnShow> ............................................................................................................................. 649
<OnSuppress> ....................................................................................................................... 650
<OnUnsuppress> ................................................................................................................... 651
<Property> ............................................................................................................................. 652
<QuickHelp> .......................................................................................................................... 653
<Status> ................................................................................................................................ 654
caption= ................................................................................................................................ 655
class= ..................................................................................................................................... 656
contextual= ............................................................................................................................ 657
CustomTable= ........................................................................................................................ 657
icon= ...................................................................................................................................... 658
logfile= ................................................................................................................................... 659
maximumnumberofdoublelistparameters= ............................................................................. 660
maximumnumberofdoubleparameters= ................................................................................. 661
maximumnumberofinputparameters= .................................................................................... 662
xvi of ANSYS, Inc. and its subsidiaries and affiliates.
maximumnumberofintegerlistparameters= ............................................................................. 663

name= ................................................................................................................................... 664
version= ................................................................................................................................. 665
<script> ....................................................................................................................................... 666
compiled= .............................................................................................................................. 666
src= ........................................................................................................................................ 667
<separator> ................................................................................................................................. 668
<simdata> .................................................................................................................................... 668
<Object> ................................................................................................................................ 668
context= ................................................................................................................................ 669
<Solver> ...................................................................................................................................... 670
<Attributes> ........................................................................................................................... 672
<Callbacks> ............................................................................................................................ 672
<CanAdd> .............................................................................................................................. 673
<CanDuplicate> ..................................................................................................................... 674
<CanRemove> ........................................................................................................................ 675
<GetFiles> .............................................................................................................................. 676
<GetReader> .......................................................................................................................... 677
<GetSteps> ............................................................................................................................ 678
<IsAnalysisValid> .................................................................................................................... 679
<IsValid> ................................................................................................................................ 680
<OnAdd> ............................................................................................................................... 681
<OnBeforeSolve> ................................................................................................................... 682
<OnCheckResults> ................................................................................................................. 684
<OnClearData> ...................................................................................................................... 685
<OnDuplicate> ....................................................................................................................... 686
<OnGenerateData> ................................................................................................................ 687
<OnHide> .............................................................................................................................. 688
<OnInit> ................................................................................................................................ 689
<OnMigrate> .......................................................................................................................... 690
<OnReady> ............................................................................................................................ 691
<OnRemove> ......................................................................................................................... 692
<OnShow> ............................................................................................................................. 693
<OnSolve> ............................................................................................................................. 694
<OnSuppress> ....................................................................................................................... 695
<OnUnsuppress> ................................................................................................................... 696
<OnWriteInputFile> ................................................................................................................ 697
<Property> ............................................................................................................................. 698
analysis= ................................................................................................................................ 699
caption= ................................................................................................................................ 700
class= ..................................................................................................................................... 701
contextual= ............................................................................................................................ 702
icon= ...................................................................................................................................... 702
name= ................................................................................................................................... 703
physics= ................................................................................................................................. 704
toolbox= ................................................................................................................................ 705
version= ................................................................................................................................. 706
<Step> ......................................................................................................................................... 707
<Attributes> ........................................................................................................................... 709
<Callbacks> ............................................................................................................................ 709
of ANSYS, Inc. and its subsidiaries and affiliates. xvii
<CanAdd> .............................................................................................................................. 710

<CanDuplicate> ..................................................................................................................... 711
<CanRemove> ........................................................................................................................ 712
<ComponentData> ................................................................................................................ 713
<ComponentStyle> ................................................................................................................ 714
<Description> ........................................................................................................................ 714
<IsValid> ................................................................................................................................ 715
<OnAdd> ............................................................................................................................... 716
<OnClearData> ...................................................................................................................... 719
<OnDuplicate> ....................................................................................................................... 720
<OnGenerateData> ................................................................................................................ 721
<OnHide> .............................................................................................................................. 722
<OnInit> ................................................................................................................................ 722
<OnMigrate> .......................................................................................................................... 723
<OnReady> ............................................................................................................................ 724
<onrefresh> ........................................................................................................................... 725
<OnRemove> ......................................................................................................................... 726
<onreset> .............................................................................................................................. 727
<OnShow> ............................................................................................................................. 728
<OnSuppress> ....................................................................................................................... 729
<OnUnsuppress> ................................................................................................................... 730
<onupdate> ........................................................................................................................... 731
<Property> ............................................................................................................................. 732
caption= ................................................................................................................................ 733
class= ..................................................................................................................................... 734
Context= ................................................................................................................................ 735
contextual= ............................................................................................................................ 736
Enabled= ................................................................................................................................ 736
helpFile= ................................................................................................................................ 737
icon= ...................................................................................................................................... 738
Layout= .................................................................................................................................. 739
name= ................................................................................................................................... 740
version= ................................................................................................................................. 741
<Target> ...................................................................................................................................... 742
location= ................................................................................................................................ 742
name= ................................................................................................................................... 743
type= ..................................................................................................................................... 744
<task> .......................................................................................................................................... 745
<Attributes> ........................................................................................................................... 747
<Callbacks> ............................................................................................................................ 748
<CanAdd> .............................................................................................................................. 748
<CanDuplicate> ..................................................................................................................... 749
<CanRemove> ........................................................................................................................ 750
<ContextMenus> .................................................................................................................... 751
<Inputs> ................................................................................................................................ 752
<IsValid> ................................................................................................................................ 753
<OnAdd> ............................................................................................................................... 754
<OnClearData> ...................................................................................................................... 756
xviii of ANSYS, Inc. and its subsidiaries and affiliates.
<ondelete> ............................................................................................................................ 757

<OnDuplicate> ....................................................................................................................... 758
<onedit> ................................................................................................................................ 759
<OnGenerateData> ................................................................................................................ 760
<OnHide> .............................................................................................................................. 761
<OnInit> ................................................................................................................................ 762
<oninitialize> ......................................................................................................................... 763
<OnMigrate> .......................................................................................................................... 764
<OnReady> ............................................................................................................................ 765
<onrefresh> ........................................................................................................................... 766
<OnRemove> ......................................................................................................................... 767
<onreport> ............................................................................................................................ 768
<onreset> .............................................................................................................................. 769
<OnShow> ............................................................................................................................. 770
<onstatus> ............................................................................................................................. 771
<OnSuppress> ....................................................................................................................... 772
<OnUnsuppress> ................................................................................................................... 773
<onupdate> ........................................................................................................................... 774
<Outputs> ............................................................................................................................. 775
<Parameters> ......................................................................................................................... 776
<Property> ............................................................................................................................. 777
<RsmJob> .............................................................................................................................. 777
caption= ................................................................................................................................ 778
class= ..................................................................................................................................... 779
contextual= ............................................................................................................................ 780
icon= ...................................................................................................................................... 781
name= ................................................................................................................................... 782
version= ................................................................................................................................. 782
<taskgroup> ................................................................................................................................ 783
<Attributes> ........................................................................................................................... 785
<Callbacks> ............................................................................................................................ 786
<CanAdd> .............................................................................................................................. 786
<CanDuplicate> ..................................................................................................................... 787
<CanRemove> ........................................................................................................................ 788
<IncludeGroup> ..................................................................................................................... 789
<IncludeTask> ........................................................................................................................ 790
<IsValid> ................................................................................................................................ 791
<OnAdd> ............................................................................................................................... 792
<OnClearData> ...................................................................................................................... 794
<OnDuplicate> ....................................................................................................................... 795
<OnGenerateData> ................................................................................................................ 796
<OnHide> .............................................................................................................................. 797
<OnInit> ................................................................................................................................ 798
<OnMigrate> .......................................................................................................................... 799
<OnReady> ............................................................................................................................ 800
<OnRemove> ......................................................................................................................... 801
<OnShow> ............................................................................................................................. 802
<OnSuppress> ....................................................................................................................... 803
<OnUnsuppress> ................................................................................................................... 804
<Property> ............................................................................................................................. 805
of ANSYS, Inc. and its subsidiaries and affiliates. xix
abbreviation= ......................................................................................................................... 806

caption= ................................................................................................................................ 807
category= ............................................................................................................................... 808
class= ..................................................................................................................................... 809
contextual= ............................................................................................................................ 810
icon= ...................................................................................................................................... 810
isparametricgroup= ................................................................................................................ 811
name= ................................................................................................................................... 812
version= ................................................................................................................................. 813
<taskgroups> ............................................................................................................................... 814
<TaskGroup> .......................................................................................................................... 814
<tasks> ........................................................................................................................................ 815
<Task> ................................................................................................................................... 815
<Templates> ................................................................................................................................ 816
<ControlTemplate> ................................................................................................................ 816
<toolbar> ..................................................................................................................................... 817
<Separator> ........................................................................................................................... 818
caption= ................................................................................................................................ 818
name= ................................................................................................................................... 819
<UIDefinition> ............................................................................................................................. 820
<ComponentDefinition> ........................................................................................................ 820
<Layout> ................................................................................................................................ 821
<Wizard> ..................................................................................................................................... 822
<Callbacks> ............................................................................................................................ 822
<canstart> .............................................................................................................................. 823
<Description> ........................................................................................................................ 824
<Step> ................................................................................................................................... 825
caption= ................................................................................................................................ 825
context= ................................................................................................................................ 826
icon= ...................................................................................................................................... 827
layout= ................................................................................................................................... 828
name= ................................................................................................................................... 829
version= ................................................................................................................................. 830
<Workflow> ................................................................................................................................. 831
<Attributes> ........................................................................................................................... 832
<Callbacks> ............................................................................................................................ 833
<CanAdd> .............................................................................................................................. 834
<CanDuplicate> ..................................................................................................................... 835
<CanRemove> ........................................................................................................................ 835
<IsValid> ................................................................................................................................ 836
<OnAdd> ............................................................................................................................... 837
<OnClearData> ...................................................................................................................... 840
<OnDuplicate> ....................................................................................................................... 841
<OnGenerateData> ................................................................................................................ 842
<OnHide> .............................................................................................................................. 843
<OnInit> ................................................................................................................................ 844
<OnMigrate> .......................................................................................................................... 845
<OnReady> ............................................................................................................................ 846
<OnRemove> ......................................................................................................................... 847
<OnShow> ............................................................................................................................. 848
xx of ANSYS, Inc. and its subsidiaries and affiliates.
<OnSuppress> ....................................................................................................................... 849

<OnUnsuppress> ................................................................................................................... 850
<Property> ............................................................................................................................. 851
<TaskGroups> ........................................................................................................................ 852
<Tasks> .................................................................................................................................. 853
caption= ................................................................................................................................ 853
class= ..................................................................................................................................... 854
context= ................................................................................................................................ 855
contextual= ............................................................................................................................ 856
icon= ...................................................................................................................................... 857
name= ................................................................................................................................... 858
version= ................................................................................................................................. 859
of ANSYS, Inc. and its subsidiaries and affiliates. xxi
xxii of ANSYS, Inc. and its subsidiaries and affiliates.
Part I: ACT XML Reference
ACT XML Tags
Table 1: XML Tag Listing
<ActionCallback> (p. 5) Defines the action callback.

<Application> (p. 8) Defines an ACT application that will be posted to the
ANSYS ACT Application Store.
<argument> (p. 17) Defines the arguments to be applied.
<assembly> (p. 20) Defines the assembly to be loaded.
<attributes> (p. 23) Defines the set of attributes for the object.
<Callback> (p. 23) Describes a callback to be associated with the parent
ACT entity (load, UI item, task, etc.).
<CallbackGetCommands> (p. 24) Provides the commands to add to the solver input
file.
<CallbackGetPostPreSolveCommands> (p. 26) Collects all commands to add to the solver input file.
<CallbackOnActiveObjectChange> (p. 28) Called when the active object changes.
<Callbacks> (p. 30) Specifies the callbacks that will invoke functions from
the IronPython extension script.
<Component> (p. 31) Defines the component.
<ComponentData> (p. 50) Defines the data for the component.
<ComponentDefinition> (p. 52) Defines the display for the component.
<ComponentStyle> (p. 57) Defines the styles for the component.
<contextmenus> (p. 60) Defines user-defined custom context menu entries.
<ControlTemplate> (p. 61) Defines a control template for the creation of groups
of properties.
<entity> (p. 63) Defines a custom data entity based on an ACT XML
Extension file.
<entry> (p. 91) Defines an entry in a user interface element.
<entry> (p. 120) Defines a drop-down menu within a toolbar.
<Extension> (p. 126) Defines an ACT extension.
<extension object> (p. 143) Extends the extension object definition. (Inherited
from DesignXplorer SimEntity)
<filter> (p. 171) Defines a filter.
<Geometry> (p. 173) Defines a geometry feature.
<guid> (p. 202) Defines a unique identifier for the extension.
<includegroup> (p. 204) Defines the include group tag (used by task groups).
<includetask> (p. 207) Defines the include task tag (used by task groups).
<input> (p. 210) Defines an input-level data connection definition.
of ANSYS, Inc. and its subsidiaries and affiliates. 3
ACT XML Tags
<inputfile> (p. 213) Defines an input file.

<inputs> (p. 215) Defines the inputs collection for a task.
<Interface> (p. 216) Defines the user interface for the extension.
<Layout> (p. 245) Defines the layout used to display the extension.
<License> (p. 247) Defines a license to be used in the execution of an
extension.
<Licenses> (p. 248) Defines a licenses collection for the extension.
<Load> (p. 249) Defines a simulation load or boundary.
<Object> (p. 287) Defines an object.
<Optimizer> (p. 326) Defines an optimizer.
<output> (p. 390) Defines an output-level data connection definition
<outputfile> (p. 393) Defines an output file.
<outputs> (p. 395) Defines the outputs collection for a task.
<Panel> (p. 396) Defines a panel to be displayed.
<parameter> (p. 402) Defines a single parameter definition for a task.
<parameters> (p. 431) Defines the collection of task parameters.
<platform> (p. 432) Defines the platform.
<program> (p. 434) Defines the program.
<projectdata> (p. 436) Defines the data for the project.
<property> (p. 437) Defines a property of any user object.
<propertygroup> (p. 474) Defines a collection of properties
<propertytable> (p. 511) Encapsulates a list of child properties under one table.
<Result> (p. 550) Defines a result.
<rsmjob> (p. 590) Defines an rsm job.
<Sampling> (p. 624) Defines a DesignExplorer sampling.
<script> (p. 666) Specifies the IronPython script referenced by the
extension.
<separator> (p. 668) Defines the separator for items in a toolbar.
<simdata> (p. 668) Defines a general section that stores all user object
definitions.
<Solver> (p. 670) Specifies a third-party solver to be used in the
simulation.
<Step> (p. 707) Defines a step in a wizard or AIM custom template.
<Target> (p. 742) Defines the target location for the object.
<task> (p. 745) Defines a task that encapsulates a single process or
application.
<taskgroup> (p. 783) Defines a collection of tasks.
<taskgroups> (p. 814) Defines a collection of task groups.
<tasks> (p. 815) Defines the tasks collection.
<Templates> (p. 816) Defines a collection of control templates.
<toolbar> (p. 817) Defines a toolbar.
4 of ANSYS, Inc. and its subsidiaries and affiliates.
<ActionCallback>
<UIDefinition> (p. 820) Defines the user interface for the extension.
<Wizard> (p. 822) Defines a wizard within the extension.
<Workflow> (p. 831) Defines custom workflows composed of tasks and
task groups.
<ActionCallback>
Defines the action callback.
Remarks
None.
Examples
None.
Attribute caption= (p. 5) Caption for the action

callback.
Attribute icon= (p. 6) Icon for the action
callback.
Attribute name= (p. 7) Name of the action
callback.
caption=
Caption for the action callback.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the action callback.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
<ActionCallback>
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
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
<Application>
Defines the application.
Remarks
None.
Examples
None.
Tag <Callbacks> (p. 8) Specifies the callbacks that will invoke functions from
the IronPython extension script.
Tag <description> (p. 9) Description of the application.
Callback <OnApplicationFinished> (p. 10) Called when the application finishes.
Callback <OnApplicationInitialized> (p. 11) Called when the application initializes.
Callback <OnApplicationStarted> (p. 12) Called when the application starts.
Tag <Panel> (p. 13) Defines a panel to be displayed.
Attribute class= (p. 13) Class name of the controller of the application.
Attribute context= (p. 14) Context or combination of contexts (separated using
'|') in which the application can be launched.
Attribute MainPanel= (p. 15) Name of the first panel to display.
Attribute name= (p. 16) Name of the application.
<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script.
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 30)
<Application>
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>
Description of the application.
Type
System_String
Remarks
None.
Examples
<step | wizard>
<description>description</description>
</step | wizard>
Details
Description
Description of the application.
ValueName
description
ACT XML Tags
Name
description
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
<OnApplicationFinished>
Called when the application finishes.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 23)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_Application_
Name
OnApplicationFinished
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
<Application>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnApplicationInitialized>
Called when the application initializes.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnApplicationInitialized
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
ACT XML Tags
TypeId
<OnApplicationStarted>
Called when the application starts.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnApplicationStarted
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Application>
<Panel>
Defines a panel to be displayed.
Type
Ansys_ACT_Core_XmlDataModel_Panel (p. 396)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
class=
Class name of the controller of the application.
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
context=
Context or combination of contexts (separated using '|') in which the application can be launched.
Type
System_String_ARRAY_
Remarks
This block will be taken into account only for specified context(s).
Examples
None.
Details
Mandatory
False
<Application>
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
MainPanel=
Name of the first panel to display.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
MainPanel
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the application.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<argument>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<argument>
Defines the arguments to be applied.
Remarks
None.
Examples
None.
Attribute name= (p. 17) Name of the

argument.
Attribute separator= (p. 18) Argument-value
separator.
Attribute value= (p. 19) Value of the
argument.
name=
Name of the argument.
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
Mandatory
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
separator=
Argument-value separator.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
<argument>
Name
separator
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
value=
Value of the argument.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
value
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<assembly>
Defines the assembly to be loaded.
Remarks
This tag is typically used to import a specific namespace from a C# dll.
Examples
Example 1: <code type="xml"> <assembly src="CSharp.dll" namespace="CSharp" /> </code>
Attribute context= (p. 20) Context or combination of contexts (separated using '|') for the
import.
Attribute namespace= (p. 21) Namespace to import.
Attribute src= (p. 22) Name of the dll file to import.
context=
Context or combination of contexts (separated using '|') for the import.
Type
System_String
Remarks
<assembly>
Examples
None.
Details
Mandatory
False
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
namespace=
Namespace to import.
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
Mandatory
True
Name
namespace
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
src=
Name of the dll file to import.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
<Callback>
Name
src
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<attributes>
Defines the set of attributes for the object.
Remarks
None.
Examples
None.
<Callback>
Describes a callback to be associated with the parent ACT entity (load, UI item, task, etc.).
Remarks
There are no attributes. The context (inner XML text) contains the Python function name representing
the callback.
Examples
None.
ACT XML Tags
<CallbackGetCommands>
Provides 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) Call order.
location=
Location of the call.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
location
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
<CallbackGetCommands>
MappedValues
None.
Public
True
Description
None.
TypeId
order=
Call order.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
order
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
ACT XML Tags
Description
None.
TypeId
<CallbackGetPostPreSolveCommands>
Collects all commands to add to the solver input file.
Remarks
None.
Examples
None.
Attribute order= (p. 26) Call order.

Attribute timedependent= (p. 27) Specifies whether the callback will be called for each
step.
order=
Call order.
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 whether the callback will be called for each step.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
timedependent
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
<CallbackOnActiveObjectChange>
Called when the active object changes.
Remarks
None.
Examples
None.
Attribute name= (p. 28) Name

filter.
Attribute type= (p. 29) Type
filter.
name=
Name filter.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
<CallbackOnActiveObjectChange>
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
type=
Type filter.
Type
Ansys_ACT_Interfaces_UserObject_ObjectTypeEnum
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
type
DefaultValue
Unknown
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Callbacks>
Remarks
Examples
None.
Tag <CallbackGetPostPreSolveCommands> (p. 30) Collects all commands to add to the solver
input file.
Collects all commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 26)
Remarks
None.
Examples
None.
<Component>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Component>
Defines the component.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 32) Defines the set ofattributes for the
component.
Attribute BottomAttachment= (p. 32) Bottom attachment of the component
layout.
Attribute BottomOffset= (p. 33) Bottom offset related to the bottom
attachment.
Attribute ComponentType= (p. 34) Type of component.
Attribute CustomCSSFile= (p. 35) Custom CSS file for the component layout.
Attribute CustomHTMLFile= (p. 36) Custom HTML file for the component.
Attribute CustomJSFile= (p. 37) Custom jscript file for the component.
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 component layout.
Attribute LeftOffset= (p. 41) Left offset related to the left attachment.
Attribute MaxHeight= (p. 41) Maximum height for the component.
ACT XML Tags
Attribute MaxWidth= (p. 42) Maximum width for the component.

Attribute name= (p. 43) Name of the component.
Attribute RightAttachment= (p. 44) Right attachment of the component layout.
Attribute RightOffset= (p. 45) Right offset related to the right
attachment.
Attribute TopAttachment= (p. 46) Top attachment of the component layout.
Attribute TopOffset= (p. 47) Top offset related to the top attachment.
Attribute visible= (p. 48) Indicates whether the component is visible.
Attribute Width= (p. 49) Width value for the component.
Attribute WidthType= (p. 50) Width type for the component.
<Attributes>
Defines the set of attributes for the 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 component layout.
<Component>
Type
System_String
Remarks
The value can be the name of a component or "" for the border.
Examples
None.
Details
Mandatory
True
Name
BottomAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
BottomOffset=
Bottom offset related to the bottom attachment.
Type
System_Int32
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
BottomOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ComponentType=
Type of component.
Type
System_String
Remarks
None.
<Component>
Examples
None.
Details
Mandatory
False
Name
ComponentType
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
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.
ACT XML Tags
Details
Mandatory
False
Name
CustomCSSFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
CustomHTMLFile=
Custom HTML file for the component.
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
<Component>
Name
CustomHTMLFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
CustomJSFile=
Custom jscript file for the component.
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
CustomJSFile
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Height=
Height value for the component.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
Height
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<Component>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
HeightType=
Height type for the component.
Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
HeightType
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
LeftAttachment=
Left attachment of the component layout.
Type
System_String
Remarks
Examples
None.
Details
Mandatory
True
Name
LeftAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<Component>
TypeId
LeftOffset=
Left offset related to the left attachment.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
LeftOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
MaxHeight=
Maximum height for the component.
ACT XML Tags
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
MaxHeight
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
MaxWidth=
Maximum width for the component.
Type
System_Int32
<Component>
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
MaxWidth
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the component.
Type
System_String
Remarks
None.
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
RightAttachment=
Right attachment of the component layout.
Type
System_String
Remarks
Examples
None.
<Component>
Details
Mandatory
True
Name
RightAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
RightOffset=
Right offset related to the right attachment.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
ACT XML Tags
Name
RightOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
TopAttachment=
Top attachment of the component layout.
Type
System_String
Remarks
Examples
None.
Details
Mandatory
True
Name
TopAttachment
DefaultValue
None.
<Component>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
TopOffset=
Top offset related to the top attachment.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
TopOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visible=
Indicates whether the component is visible.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
visible
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<Component>
Public
False
Description
None.
TypeId
Width=
Width value for the component.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
Width
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
WidthType=
Width type for the component.
Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
WidthType
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<ComponentData>
Defines the data for the component.
<ComponentData>
Remarks
None.
Examples
None.
Attribute component= (p. 51) Component for which data is being

defined.
component=
Component for which data is being defined.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
component
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
ACT XML Tags
Description
None.
TypeId
<ComponentDefinition>
Defines the display of the component.
Remarks
None.
Examples
None.
Attribute Class= (p. 52) Class to control the component

Attribute CSSFile= (p. 53) Default CSS file to use for this component.
Attribute DataModelClass= (p. 54) Class type that describes the data model of the
component.
Attribute HTMLFile= (p. 55) Default HTML file to use for this component.
Attribute JSFile= (p. 56) Default JS file to use for this component.
Attribute Name= (p. 57) Name of the component definition.
Class=
Class to control the component
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
Class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
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
Name
CSSFile
DefaultValue
None.
DataDefinition
False
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
DataModelClass=
Class type that describes the data model of the component.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
DataModelClass
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
HTMLFile=
Default HTML file to use for this component.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
HTMLFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
ACT XML Tags
Description
None.
TypeId
JSFile=
Default JS file to use for this component.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
JSFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<ComponentStyle>
Name=
Name of the component definition.
Type
System_String
Remarks
Identifies the component type.
Examples
None.
Details
Mandatory
True
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<ComponentStyle>
Defines the styles for the component.
ACT XML Tags
Remarks
None.
Examples
None.
Attribute component= (p. 58) Component for which styles are being
defined.
Attribute filter= (p. 59) Filter for component styles.
component=
Component for which styles are being defined.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
component
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<ComponentStyle>
Public
True
Description
None.
TypeId
filter=
Filter for component styles.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
filter
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
<contextmenus>
Defines user-defined custom context menu entries.
Remarks
At minimum, the context menu entry definition must include the name and version attributes. When
the optional type attribute is defined, it must be set to ContextMenuEntry. Each entry in the <context-
menus> node must have an <onclick> callback.
Examples
None.
Tag <UIEntry> (p. 60) User interface entry to be included in the context
menu.
<UIEntry>
User interface entry to be included in the context menu.
Type
Ansys_ACT_Core_XmlDataModel_UIEntry (p. 91)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_UIEntry
MinOccurence
0
MaxOccurence
-1
RealParent
None.
<ControlTemplate>
Mandatory
False
TypeId
<ControlTemplate>
Defines a control template for the creation of groups of properties.
Remarks
None.
Examples
None.
Tag <PropertyTable> (p. 61) Encapsulates a list of child properties under one
table.
Attribute name= (p. 62) Name of the control template.
Attribute version= (p. 63) Version of the control template.
<PropertyTable>
Encapsulates a list of child properties under one table.
Type
Ansys_ACT_Core_XmlDataModel_PropertyTable (p. 511)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_PropertyTable
MinOccurence
0
MaxOccurence
-1
ACT XML Tags
RealParent
None.
Mandatory
False
TypeId
name=
Name of the control template.
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.
<entity>
TypeId
version=
Version of the control template.
Type
System_Int32
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>
Defines a custom data entity based on an ACT XML Extension file.
ACT XML Tags
Remarks
None.
Examples
None.
Tag <Attributes> (p. 65) Defines the set of attributes for the entity.
(Inherited from SimEntity)
Tag <Callbacks> (p. 66) Specifies the callbacks that will invoke functions
from the IronPython extension script. (Inherited
from SimEntity)
Callback <CanAdd> (p. 66) Called to check if the entity can be added .
Callback <CanDuplicate> (p. 67) Called to check if the entity can be duplicated.
Callback <CanRemove> (p. 68) Called to check if the entity can be removed.
Callback <IsValid> (p. 69) Called to check if the entity is valid. (Inherited from
SimEntity)
Callback <OnAdd> (p. 70) Called when the entity is newly added. (Inherited
from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 71) Called after the geometry has been updated.
Callback <OnBodySuppressStateChange> (p. 72) Called when the body suppress state has been
changed. (Inherited from SimEntity)
Callback <OnClearData> (p. 73) Called when object data is cleared. (Inherited from
SimEntity)
Callback <OnDuplicate> (p. 74) Called when the object is duplicated. (Inherited
from SimEntity)
Callback <OnGenerateData> (p. 75) Called when object data is generated. (Inherited
from SimEntity)
Callback <OnHide> (p. 76) Called when the object is hidden. (Inherited from
SimEntity)
Callback <OnInit> (p. 77) Called when the object is initialized. (Inherited
from SimEntity)
Callback <OnMigrate> (p. 78) Called when the object version has been changed.
Callback <OnReady> (p. 79) Called when the application is fully loaded and in
a "ready" state. (Inherited from SimEntity)
Callback <OnRemove> (p. 80) Called when the object is removed. (Inherited from
SimEntity)
Callback <OnShow> (p. 81) Called when the object is shown. (Inherited from
SimEntity)
<entity>
Callback <OnSuppress> (p. 82) Called when the object is suppressed. (Inherited
from SimEntity)
Callback <OnUnsuppress> (p. 83) Called when the object is unsuppressed. (Inherited
from SimEntity)
Tag <Property> (p. 84) Defines a property of any user object. (Inherited
from SimEntity)
Attribute caption= (p. 85) Caption for the object. (Inherited from SimEntity)
Attribute class= (p. 86) Class name of the controller of the object.
Attribute contextual= (p. 87) Indicates whether the object must be displayed
in the contextual menu. . (Inherited from
SimEntity)
Attribute datatype= (p. 88) Data type representing the schematic-exposed
type for which this data entity represents.
Attribute icon= (p. 88) Icon for the object. (Inherited from SimEntity)
Attribute name= (p. 89) Name of the object. (Inherited from SimEntity)
Attribute version= (p. 90) Version of the object. (Inherited from SimEntity)
<Attributes>
Defines the set of attributes for the entity. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (Inherited from
SimEntity)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Called to check if the entity can be added . (Inherited from SimEntity)
Type
Remarks
None.
<entity>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Called to check if the entity can be duplicated. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Mandatory
False
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Called to check if the entity can be removed. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
<entity>
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsValid>
Called to check if the entity is valid. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Called when the entity is newly added. (Inherited from SimEntity)
Type
Remarks
This callback is not called when the project is reopened.
Examples
None.
<entity>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAfterGeometryUpdate>
Called after the geometry has been updated. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Mandatory
False
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnBodySuppressStateChange>
Called when the body suppress state has been changed. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
<entity>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Mandatory
False
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Called when object data is cleared. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Called when the object is duplicated. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
<entity>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnGenerateData>
Called when object data is generated. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Called when the object is hidden. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
<entity>
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
<OnInit>
Called 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.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Called when the object version has been changed. (Inherited from SimEntity)
Type
Remarks
Enables the migration of data from the previously saved object to the new one.
Examples
None.
<entity>
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>
Called when the application is fully loaded and in a "ready" state. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Called when the object is removed. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
<entity>
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Called when the object is shown. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Called when the object is suppressed. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
<entity>
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>
Called when the object is unsuppressed. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Defines a property of any user object. (Inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 437)
Remarks
Individual properties can be defined in the <property> node, which can be either a child to <property-
group> or a standalone definition at the same level. At minimum, each property definition must include
the name and control attributes.
Examples
None.
<entity>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Caption for the object. (Inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
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.
<entity>
Public
True
Description
None.
TypeId
contextual=
Indicates whether the object must 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.
ACT XML Tags
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=
Icon for the object. (Inherited from SimEntity)
<entity>
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=
Name of the object. (Inherited from SimEntity)
Type
System_String
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
version=
Version of the object. (Inherited from SimEntity)
Type
System_Int32
Remarks
None.
<entry>
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<entry>
Defines an entry in a user interface element.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 93) Defines the set of attributes for the object.
SimEntity)
ACT XML Tags
from SimEntity)
Callback <CanAdd> (p. 94) Called to check if the object can be added.
Callback <CanDuplicate> (p. 95) Called to check if the object can be duplicated.
Callback <CanRemove> (p. 96) Called to check if the object can be removed.
Callback <IsValid> (p. 97) Called to check if the object is valid. (Inherited
from SimEntity)
Callback <OnAdd> (p. 98) Called when the object is newly added. (Inherited
from SimEntity)
SimEntity)
Callback <onclick> (p. 102) Called when the object is clicked.
from SimEntity)
from SimEntity)
SimEntity)
from SimEntity)
SimEntity)
SimEntity)
from SimEntity)
from SimEntity)
from SimEntity)
<entry>
in the contextual menu. (Inherited from SimEntity)
Attribute priority= (p. 117) UI-level priority of the object.
Attribute type= (p. 118) GUI operation type for the object.
<Attributes>
Defines the set of attributes for the object. SimEntity)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
SimEntity)
Type
ACT XML Tags
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Called to check if the object can be added. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
<entry>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanDuplicate>
Called to check if the object can be duplicated. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanRemove>
Called to check if the object can be removed. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
<entry>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<IsValid>
Called to check if the object is valid. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ACT XML Tags
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAdd>
Called when the object is newly added. (Inherited from SimEntity)
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
<entry>
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
ACT XML Tags
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
<entry>
RealParent
Mandatory
False
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
ACT XML Tags
Mandatory
False
TypeId
<onclick>
Called when the object is clicked.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_DataContainerReference_
Name
onclick
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
<entry>
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnHide>
<entry>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnInit>
Type
ACT XML Tags
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnMigrate>
Type
Remarks
<entry>
Examples
None.
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.
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.
<entry>
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.
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.
<entry>
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.
ACT XML Tags
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Property>
Type
Remarks
Examples
None.
<entry>
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.
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.
<entry>
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.
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=
<entry>
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
priority=
UI-level priority of the object.
Type
System_Single
ACT XML Tags
Remarks
This is used for grouping and ordering purposes.
Examples
None.
Details
Mandatory
False
Name
priority
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
type=
GUI operation type for the object.
Type
System_String
Remarks
None.
<entry>
Examples
None.
Details
Mandatory
False
Name
type
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
ACT XML Tags
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<entry>
Defines a drop-down menu within a toolbar.
Remarks
To ceate a dropdown menu inside a toolbar, an entry has to be created inside another entry.
Examples
None.
Tag <Callbacks> (p. 121) Specifies the callbacks that will invoke functions from the IronPython
extension script.
Callback <OnClick> (p. 121) Called when the object is clicked.
Tag <Separator> (p. 122) Defines the separator for items in a toolbar
Attribute caption= (p. 123) Caption of the entry.
Attribute Icon= (p. 124) Icon for the entry.
<entry>
Attribute name= (p. 125) Name of the entry.

Attribute userobject= (p. 126) Related user object name.
<Callbacks>
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<OnClick>
Called when the object is clicked.
Type
Remarks
None.
ACT XML Tags
Examples
None.
Details
CallbackType
ActionCallback_IDataModelObject_
Mandatory
False
Name
OnClick
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Separator>
Defines the separator for items in a toolbar.
Type
Ansys_ACT_Core_XmlDataModel_Separator (p. 668)
Remarks
None.
Examples
None.
<entry>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Separator
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Caption of the entry.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Icon=
Icon for the entry.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
Icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<entry>
Public
True
Description
None.
TypeId
name=
Name of the entry.
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.
ACT XML Tags
TypeId
userobject=
Related user object name.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
userobject
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Extension>
Defines an ACT extension.
<Extension>
Remarks
This is the base tag or root element under which all other tags/elements fall.
Examples
None.
Tag <Application> (p. 127) Defines an ACT application that will be posted to the ANSYS ACT
Application Store.
Tag <appStoreId> (p. 128) Defines a unique identifier for the ACT application to be used in
the ANSYS ACT Application Store.
Tag <assembly> (p. 129) Defines the assembly to be loaded.
Tag <author> (p. 129) Defines the author of the extension.
Tag <description> (p. 130) Defines the description of the extension.
Tag <Guid> (p. 131) Defines a unique identifier for the extension.
Tag <Interface> (p. 131) Defines the user interface for the extension.
Tag <Licenses> (p. 132) Defines a licenses collection for the extension.
Tag <script> (p. 133) Specifies the IronPython script referenced by the extension.
Tag <simdata> (p. 133) Defines a general section that stores all user object definitions.
Tag <Templates> (p. 134) Defines a collection of control templates.
Tag <UIDefinition> (p. 135) Defines the user interface for the extension.
Tag <Wizard> (p. 135) Defines a wizard within the extension.
Tag <Workflow> (p. 136) Defines custom workflows composed of tasks and task groups.
Attribute debug= (p. 137) Specifies if the scripted version of the extension should be opened
in Debug mode.
Attribute icon= (p. 137) Icon for the extension.
Attribute loadAsDefault= (p. 138) Specifies if the extension should be loaded automatically.
Attribute masked= (p. 139) Specifies if the extension should be loaded automatically, but
hidden in the Extension Manager.
Attribute minorversion= (p. 140) Minor version of the extension.
Attribute name= (p. 141) Name of the extension.
Attribute version= (p. 142) Major version of the extension.
<Application>
Defines an ACT application that will be posted to the ANSYS ACT Application Store.
Type
Ansys_ACT_Core_XmlDataModel_Application (p. 8)
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
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
The format must be: author_shortname..
Examples
None.
Details
Description
Unique identifier of the application for the ANSYS Application Store. The format must be: author_shortname.
ValueName
appStoreId
Name
appStoreId
<Extension>
Public
True
TypeId
<assembly>
Defines the assembly to be loaded.
Type
Ansys_ACT_Core_XmlDataModel_Assembly (p. 20)
Remarks
This tag is typically used to import a specific namespace from a C# dll.
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.
ACT XML Tags
Examples
None.
Details
Description
Defines the author of the extension.
ValueName
authorName
Name
author
Public
True
TypeId
<description>
Defines the description of the extension.
Type
System_String
Remarks
None.
Examples
<step | wizard>
</step | wizard>
Details
Description
Defines the description of the extension.
ValueName
description
Name
description
Public
True
TypeId
<Extension>
<Guid>
Defines a unique identifier for the extension.
Type
Ansys_ACT_Core_XmlDataModel_Guid (p. 202)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Interface>
Defines the user interface for the extension.
Type
Ansys_ACT_Core_XmlDataModel_Interface (p. 216)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Licenses>
Defines a licenses collection for the extension.
Type
Ansys_ACT_Core_XmlDataModel_Licenses (p. 248)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<Extension>
TypeId
<script>
Specifies the IronPython script referenced by the extension.
Type
Ansys_ACT_Core_XmlDataModel_Script (p. 666)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<simdata>
Defines a general section that stores all user object definitions.
Type
Ansys_ACT_Core_XmlDataModel_SimData (p. 668)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Templates>
Defines a collection of control templates.
Type
Ansys_ACT_Core_XmlDataModel_Templates (p. 816)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<Extension>
TypeId
<UIDefinition>
Type
Ansys_ACT_Core_XmlDataModel_UI_UIDefinition (p. 820)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Wizard>
Defines a wizard within the extension.
Type
Ansys_ACT_Core_XmlDataModel_Wizard (p. 822)
Remarks
The wizard file always starts with this tag.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Workflow>
Defines custom workflows composed of tasks and task groups.
Type
Ansys_ACT_Core_XmlDataModel_Workflow (p. 831)
Remarks
Defines the top-level workflow tag within an extension. Used to define process integration items (tasks
and task groups).
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<Extension>
TypeId
debug=
Specifies if the scripted version of the extension should be opened in Debug mode.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
debug
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Icon for the extension.
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
loadAsDefault=
Specifies if the extension should be loaded automatically.
Type
System_Boolean
<Extension>
Remarks
The extension will be loaded automatically if this is set to true.
Examples
None.
Details
Mandatory
False
Name
loadAsDefault
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
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
The extension will be loaded automatically and hidden if this is set to true.
ACT XML Tags
Examples
None.
Details
Mandatory
False
Name
masked
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
minorversion=
Minor version of the extension.
Type
System_Int32
Remarks
None.
Examples
None.
<Extension>
Details
Mandatory
False
Name
minorversion
DefaultValue
0
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the extension.
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
version=
Major version of the extension.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
version
DefaultValue
1
<extensionobject>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<extensionobject>
Extends the extension object definition. (Inherited from DesignXplorer SimEntity)
Remarks
None.
Examples
None.
Tag <Attributes> (p. 144) Defines the set of attributes for the extension
object. (Inherited from SimEntity)
from SimEntity)
Callback <CanAdd> (p. 146) Called to check if the extension object can be
added. (Inherited from SimEntity)
Callback <CanDuplicate> (p. 147) Called to check if the extension object can be
duplicated. (Inherited from SimEntity)
Callback <CanRemove> (p. 148) Called to check if the extension object can be
removed. (Inherited from SimEntity)
Callback <HostObjectModified> (p. 149) Called when the properties of the host object have
changed.
from SimEntity)
ACT XML Tags
from SimEntity)
SimEntity)
from SimEntity)
from SimEntity)
SimEntity)
from SimEntity)
SimEntity)
SimEntity)
from SimEntity)
from SimEntity)
from SimEntity)
Tag <Target> (p. 165) Defines the target location for the object.
<Attributes>
Defines the set of attributes for the extension object. (Inherited from SimEntity)
<extensionobject>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
SimEntity)
Type
Remarks
Examples
None.
Details
ChildType
None.
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.
<extensionobject>
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
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
<extensionobject>
RealParent
TypeId
<HostObjectModified>
Called when the properties of the host object have changed.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Mandatory
False
Name
HostObjectModified
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
ACT XML Tags
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
TypeId
<extensionobject>
<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
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
Type
<extensionobject>
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.
ACT XML Tags
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.
Examples
None.
<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.
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.
<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.
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.
<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.
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.
<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.
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.
<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.
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
Examples
None.
<extensionobject>
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Target>
Defines the target location for the object.
Type
Ansys_ACT_Core_XmlDataModel_Target (p. 742)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
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=
<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
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.
<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.
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
<filter>
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<filter>
Defines a filter.
Remarks
None.
Examples
None.
Attribute name= (p. 171) Name of the filter.

Attribute src= (p. 172) Specifies the path of the referenced IronPython
script file.
name=
Name of the filter.
Type
System_String
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 referenced IronPython script file.
Type
System_String
Remarks
None.
<Geometry>
Examples
None.
Details
Mandatory
False
Name
src
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Geometry>
Defines a geometry feature.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 175) Defines the set of attributes for the geometry.
ACT XML Tags
from SimEntity)
from SimEntity)
from SimEntity)
Callback <OnAfterGenerate> (p. 181) Called at the end of the generation process.
Callback <OnAfterGeometryUpdate> (p. 182) Called when the object has been updated.
SimEntity)
from SimEntity)
Callback <OnEdit> (p. 186) Called when the object is edited.
Callback <OnGenerate> (p. 186) Called when the object is generated.
from SimEntity)
SimEntity)
from SimEntity)
SimEntity)
SimEntity)
from SimEntity)
from SimEntity)
from SimEntity)
<Geometry>
<Attributes>
Defines the set of attributes for the geometry. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
SimEntity)
Type
ACT XML Tags
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
<Geometry>
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
Name
CanDuplicate
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
<Geometry>
Obsolete
False
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
ACT XML Tags
ObsoleteMessage
None.
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.
<Geometry>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAfterGenerate>
Called 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.
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
<Geometry>
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
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
<Geometry>
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
ACT XML Tags
<OnEdit>
Called when the object is edited.
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>
Called when the object is generated.
<Geometry>
Type
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
ACT XML Tags
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>
Type
Remarks
None.
<Geometry>
Examples
None.
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.
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.
<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.
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.
<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.
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.
<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.
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
Examples
None.
<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.
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.
<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.
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=
<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
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>
Defines a unique identifier for the extension.
Remarks
The GUID is the unique identifier of the extension. Two extensions with the same guid will be considered
by ACT as the same extension
This is very important when the extension is deployed to insure that two different extensions will never
be in conflict (same name for example).
<guid>
This identifier must be added before the first build of the extension and must never be changed after
that. When the extension is updated, a new version created, or features addedthe GUID must kept un-
changed.
A GUID can be generated from the project's page command window using the following code:
code type="python"> import System
System.Guid.NewGuid().ToString() </code>
Examples
None.
Attribute shortid= (p. 203) Short identifier for backward

compatibility.
shortid=
Short identifier for backward compatibility.
Type
System_String
Remarks
Must the same as the extension name for all extensions created before R15.
Examples
None.
Details
Mandatory
False
Name
shortid
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
<includegroup>
Defines the include group tag (used by task groups).
Remarks
None.
Examples
None.
Attribute caption= (p. 204) Caption of the item to include. (Inherited from IncludeTag)
Attribute external= (p. 205) Indicates whether the included item is defined outside of the extension
file. (Inherited from IncludeTag)
Attribute name= (p. 206) Name of the item to include. (Inherited from IncludeTag)
caption=
Caption of the item to include. (Inherited from IncludeTag)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
<includegroup>
Name
caption
DefaultValue
None.
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
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the item to include. (Inherited from IncludeTag)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<includetask>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<includetask>
Defines the include task tag (used by task groups).
Remarks
None.
Examples
None.
Attribute caption= (p. 207) Caption of the item to include. (Inherited from IncludeTag)
Attribute external= (p. 208) Indicates whether the included item is defined outside of the extension
file. (Inherited from IncludeTag)
Attribute name= (p. 209) Name of the item to include. (Inherited from IncludeTag)
caption=
Caption of the item to include. (Inherited from IncludeTag)
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
Mandatory
False
Name
caption
DefaultValue
None.
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
<includetask>
Name
external
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the item to include. (Inherited from IncludeTag)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<input>
Defines an input-level data connection definition.
Remarks
None.
Examples
None.
Attribute count= (p. 210) Maximum number of simultaneous input

instances.
Attribute format= (p. 211) Connection format type. (Inherited from
IOItem)
Attribute type= (p. 212) Connection data type. (Inherited from IOItem)
count=
Maximum number of simultaneous input instances.
Type
System_Int32
Remarks
None.
<input>
Examples
None.
Details
Mandatory
False
Name
count
DefaultValue
None.
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.
ACT XML Tags
Details
Mandatory
False
Name
format
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
type=
Connection data type. (Inherited from IOItem)
Type
System_String
Remarks
Used to specify the input and output exposed object types for a task.
Examples
None.
Details
Mandatory
False
<inputfile>
Name
type
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<inputfile>
Defines an input file.
Remarks
None.
Examples
None.
Attribute id= (p. 213) Unique file ID. (Inherited

from File)
Attribute name= (p. 214) The file name. (Inherited
from File)
id=
Unique file ID. (Inherited from File)
Type
System_String
ACT XML Tags
Remarks
None.
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.
<inputs>
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<inputs>
Defines the inputs collection for a task.
Remarks
None.
Examples
None.
Tag <Input> (p. 216) Defines an input-level data connection

definition.
ACT XML Tags
<Input>
Defines an input-level data connection definition.
Type
Ansys_ACT_Core_XmlDataModel_Input (p. 210)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Input
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Interface>
Remarks
The interface element information pertains specifically to the GUI.
Examples
None.
from the IronPython extension script.
Tag <filter> (p. 218) Defines a filter.
<Interface>
Callback <GetPostCommands> (p. 219) Called to collect all "post" commands to add to
the solver input file.
Callback <GetPreCommands> (p. 220) Called to collect all "pre" commands to add to the
solver input file.
Callback <GetSolveCommands> (p. 221) Called to collect all "solve" commands to add to
Tag <images> (p. 222) Defines the default folder where images to be
used by the extension are stored.
Callback <IsAnalysisValid> (p. 222) Called to check if an analysis is valid.
Callback <OnActiveObjectChange> (p. 223) Called when the active object is changed.
Callback <OnAfterGeometryUpdate> (p. 224) Called after the geometry has been updated..
Callback <OnAfterRemove> (p. 225) Called after the object has been removed..
Callback <OnAfterSolve> (p. 226) Called after an analysis has been solved.
Callback <Called before the geometry is Called before the geometry is updated..
updated.> (p. 227)
Callback <OnBeforeSolve> (p. 228) Called before an analysis starts to solve.
changed.
Callback <OnDraw> (p. 230) Called when the application is drawn.
Callback <OnDraw2D> (p. 231) Called when the application is drawn.
Callback <OnInit> (p. 232) Called when the given context is initialized.
Callback <OnLoad> (p. 233) Called when a project is loaded.
Callback <OnMeshCleaned> (p. 234) Called when the mesh is cleaned.
Callback <OnMeshGenerated> (p. 235) Called when the mesh is generated.
Callback <OnPostFinished> (p. 236) Called when the postprocessing ends for a given
analysis.
Callback <OnPostStarted> (p. 237) Called when the postprocessing starts for a given
analysis.
a "ready" state.
Callback <OnSave> (p. 239) Called when a project is saved.
Callback <OnTerminate> (p. 240) Called when the given context is terminated.
Callback <Resume> (p. 241) Called when a project is loaded.
Callback <Save> (p. 242) Called when a project is saved.
Tag <toolbar> (p. 243) Defines a toolbar.
Attribute context= (p. 244) Context or combination of contexts (separated
using '|') for the interface.
<Callbacks>
ACT XML Tags
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<filter>
Defines a filter.
Type
Ansys_ACT_Core_XmlDataModel_Filter (p. 171)
Remarks
None.
Examples
None.
Details
ChildType
None.
<Interface>
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<GetPostCommands>
Called to collect all "post" commands to add to the solver input file.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetAnalysisSolveCommands
Mandatory
False
Name
GetPostCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="post".
ChildType
None.
ACT XML Tags
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
Use 'getcommands' callback with location="pre".
ChildType
None.
MinOccurence
0
<Interface>
MaxOccurence
-1
RealParent
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
Examples
None.
Details
CallbackType
Mandatory
False
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="solve".
ChildType
None.
MinOccurence
0
MaxOccurence
-1
ACT XML Tags
RealParent
TypeId
<images>
Defines the default folder where images to be used by the extension are stored.
By default, ACT looks for images in the same directory as the extension. If images for the extension
have been stored in a subdirectory of the main extension directory called images, the following definition
is appropriate.
This is the most common situation:

<images>images</images>
Type
System_String
Remarks
By default, all folders referenced by this tag are relatives to the folder of the extension.
Examples
None.
Details
Description
Add a folder to find images.
Public
True
Name
images
ValueName
None.
TypeId
<IsAnalysisValid>
Called to check if an analysis is valid.
Type
<Interface>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsAnalysisValid
Mandatory
False
Name
IsAnalysisValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnActiveObjectChange>
Called when the active object is changed.
Type
Ansys_ACT_Core_XmlDataModel_CallbackOnActiveObjectChange (p. 28)
Remarks
None.
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActiveObjectChanged
Mandatory
False
Name
OnActiveObjectChange
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Called after the geometry has been updated..
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAfterRemove>
Called after a geometry has been removed.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnAfterRemove
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAfterSolve>
Called after an analysis has been solved.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolveAnalysis
Mandatory
False
Name
OnAfterSolve
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Called before the geometry is updated.>

Called before the geometry is updated..
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
Called before the geometry is updated.
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnBeforeSolve>
Called when an analysis starts to solve.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Mandatory
False
Name
OnBeforeSolve
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Called when the body suppress state has been changed.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDraw>
Called when the application is drawn.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDraw
Mandatory
False
Name
OnDraw
Public
False
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDraw2D>
Called when the application is drawn.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDraw
Mandatory
False
Name
OnDraw2D
Public
False
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Called when the given context is initialized.
Type
Remarks
Examples
None.
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInit
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnLoad>
Called when a project is loaded.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnLoadSave
Mandatory
False
Name
OnLoad
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMeshCleaned>
Called when the mesh is cleaned.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Mandatory
False
Name
OnMeshCleaned
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMeshGenerated>
Called when the mesh is generated.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnMeshGenerated
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnPostFinished>
Called when the postprocessing ends for a given analysis.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Mandatory
False
Name
OnPostFinished
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnPostStarted>
Called when the postprocessing starts for a given analysis.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnPostStarted
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSave>
Called when a project is saved.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnLoadSave
Mandatory
False
Name
OnSave
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnTerminate>
Called when the given context is terminated.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInit
Mandatory
False
Name
OnTerminate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Resume>
Called when a project is loaded.
Type
Remarks
Useful for the retreival of additional data.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_ResumeExt
Mandatory
False
Name
Resume
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Save>
Called when a project is saved.
Type
Remarks
Useful for the savinig additional data.
Examples
None.
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_SaveExt
Mandatory
False
Name
Save
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<toolbar>
Defines a toolbar.
Type
Ansys_ACT_Core_XmlDataModel_Toolbar (p. 817)
Remarks
None.
Examples
None.
ACT XML Tags
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 taking into account only for specified context(s).
The context specifies the application for which the interface element applies.
If no context is specified, then the interface element applies to all the available applications for ACT.
None.
Examples
None.
Details
Mandatory
True
Name
context
DefaultValue
None.
<Layout>
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
<Layout>
Defines the layout used to display the extension.
Remarks
None.
Examples
None.
Tag <Component> (p. 245) Defines the

component.
layout.
<Component>
Defines the component.
Type
Ansys_ACT_Core_XmlDataModel_UI_Component (p. 31)
Remarks
None.
ACT XML Tags
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
name=
Name of the layout.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
<License>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<License>
Defines a license to be used in the execution of an extension.
Remarks
None.
Examples
None.

license.
name=
Name of the license.
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
Mandatory
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Licenses>
Defines a licenses collection for the extension.
Remarks
None.
Examples
None.
Tag <License> (p. 248) Defines a license to be used in the execution of an

extension.
<License>
Defines a license to be used in the execution of an extension.
<Load>
Type
Ansys_ACT_Core_XmlDataModel_License (p. 247)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Load>
Defines 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.
Tag <Attributes> (p. 251) Defines the set of attributes for the load. (Inherited
from SimEntity)
from SimEntity)
ACT XML Tags
Callback <GetCommands> (p. 255) Called to collect all commands to add to the solver
input file.
Callback <GetNodalValuesForDisplay> (p. 256) Called to get nodal values associated to the load.
solver input file.
from SimEntity)
from SimEntity)
Callback <OnAfterGenerate> (p. 262) Called after the generation is completed.
SimEntity)
from SimEntity)
Callback <OnGenerate> (p. 267) Called when the load object is generated.
from SimEntity)
SimEntity)
from SimEntity)
SimEntity)
SimEntity)
from SimEntity)
<Load>
from SimEntity)
from SimEntity)
Attribute color= (p. 280) Color of scoped entities.
Attribute IsLoad= (p. 282) Indicates whether the load object should be
considered as a load boundary.
Attribute IsSupport= (p. 283) Indicates whether the load object should be
considered as a support boundary.
Attribute unit= (p. 285) Default unit used by the contour display.
<Attributes>
Defines the set of attributes for the object. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
ACT XML Tags
Mandatory
False
TypeId
<Callbacks>
SimEntity)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
<Load>
Remarks
None.
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.
ACT XML Tags
Examples
None.
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.
<Load>
Details
CallbackType
Mandatory
False
Name
CanRemove
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.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetCommands
Mandatory
False
Name
GetCommands
Public
True
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.
<Load>
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetNodeValues
Mandatory
False
Name
GetNodalValuesForDisplay
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetPostCommands>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Mandatory
False
Name
GetPostCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetPreCommands>
Type
Remarks
None.
Examples
None.
<Load>
Details
CallbackType
Mandatory
False
Name
GetPreCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetSolveCommands>
Type
Remarks
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
<Load>
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.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAfterGenerate>
Called when the generation is completed.
Type
Remarks
None.
Examples
None.
<Load>
Details
CallbackType
Mandatory
False
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
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.
<Load>
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.
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.
<Load>
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.
ACT XML Tags
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.
<Load>
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.
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.
<Load>
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.
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.
<Load>
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.
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.
<Load>
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.
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.
<Load>
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
Examples
None.
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.
<Load>
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.
ACT XML Tags
Public
True
Description
None.
TypeId
color=
Color of scoped entities.
Type
System_String
Remarks
The format of the color is the same as for html page. It's #rrggbb where rr is a 2 digits integer in hexa-
decimal for the red part, gg is a 2 digits integer in hexadecimal for the green part and bb is a 2 digits
integer in hexadecimal for the blue part.<br /> For example:<br /> White: #FFFFFF<br /> Black:
#000000<br /> Red: #FF0000<br /> Green: #00FF00<br /> Blue: #0000FF<br />
Examples
None.
Details
Mandatory
False
Name
color
DefaultValue
#00ff00
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
<Load>
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
ACT XML Tags
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.
<Load>
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
ACT XML Tags
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.
<Load>
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
unit=
Default unit used by the contour display.
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
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
<Object>
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Object>
Defines an object.
Remarks
None.
Examples
None.
from SimEntity)
ACT XML Tags
Callback <GetCommands> (p. 293) Called to collect all commands to add to the solver
input file.
Callback <GetNodalValuesForDisplay> (p. 294) Called to get nodal values associated to the load.
solver input file.
from SimEntity)
from SimEntity)
Callback <OnAfterGenerate> (p. 300) Called after the generation is completed.
SimEntity)
from SimEntity)
Callback <OnGenerate> (p. 305) Called when the load object is generated.
from SimEntity)
SimEntity)
from SimEntity)
SimEntity)
SimEntity)
from SimEntity)
from SimEntity)
from SimEntity)
Tag <Target> (p. 316) Defines the target location for the object.
<Object>
Attribute color= (p. 318) Color of scoped entities.
Attribute IsLoad= (p. 321) Indicates whether the load object should be
considered as a load boundary.
Attribute IsSupport= (p. 322) Indicates whether the load object should be
considered as a support boundary.
Attribute unit= (p. 324) Default unit used by the contour display.
<Attributes>
Defines the set of attributes for the load. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
ACT XML Tags
<Callbacks>
SimEntity)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
<Object>
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.
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.
<Object>
Details
CallbackType
Mandatory
False
Name
CanRemove
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.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetCommands
Mandatory
False
Name
GetCommands
Public
True
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.
<Object>
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetNodeValues
Mandatory
False
Name
GetNodalValuesForDisplay
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetPostCommands>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
GetPostCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetPreCommands>
Type
Remarks
None.
Examples
None.
<Object>
Details
CallbackType
Mandatory
False
Name
GetPreCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetSolveCommands>
Type
Remarks
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
<Object>
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.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAfterGenerate>
Called after the generation is completed.
Type
Remarks
None.
Examples
None.
<Object>
Details
CallbackType
Mandatory
False
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
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.
<Object>
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.
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.
<Object>
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.
ACT XML Tags
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.
<Object>
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.
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.
<Object>
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.
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.
<Object>
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.
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.
<Object>
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.
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.
<Object>
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
Examples
None.
ACT XML Tags
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Target>
Type
Ansys_ACT_Core_XmlDataModel_Target (p. 742)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<Object>
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=
ACT XML Tags
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
<Object>
Remarks
The format of the color is the same as for html page. It's #rrggbb where rr is a 2 digits integer in hexa-
decimal for the red part, gg is a 2 digits integer in hexadecimal for the green part and bb is a 2 digits
integer in hexadecimal for the blue part.<br /> For example:<br /> White: #FFFFFF<br /> Black:
#000000<br /> Red: #FF0000<br /> Green: #00FF00<br /> Blue: #0000FF<br />
Examples
None.
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
ACT XML Tags
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.
<Object>
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
ACT XML Tags
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
<Object>
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.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
unit=
Default unit used by the contour display.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
unit
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<Object>
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.
ACT XML Tags
TypeId
<Optimizer>
Defines an optimizer.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 329) Defines the set of attributes for the
optimizer. (Inherited from SimEntity)
Tag <Callbacks> (p. 330) Specifies the callbacks that will invoke
functions from the IronPython extension
script. (Inherited from SimEntity)
Callback <CanAdd> (p. 331) Called to check if the object can be
Callback <CanDuplicate> (p. 332) Called to check if the object can be
Callback <CanRemove> (p. 332) Called to check if the object can be
Callback <CanRun> (p. 333) Indicates if the optimizer (or sampling)
is able to process the optimization
(design of experiments) study with its
current configuration. (Inherited from
DesignExplorer)
Callback <Configuration> (p. 334) Returns a user-readable string
summarizing the current configuration
of the optimizer (or the sampling).
(Inherited from DesignExplorer)
Callback <ConvergenceDescription> (p. 335) Returns a DXConvergenceDescription
object describing the convergence data
provided.
Callback <Description> (p. 336) Returns a user-readable string describing
the optimizer and its specific
capabilities. (Inherited from
DesignExplorer)
Callback <InputParametersEdited> (p. 337) Called when the properties of input
parameters have been changed.
Callback <IsValid> (p. 338) Called to check if the object is valid.
<Optimizer>
Callback <MethodPropertiesEdited> (p. 339) Called when the properties of the

optimization method have been
changed. (Inherited from
DesignExplorer)
Callback <ObjectivesOrConstraintsEdited> (p. 340) Invoked when the definition of
objectives or constraints have changed.
Callback <OnAdd> (p. 341) Called when the object is newly added.
Callback <OnAfterGeometryUpdate> (p. 342) Called after the geometry has been
updated. (Inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 343) Called when the body suppress state
has been changed. (Inherited from
SimEntity)
Callback <OnClearData> (p. 344) Called when object data is cleared.
Callback <OnCreate> (p. 345) Invoked to provide an instance of
IOptimizationMethod (or
ISamplingMethod). (Inherited from
DesignExplorer)
Callback <OnDuplicate> (p. 346) Called when the object is duplicated.
Callback <OnGenerateData> (p. 347) Called when object data is generated.
Callback <OnHide> (p. 348) Called when the object is hidden.
Callback <OnInit> (p. 349) Called when the object is initialized.
Callback <OnMigrate> (p. 350) Called when the object version has been
Callback <OnReady> (p. 351) Called when the application is fully
loaded and in a "ready" state. (Inherited
from SimEntity)
Callback <OnRelease> (p. 352) Invoked to release the
IOptimizationMethod (or the
ISamplingMethod) instance. (Inherited
from DesignExplorer)
Callback <OnRemove> (p. 353) Called when the object is removed.
Callback <OnShow> (p. 354) Called when the object is shown.
Callback <OnSuppress> (p. 355) Called when the object is suppressed.
Callback <OnUnsuppress> (p. 356) Called when the object is unsuppressed.
Callback <ParameterRelationshipsEdited> (p. 357) Invoked when the definition of
parameter relationships have changed.
ACT XML Tags
Tag <Property> (p. 358) Defines a property of any user object.

Callback <QuickHelp> (p. 359) Returns a user-readable string helping
to understand the state of the optimizer
(or the sampling) when CanRun is false.
Callback <Status> (p. 360) Returns a user-readable string describing
the status of the optimization (or the
sampling) resolution. (Inherited from
DesignExplorer)
Attribute basedondirectoptimizationonly= (p. 361) True if the optimizer is only available in
the context of a Direct Optimization
component; false otherwise.
Attribute basedonresponsesurfaceonly= (p. 362) True if the optimizer is only available in
the context of a Response Surface
component; false otherwise.
Attribute caption= (p. 363) Caption for the object. (Inherited from
SimEntity)
Attribute class= (p. 363) Class name of the controller of the
Attribute constrainthandling= (p. 364) Supports constraint handling.
Attribute constraintimportance= (p. 365) Supports the Importance property of a
constraint.
Attribute constraintoninputparameter= (p. 366) Supports constraints defined on an
Input Parameter.
Attribute contextual= (p. 367) Indicates whether the object must be
displayed in the contextual menu.
Attribute convergencedata= (p. 368) Provides convergence data.
Attribute equaltoconstraint= (p. 369) Supports the Equal To constraint type.
Attribute greaterthanconstraint= (p. 370) Supports the Greater Than constraint
type.
Attribute historychartxaxistype= (p. 371) Defines the X axis type for history charts.
Attribute icon= (p. 372) Icon for the object. (Inherited from
SimEntity)
Attribute insideboundsconstraint= (p. 372) Supports the Inside Bounds constraint
type.
Attribute lessthanconstraint= (p. 373) Supports the Less Than constraint type.
Attribute logfile= (p. 374) Provides messages to generate a log file.
Attribute maximizeobjective= (p. 375) Supports the Maximize objective type.
Attribute maximumnumberofconstraints= (p. 376) Defines the maximum number of
constraints supported by the optimizer.
<Optimizer>
Attribute maximumnumberofdoublelistparameters= (p. 377) Indicates the maximum number of

double list parameters supported.
Attribute maximumnumberofdoubleparameters= (p. 378) Indicates the maximum number of
double parameters supported. (Inherited
Attribute maximumnumberofinputparameters= (p. 379) Indicates the maximum number of input
parameters supported. (Inherited from
DesignExplorer)
Attribute maximumnumberofintegerlistparameters= (p. 380) Indicates the maximum number of
integer list parameters supported.
Attribute maximumnumberofobjectives= (p. 381) Defines the maximum number of
objectives supported by the optimizer.
Attribute minimizeobjective= (p. 381) Supports the Minimize objective type.
Attribute minimumnumberofconstraints= (p. 382) Defines the minimum number of
constraints required.
Attribute minimumnumberofobjectives= (p. 383) Defines the minimum number of
objectives required.
Attribute name= (p. 384) Name of the object. (Inherited from
SimEntity)
Attribute objectiveimportance= (p. 385) Supports the Importance property of an
objective.
Attribute objectiveoninputparameter= (p. 386) Supports objectives defined on an Input
Parameter.
Attribute parameterrelationship= (p. 387) Supports parameter relationships.
Attribute seekobjective= (p. 388) Supports the Seek objective type.
Attribute startingpointrequired= (p. 389) Requires a Starting Point.
Attribute version= (p. 390) Version of the object. (Inherited from
SimEntity)
<Attributes>
Defines the set of attributes for the optimizer. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
SimEntity)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<Optimizer>
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
TypeId
ACT XML Tags
<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
<CanRemove>
<Optimizer>
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
<CanRun>
Indicates if the optimizer (or sampling) is able to process the optimization (design of experiments) study
with its current configuration. (Inherited from DesignExplorer)
ACT XML Tags
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
<Configuration>
Returns a user-readable string summarizing the current configuration of the optimizer (or the sampling).
<Optimizer>
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
RealParent
TypeId
<ConvergenceDescription>
Returns a DXConvergenceDescription object describing the convergence data provided.
Type
ACT XML Tags
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
TypeId
<Description>
Returns a user-readable string describing the optimizer and its specific capabilities. (Inherited from De-
signExplorer)
Type
<Optimizer>
Remarks
None.
Examples
<step | wizard>
</step | wizard>
Details
CallbackType
Mandatory
False
Name
Description
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<InputParametersEdited>
Invoked when the properties of input parameters have changed. (Inherited from DesignExplorer)
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
InputParametersEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsValid>
Type
Remarks
None.
<Optimizer>
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<MethodPropertiesEdited>
Invoked when the properties of the optimization method have changed. (Inherited from DesignExplorer)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
MethodPropertiesEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<ObjectivesOrConstraintsEdited>
Invoked when the definition of objectives or constraints have changed.
Type
Remarks
None.
Examples
None.
<Optimizer>
Details
CallbackType
Mandatory
False
Name
ObjectivesOrConstraintsEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
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.
<Optimizer>
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
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.
<Optimizer>
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnCreate>
Invoked to provide an instance of IOptimizationMethod (or ISamplingMethod). (Inherited from DesignEx-
plorer)
Type
Remarks
None.
Examples
None.
ACT XML Tags
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.
<Optimizer>
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.
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.
<Optimizer>
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.
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.
<Optimizer>
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.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRelease>
Invoked to release the IOptimizationMethod (or the ISamplingMethod) instance. (Inherited from De-
signExplorer)
Type
Remarks
None.
Examples
None.
<Optimizer>
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.
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.
<Optimizer>
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.
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.
<Optimizer>
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<ParameterRelationshipsEdited>
Invoked when the definition of parameter relationships have changed.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
ParameterRelationshipsEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
Examples
None.
<Optimizer>
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<QuickHelp>
Returns 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
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Status>
Returns a user-readable string describing the status of the optimization (or the sampling) resolution.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Status
Public
True
Obsolete
False
ObsoleteMessage
None.
<Optimizer>
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.
ACT XML Tags
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.
<Optimizer>
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=
ACT XML Tags
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
<Optimizer>
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.
ACT XML Tags
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.
<Optimizer>
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
ACT XML Tags
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
<Optimizer>
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.
ACT XML Tags
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.
<Optimizer>
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.
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
insideboundsconstraint=
Supports the Inside Bounds constraint type.
<Optimizer>
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
ACT XML Tags
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.
<Optimizer>
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.
ACT XML Tags
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
<Optimizer>
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
ACT XML Tags
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.
<Optimizer>
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.
ACT XML Tags
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.
<Optimizer>
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.
ACT XML Tags
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
<Optimizer>
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.
ACT XML Tags
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.
<Optimizer>
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
ACT XML Tags
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
<Optimizer>
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.
ACT XML Tags
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.
<Optimizer>
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.
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
<output>
Defines an output-level data connection definition
<output>
Remarks
None.
Examples
None.
Attribute format= (p. 391) Connection format type. (Inherited from

IOItem)
Attribute type= (p. 392) Cconnection data type. (Inherited from
IOItem)
format=
Connection format type. (Inherited from IOItem)
Type
System_String
Remarks
This is used by upstream tasks or your task to determine what "specialized" format should be produced
for the more general "Type" property.
Examples
None.
Details
Mandatory
False
Name
format
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
type=
Cconnection data type. (Inherited from IOItem)
Type
System_String
Remarks
Used to specify the input and output exposed object types for a task.
Examples
None.
Details
Mandatory
False
Name
type
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
<outputfile>
Description
None.
TypeId
<outputfile>
Defines an output file.
Remarks
None.
Examples
None.
Attribute id= (p. 393) Unique file ID. (Inherited from File)
Attribute name= (p. 394) Name of the output file. (Inherited
from File)
id=
Unique file ID. (Inherited from File)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
id
DefaultValue
None.
DataDefinition
False
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the output file. (Inherited from File)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
<outputs>
MappedValues
None.
Public
True
Description
None.
TypeId
<outputs>
Defines the outputs collection for a task.
Remarks
None.
Examples
None.
Tag <Output> (p. 395) Defines an output-level data connection

definition.
<Output>
Defines an output-level data connection definition.
Type
Ansys_ACT_Core_XmlDataModel_Output (p. 390)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Output
MinOccurence
0
ACT XML Tags
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Panel>
Defines a panel to be displayed in the application.
Remarks
None.
Examples
None.
Tag <Callbacks> (p. 396) Specifies the callbacks that will invoke functions from the
IronPython extension script. (Inherited from SimEntity)
Callback <OnPanelHidden> (p. 397) Called when the panel is hidden.
Callback <OnPanelInitialized> (p. 398) Called when the panel is initialized.
Callback <OnPanelShown> (p. 399) Called when the panel is shown.
Attribute layout= (p. 401) Layout of the panel.
Attribute name= (p. 402) Name of the panel.
<Callbacks>
Type
Remarks
Examples
None.
<Panel>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<OnPanelHidden>
Called when the panel is hidden.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPanel_
Mandatory
False
Name
OnPanelHidden
Public
True
Obsolete
False
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnPanelInitialized>
Called when the panel is initialized.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnPanelInitialized
Public
True
Obsolete
False
ObsoleteMessage
None.
<Panel>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnPanelShown>
Called when the panel is shown.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnPanelShown
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
ACT XML Tags
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
class=
Class name of the controller of the object.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
<Panel>
Description
None.
TypeId
layout=
Layout of the panel.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
layout
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
name=
Name of the panel.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<parameter>
Defines a single parameter definition for a task.
<parameter>
Remarks
The parameter element specifies the parameter value for this task. In Workbench, a parameter will be
automatically created for this entry.This will not be associated with a displayed data property.
Parameters are defined in the optional <parameters> node. At minimum, each parameter definition
must include the following attributes: name, usage, control, and version.
Examples
None.
Tag <Attributes> (p. 404) Defines the set of attributes for the parameter.
from SimEntity)
from SimEntity)
from SimEntity)
SimEntity)
from SimEntity)
from SimEntity)
SimEntity)
from SimEntity)
ACT XML Tags
SimEntity)
SimEntity)
from SimEntity)
from SimEntity)
from SimEntity)
Attribute control= (p. 427) Underlying data type for the parameter.
Attribute usage= (p. 429) Usage of the parameter.
<Attributes>
Defines the set of attributes for the parameter. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
<parameter>
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
SimEntity)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
ACT XML Tags
Remarks
None.
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.
<parameter>
Examples
None.
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.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
<parameter>
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.
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.
<parameter>
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
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.
<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.
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.
<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.
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.
<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.
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.
<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.
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.
<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.
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.
<parameter>
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
Examples
None.
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.
<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.
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.
<parameter>
TypeId
control=
Underlying data type for 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=
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
<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.
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.
<parameters>
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<parameters>
Defines the collection of task parameters.
Remarks
Defines the parameters to be exposed by this task.
Examples
None.
Tag <Parameter> (p. 431) Defines a single parameter definition for

a task.
<Parameter>
Defines a single parameter definition for a task.
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Parameter (p. 402)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Parameter
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<platform>
Defines the platform.
Remarks
None.
Examples
None.
Attribute name= (p. 432) Name of the platform.

Attribute path= (p. 433) Platform-supported path (e.g., to
an exe)
name=
Name of the platform.
<platform>
Type
System_String
Remarks
May be "Win64" or "Linux64".
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
path=
Platform-supported path (e.g., to an exe)
Type
System_String
ACT XML Tags
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>
Defines the program.
Remarks
None.
<program>
Examples
None.
Tag <Argument> (p. 435) Defines the program's command-line

arguments.
Tag <Platform> (p. 435) Defines the program's supported platforms.
<Argument>
Defines 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>
Defines the program's supported platforms.
Type
Ansys_ACT_Core_XmlDataModel_Platform (p. 432)
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Platform
MinOccurence
1
MaxOccurence
-1
RealParent
None.
Mandatory
True
TypeId
<projectdata>
Defines the data for the project.
Remarks
None.
Examples
None.
Tag <DataEntity> (p. 436) Currently not

in use.
<DataEntity>
Currently not in use.
Type
Ansys_ACT_Core_XmlDataModel_DataEntity (p. 63)
<property>
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_DataEntity
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<property>
Defines a property of any user object.
Remarks
Examples
None.
Tag <Attributes> (p. 439) Defines the set of attributes for the property.
(Inherited from PropertyBase)
from PropertyBase)
Callback <GetValue> (p. 441) Called when the property value is accessed.
ACT XML Tags
Callback <IsValid> (p. 442) Called to check if the property is valid. (Inherited
from PropertyBase)
Callback <IsVisible> (p. 442) Called to check if the property is visible. (Inherited
from PropertyBase)
Callback <OnActivate> (p. 443) Called when the property is activated. (Inherited
from PropertyBase)
Callback <OnAdd> (p. 444) Called when the property is added. (Inherited from
PropertyBase)
Callback <OnApply> (p. 446) Called when the property Apply button is clicked.
changed. (Inherited from PropertyBase)
Callback <OnCancel> (p. 448) Called when the property Cancel button is clicked.
Callback <OnDuplicate> (p. 449) Called when the property is duplicated. (Inherited
from PropertyBase)
Callback <OnHide> (p. 450) Called when the property is hidden. (Inherited
from PropertyBase)
Callback <OnInit> (p. 451) Called when the property is initialized. (Inherited
from PropertyBase)
Callback <OnMigrate> (p. 452) Called when the property version has been
Callback <OnRemove> (p. 453) Called when the property is removed. (Inherited
from PropertyBase)
Callback <OnShow> (p. 454) Called when the property is shown. (Inherited from
PropertyBase)
Callback <OnValidate> (p. 455) Called when the property is validated. (Inherited
from PropertyBase)
Callback <SetValue> (p. 456) Called to set the property value. (Inherited from
PropertyBase)
Callback <String2Value> (p. 457) Called to convert a string to the property value.
Callback <Value2String> (p. 458) Called to convert the value stored by the property
into a string. (Inherited from PropertyBase)
Attribute caption= (p. 459) Caption for the property. (Inherited from
PropertyBase)
Attribute class= (p. 460) Class name of the property's controller. (Inherited
from PropertyBase)
Attribute control= (p. 461) Control type of the object.
Attribute default= (p. 462) Default value of the property. (Inherited from
PropertyBase)
Attribute elementtype= (p. 463) Property list element type (workflow). (Inherited
from PropertyBase)
<property>
Attribute isparameter= (p. 464) Indicates whether the property is a parameter.

Attribute keytype= (p. 465) Property dictionary key type (workflow). (Inherited
from PropertyBase)
Attribute name= (p. 465) Name of the property. (Inherited from
PropertyBase)
Attribute needupdate= (p. 466) Indicates whether the context has to be refreshed
when the property value change. (Inherited from
PropertyBase)
Attribute parameterizable= (p. 467) 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. 468) The property persistence (workflow). Indicates
whether the property data should be saved within
the project. (Inherited from PropertyBase)
Attribute readonly= (p. 469) Indicates whether the property is read-only.
Attribute unit= (p. 470) Unit type of the property (for 'control' equals to
'float' only). (Inherited from PropertyBase)
Attribute valuetype= (p. 471) Property dictionary value type (workflow).
Attribute visible= (p. 472) Indicates whether the property is visible. (Inherited
from PropertyBase)
Attribute visibleon= (p. 473) With a PropertyGroup parent of control type
"select", indicates the select values for this property
to be visible (separate with '|'). (Inherited from
PropertyBase)
<Attributes>
Defines the set of attributes for the property. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
PropertyBase)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<property>
TypeId
<GetValue>
Called to get values when the property value is accessed. (Inherited from PropertyBase)
Type
Remarks
None.
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
ACT XML Tags
<IsValid>
Called to check if the property is valid. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsVisible>
Called to check if the property is visible. (Inherited from PropertyBase)
<property>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible
Mandatory
False
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnActivate>
Called when the property is activated. (Inherited from PropertyBase)
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Mandatory
False
Name
OnActivate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Called when the property is added. (Inherited from PropertyBase)
Type
Remarks
<property>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Called after the geometry has been updated. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnApply>
Called when the property Apply button is clicked. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
<property>
Details
CallbackType
Mandatory
False
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Called when the body suppress state has been changed. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnCancel>
Called when the property Cancel button is clicked. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
<property>
Details
CallbackType
Mandatory
False
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Called when the property is duplicated. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnHide>
Called when the property is hidden. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
<property>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnInit>
Called when the property is initialized. (Inherited from PropertyBase)
Type
Remarks
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
Called when the property version has been changed. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
<property>
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>
Called when the property is removed. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnShow>
Called when the property is shown. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
<property>
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnValidate>
Called when the property is validated. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<SetValue>
Called to set the property value. (Inherited from PropertyBase)
Type
Remarks
Useful for transforming the submitted value.
Examples
None.
<property>
Details
CallbackType
Mandatory
False
Name
SetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<String2Value>
Called to convert a string to the property value. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
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>
Called to convert the value stored by the property into a string. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
<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 for the property. (Inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
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 IUserOb-
ject)</li><li>The associated property (of type ISimProperty)</li></ul>
Examples
None.
Details
Mandatory
False
<property>
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
control=
Control type of the object.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
control
DefaultValue
None.
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.
<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.
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.
<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)
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 has to be refreshed when the property value change. (Inherited from
PropertyBase)
Type
System_Boolean
<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=
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.
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=
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.
<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
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.
<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.
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.
<property>
Public
True
Description
None.
TypeId
visibleon=
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.
ACT XML Tags
TypeId
<propertygroup>
Defines a collection of properties
Remarks
None.
Examples
None.
Tag <Attributes> (p. 476) Defines the set of attributes for the property
group. (Inherited from PropertyBase)
from PropertyBase)
Callback <GetValue> (p. 477) Called to get values when the property value is
accessed. (Inherited from PropertyBase)
from PropertyBase)
from PropertyBase)
from PropertyBase)
PropertyBase)
from PropertyBase)
from PropertyBase)
from PropertyBase)
<propertygroup>
from PropertyBase)
PropertyBase)
from PropertyBase)
from PropertyBase)
Callback <SetValue> (p. 493) Called to set the property value. Useful for
transforming the submitted value.
PropertyBase)
from PropertyBase)
PropertyBase)
Attribute display= (p. 499) Display type of the property group.
from PropertyBase)
from PropertyBase)
PropertyBase)
PropertyBase)
from PropertyBase)
ACT XML Tags

from PropertyBase)
PropertyBase)
<Attributes>
Defines the set of attributes for the property group. (Inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
PropertyBase)
<propertygroup>
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<GetValue>
Type
Remarks
None.
Examples
None.
Details
CallbackType
ACT XML Tags
Mandatory
False
Name
GetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
<propertygroup>
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IsVisible>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsVisible
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnActivate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnActivate
Public
True
<propertygroup>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
Obsolete
False
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
<propertygroup>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnApply>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
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
<propertygroup>
MaxOccurence
-1
RealParent
TypeId
<OnCancel>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
ACT XML Tags
RealParent
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
<propertygroup>
TypeId
<OnHide>
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
ACT XML Tags
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnMigrate>
<propertygroup>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRemove>
Type
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>
Type
Remarks
None.
<propertygroup>
Examples
None.
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.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Defines a property of any user object.
Type
Remarks
Examples
None.
<propertygroup>
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<SetValue>
Called to set the property value. (Inherited from PropertyBase)
Type
Remarks
Useful for transforming the submitted value.
Examples
None.
Details
CallbackType
Mandatory
False
Name
SetValue
Public
True
Obsolete
False
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.
<propertygroup>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Value2String>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
ACT XML Tags
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
<propertygroup>
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.
ACT XML Tags
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=
<propertygroup>
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=
Display type of the property group.
Type
Ansys_ACT_Interfaces_UserObject_PropertyDisplayEnum
ACT XML Tags
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.
<propertygroup>
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.
ACT XML Tags
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
<propertygroup>
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.
ACT XML Tags
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.
<propertygroup>
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
MappedValues
None.
ACT XML Tags
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
Description
None.
<propertygroup>
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
unit=
ACT XML Tags
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
<propertygroup>
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.
ACT XML Tags
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.
<propertytable>
Details
Mandatory
False
Name
visibleon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
<propertytable>
Remarks
None.
Examples
None.
Tag <Attributes> (p. 513) Defines the set of attributes for the property table.
from PropertyBase)
Callback <GetValue> (p. 515) Called to get values when the property value is
accessed. (Inherited from PropertyBase)
ACT XML Tags
from PropertyBase)
from PropertyBase)
from PropertyBase)
PropertyBase)
from PropertyBase)
from PropertyBase)
from PropertyBase)
from PropertyBase)
PropertyBase)
from PropertyBase)
Tag <PropertyTable> (p. 530) Encapsulates a list of child properties under one
table.
Callback <SetValue> (p. 531) Called to set the property value. Useful for
transforming the submitted value. (Inherited from
PropertyBase)
Attribute allowempty= (p. 534) Indicates whether the property table is valid even
if empty.
PropertyBase)
from PropertyBase)
<propertytable>

PropertyBase)
Attribute display= (p. 538) Display type of the property group.
from PropertyBase)
from PropertyBase)
PropertyBase)
PropertyBase)
from PropertyBase)
from PropertyBase)
PropertyBase)
<Attributes>
Defines the set of attributes for the property table. (Inherited from PropertyBase)
Type
Remarks
None.
ACT XML Tags
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
PropertyBase)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
<propertytable>
RealParent
None.
Mandatory
False
TypeId
<GetValue>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
GetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
ACT XML Tags
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
<propertytable>
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
TypeId
ACT XML Tags
<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
<OnAdd>
<propertytable>
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
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
<OnApply>
Type
Remarks
None.
<propertytable>
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.
Examples
None.
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.
<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.
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.
<propertytable>
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.
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.
<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.
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.
<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.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<PropertyTable>
Type
Ansys_ACT_Core_XmlDataModel_PropertyTable (p. 511)
Remarks
None.
Examples
None.
<propertytable>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_PropertyTable
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<SetValue>
Called to set the property value. Useful for transforming the submitted value. (Inherited from Property-
Base)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
SetValue
Public
True
Obsolete
False
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.
<propertytable>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Value2String>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
ACT XML Tags
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
allowempty=
Indicates whether the property table is valid even if empty.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
allowempty
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
<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
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=
<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
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=
Display type of the property group.
Type
Ansys_ACT_Interfaces_UserObject_PropertyDisplayEnum
Remarks
None.
<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.
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
<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.
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.
<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.
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
Description
None.
<propertytable>
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
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=
<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
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.
<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.
ACT XML Tags
Details
Mandatory
False
Name
visibleon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
<Result>
Defines a result.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 552) Defines the set of attributes for the result.
from SimEntity)
<Result>
Callback <Evaluate> (p. 556) Called when the step describe by stepInfo is
evaluated.
Callback <GetFieldCount> (p. 557) Called to get the number of fields for a given
element or node ID.
Callback <GetValue> (p. 558) Called to get the values associated to a node or
an element given by its ID.
from SimEntity)
from SimEntity)
SimEntity)
from SimEntity)
Callback <OnEndEval> (p. 565) Called at the end of the evaluation process for a
given step.
Callback <OnEndPost> (p. 566) Called at the end of the post process.
from SimEntity)
SimEntity)
from SimEntity)
SimEntity)
SimEntity)
Callback <OnStartEval> (p. 574) Called when the evaluation process for a given
step starts.
Callback <OnStartPost> (p. 575) Called at the begining of the post process.
from SimEntity)
ACT XML Tags
from SimEntity)
from SimEntity)
Attribute averaging= (p. 579) Averaging of the result.
Attribute hasimaginary= (p. 582) Indicates if the result supports imaginary values.
Attribute location= (p. 584) Location of the result.
Attribute timehistory= (p. 586) Indicates if the time history must be calculated.
Attribute type= (p. 587) Type of the result.
Attribute unit= (p. 588) Unit used by the contour display.
<Attributes>
Defines the set of attributes for the result. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
<Result>
Mandatory
False
TypeId
<Callbacks>
SimEntity)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
ACT XML Tags
Remarks
None.
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.
<Result>
Examples
None.
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.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Evaluate>
Called when the step describe by stepInfo is evaluated.
Type
Remarks
None.
Examples
None.
<Result>
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>
Called to get the number of fields for a given element or node ID.
Type
Remarks
None.
Examples
None.
ACT XML Tags
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>
Called to get the values associated to a node or an element given by its ID.
Type
Remarks
None.
Examples
None.
<Result>
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.
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.
<Result>
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.
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.
<Result>
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.
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.
<Result>
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnEndEval>
Called at the end of the evaluation process for a given step.
Type
Remarks
None.
Examples
None.
ACT XML Tags
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>
Called at the end of the post process.
Type
Remarks
None.
Examples
None.
<Result>
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.
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.
<Result>
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.
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.
<Result>
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.
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.
<Result>
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.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnStartEval>
Called when the evaluation process for a given step starts.
Type
Remarks
None.
Examples
None.
<Result>
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>
Called at the begining of the post process.
Type
Remarks
None.
Examples
None.
ACT XML Tags
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.
<Result>
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.
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
Examples
None.
<Result>
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.
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.
<Result>
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.
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
hasimaginary=
Indicates if the result supports imaginary values.
<Result>
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
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
location=
Location of the result.
Type
Ansys_ACT_Interfaces_Post_ResultLocationEnum
Remarks
None.
<Result>
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.
ACT XML Tags
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
timehistory=
Indicates if the time history must be calculated.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
<Result>
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.
ACT XML Tags
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.
<Result>
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.
ACT XML Tags
Public
True
Description
None.
TypeId
<rsmjob>
Defines an rsm job.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 592) Defines the set of

attributes for the rsmjob.
Tag <Callbacks> (p. 593) Specifies the callbacks that
will invoke functions from
the IronPython extension
script. (Inherited from
SimEntity)
Callback <CanAdd> (p. 594) Called to check if the
object can be added.
Callback <CanDuplicate> (p. 595) Called to check if the
object can be duplicated.
Callback <CanRemove> (p. 595) Called to check if the
object can be removed.
Tag <InputFile> (p. 596) Job input files.
Callback <IsValid> (p. 597) Called to check if the
object is valid. (Inherited
from SimEntity)
Callback <OnAdd> (p. 598) Called when the object is
newly added. (Inherited
from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 599) Called after the geometry
has been updated.
<rsmjob>
Callback <OnBodySuppressStateChange> (p. 600) Called when the body

suppress state has been
changed. (Inherited from
SimEntity)
Callback <OnClearData> (p. 601) Called when object data
is cleared. (Inherited from
SimEntity)
Callback <oncreatejobinput> (p. 602) Handles the generation of
all input files defined on
the rsm job.
Callback <OnDuplicate> (p. 603) Called when the object is
duplicated. (Inherited from
SimEntity)
Callback <OnGenerateData> (p. 604) Called when object data
is generated. (Inherited
from SimEntity)
Callback <OnHide> (p. 605) Called when the object is
hidden. (Inherited from
SimEntity)
Callback <OnInit> (p. 606) Called when the object is
initialized. (Inherited from
SimEntity)
Callback <onjobcancellation> (p. 606) Handles a user-invoked
job cancellation.
Callback <onjobreconnect> (p. 607) 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. 608) Handles the status polling
engaged by the
Framework.
Callback <OnMigrate> (p. 609) Called when the object
version has been changed.
Callback <OnReady> (p. 610) Called when the
application is fully loaded
and in a "ready" state.
Callback <OnRemove> (p. 611) Called when the object is
removed. (Inherited from
SimEntity)
Callback <OnShow> (p. 612) Called when the object is
shown. (Inherited from
SimEntity)
ACT XML Tags
Callback <OnSuppress> (p. 613) Called when the object is

suppressed. (Inherited
from SimEntity)
Callback <OnUnsuppress> (p. 614) Called when the object is
unsuppressed. (Inherited
from SimEntity)
Tag <OutputFile> (p. 615) The job output files.
Tag <Program> (p. 616) Programs to be run by the
RSM job.
Tag <Property> (p. 617) Defines a property of any
user object. (Inherited
from SimEntity)
Attribute caption= (p. 617) Caption for the object.
Attribute class= (p. 618) Class name of the
controller of the object.
Attribute contextual= (p. 619) Indicates whether the
object must be displayed
in the contextual menu.
Attribute deletefiles= (p. 620) Indicates whether ACT
should delete all rsmJob
input and output files
upon successful
completion or job
cancellation.
Attribute icon= (p. 621) Icon for the object.
Attribute name= (p. 622) Name of the object.
Attribute version= (p. 623) Version of the object.
<Attributes>
Defines the set of attributes for the rsmjob. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
<rsmjob>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
SimEntity)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
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
TypeId
<rsmjob>
<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
<CanRemove>
ACT XML Tags
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
<InputFile>
Job input files.
Type
Ansys_ACT_Core_XmlDataModel_InputFile (p. 213)
<rsmjob>
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_InputFile
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
<rsmjob>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
<rsmjob>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
ACT XML Tags
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<oncreatejobinput>
Handles the generation of all input files defined on the rsm job.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_DataContainerReference__IFullContext__List_string__
Mandatory
True
Name
oncreatejobinput
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
1
<rsmjob>
MaxOccurence
-1
RealParent
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
ACT XML Tags
RealParent
TypeId
<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
<rsmjob>
TypeId
<OnHide>
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
ACT XML Tags
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onjobcancellation>
Handles a user-invoked job cancellation.
<rsmjob>
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_DataContainerReference__IFullContext__List_string___List_string__
Mandatory
True
Name
onjobcancellation
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
1
MaxOccurence
-1
RealParent
TypeId
<onjobreconnect>
Handles the reconnection of the rsm job.
Type
ACT XML Tags
Remarks
The implementor must update the task data model to deem the task as up-to-date.
Examples
None.
Details
CallbackType
ActionCallback_DataContainerReference__IFullContext__List_string__
Mandatory
True
Name
onjobreconnect
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
1
MaxOccurence
-1
RealParent
TypeId
<onjobstatus>
Handles the status polling engaged by the Framework.
Type
Remarks
Return True to indicate the job has completed.
<rsmjob>
Examples
None.
Details
CallbackType
FuncCallback_DataContainerReference__IQueryContext__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.
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.
<rsmjob>
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.
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.
<rsmjob>
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.
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.
<rsmjob>
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. 393)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_OutputFile
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Program>
Programs to be run by the RSM job.
Type
Ansys_ACT_Core_XmlDataModel_Program (p. 434)
Remarks
Currently only one program per job is allowed.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Program
MinOccurence
1
MaxOccurence
1
RealParent
None.
Mandatory
True
<rsmjob>
TypeId
<Property>
Type
Remarks
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
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
class=
Type
System_String
Remarks
Examples
None.
<rsmjob>
Details
Mandatory
False
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
ACT XML Tags
Name
contextual
DefaultValue
True
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
<rsmjob>
DataDefinition
False
AllowedValues
None.
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.
ACT XML Tags
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.
<rsmjob>
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.
ACT XML Tags
TypeId
<Sampling>
Defines a DesignExplorer sampling.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 626) Defines the set of attributes for the
Tag <Callbacks> (p. 627) Specifies the callbacks that will invoke
functions from the IronPython extension
script. (Inherited from SimEntity)
Callback <CanAdd> (p. 628) Called to check if the object can be
Callback <CanDuplicate> (p. 629) Called to check if the object can be
Callback <CanRemove> (p. 629) Called to check if the object can be
Callback <CanRun> (p. 630) Indicates if the optimizer (or sampling)
is able to process the optimization
(design of experiments) study with its
current configuration. (Inherited from
DesignExplorer)
Callback <Configuration> (p. 631) Returns a user-readable string
summarizing the current configuration
of the optimizer (or the sampling).
Callback <Description> (p. 632) Returns a user-readable string describing
the optimizer and its specific
capabilities. (Inherited from
DesignExplorer)
Callback <InputParametersEdited> (p. 633) Invoked when the properties of input
parameters have changed. (Inherited
Callback <IsValid> (p. 634) Called to check if the object is valid.
Callback <MethodPropertiesEdited> (p. 635) Invoked when the properties of the
optimization method have changed.
<Sampling>
Callback <OnAdd> (p. 636) Called when the object is newly added.
Callback <OnAfterGeometryUpdate> (p. 637) Called after the geometry has been
updated. (Inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 638) Called when the body suppress state
has been changed. (Inherited from
SimEntity)
Callback <OnClearData> (p. 639) Called when object data is cleared.
Callback <OnCreate> (p. 640) Invoked to provide an instance of
IOptimizationMethod (or
ISamplingMethod). (Inherited from
DesignExplorer)
Callback <OnDuplicate> (p. 641) Called when the object is duplicated.
Callback <OnGenerateData> (p. 642) Called when object data is generated.
Callback <OnHide> (p. 643) Called when the object is hidden.
Callback <OnInit> (p. 644) Called when the object is initialized.
Callback <OnMigrate> (p. 645) Called when the object version has been
Callback <OnReady> (p. 646) Called when the application is fully
loaded and in a "ready" state. (Inherited
from SimEntity)
Callback <OnRelease> (p. 647) Invoked to release the
IOptimizationMethod (or the
ISamplingMethod) instance. (Inherited
Callback <OnRemove> (p. 648) Called when the object is removed.
Callback <OnShow> (p. 649) Called when the object is shown.
Callback <OnSuppress> (p. 650) Called when the object is suppressed.
Callback <OnUnsuppress> (p. 651) Called when the object is unsuppressed.
Tag <Property> (p. 652) Defines a property of any user object.
Callback <QuickHelp> (p. 653) Returns a user-readable string helping
to understand the state of the optimizer
(or the sampling) when CanRun is false.
Callback <Status> (p. 654) Returns a user-readable string describing
the status of the optimization (or the
ACT XML Tags
sampling) resolution. (Inherited from

DesignExplorer)
Attribute caption= (p. 655) Caption for the object. (Inherited from
SimEntity)
Attribute class= (p. 656) Class name of the controller of the
Attribute contextual= (p. 657) Indicates whether the object must be
displayed in the contextual menu.
Attribute CustomTable= (p. 657) Supports Custom Table Points
Attribute icon= (p. 658) Icon for the object. (Inherited from
SimEntity)
Attribute logfile= (p. 659) Provides messages to generate a log file.
Attribute maximumnumberofdoublelistparameters= (p. 660) Indicates the maximum number of
double list parameters supported.
Attribute maximumnumberofdoubleparameters= (p. 661) Indicates the maximum number of
double parameters supported. (Inherited
Attribute maximumnumberofinputparameters= (p. 662) Indicates the maximum number of input
parameters supported. (Inherited from
DesignExplorer)
Attribute maximumnumberofintegerlistparameters= (p. 663) Indicates the maximum number of
integer list parameters supported.
Attribute name= (p. 664) Name of the object. (Inherited from
SimEntity)
Attribute version= (p. 665) Version of the object. (Inherited from
SimEntity)
<Attributes>
Type
Remarks
None.
Examples
None.
<Sampling>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
SimEntity)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
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
TypeId
<Sampling>
<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
<CanRemove>
ACT XML Tags
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
<CanRun>
Indicates if the optimizer (or sampling) is able to process the optimization (design of experiments) study
with its current configuration. (Inherited from DesignExplorer)
<Sampling>
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
<Configuration>
Returns a user-readable string summarizing the current configuration of the optimizer (or the sampling).
ACT XML Tags
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
<Description>
Returns a user-readable string describing the optimizer and its specific capabilities. (Inherited from De-
signExplorer)
<Sampling>
Type
Remarks
None.
Examples
<step | wizard>
</step | wizard>
Details
CallbackType
Mandatory
False
Name
Description
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<InputParametersEdited>
Invoked when the properties of input parameters have changed. (Inherited from DesignExplorer)
ACT XML Tags
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
<IsValid>
Type
<Sampling>
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<MethodPropertiesEdited>
Invoked when the properties of the optimization method have changed. (Inherited from DesignExplorer)
Type
Remarks
None.
ACT XML Tags
Examples
None.
Details
CallbackType
Mandatory
False
Name
MethodPropertiesEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
<Sampling>
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.
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.
<Sampling>
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.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnCreate>
Invoked to provide an instance of IOptimizationMethod (or ISamplingMethod). (Inherited from DesignEx-
plorer)
Type
Remarks
None.
Examples
None.
<Sampling>
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.
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.
<Sampling>
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.
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.
<Sampling>
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.
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.
<Sampling>
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnRelease>
Invoked to release the IOptimizationMethod (or the ISamplingMethod) instance. (Inherited from De-
signExplorer)
Type
Remarks
None.
Examples
None.
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.
<Sampling>
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.
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.
<Sampling>
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.
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
Examples
None.
<Sampling>
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<QuickHelp>
Returns 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
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Status>
Returns a user-readable string describing the status of the optimization (or the sampling) resolution.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Status
Public
True
Obsolete
False
ObsoleteMessage
None.
<Sampling>
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.
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.
<Sampling>
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
ACT XML Tags
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
<Sampling>
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.
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
maximumnumberofdoublelistparameters=
Indicates the maximum number of double list parameters supported. (Inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
<Sampling>
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
ACT XML Tags
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
<Sampling>
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.
ACT XML Tags
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.
<Sampling>
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.
ACT XML Tags
TypeId
<script>
Specifies the IronPython script referenced by the extension.
Remarks
None.
Examples
None.
Attribute compiled= (p. 666) Set if the script will be compiled in binary file
or not.
Attribute src= (p. 667) Name of the python script file.
compiled=
Set if the script will be compiled in binary file or not.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
compiled
DefaultValue
False
DataDefinition
False
AllowedValues
None.
<script>
MultipleValue
False
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
Name
src
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
<separator>
Remarks
None.
Examples
None.
<simdata>
Defines a general section that stores all user object definitions.
Remarks
None.
Examples
None.
Tag <Object> (p. 668) Defines an object.

Attribute context= (p. 669) Context or combination of contexts (separated
using '|').
<Object>
Defines an object.
Type
Ansys_ACT_Core_XmlDataModel_Object (p. 287)
Remarks
None.
<simdata>
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
Examples
None.
Details
Mandatory
True
Name
context
DefaultValue
None.
DataDefinition
False
ACT XML Tags
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
<Solver>
Specifies a third-party solver to be used in the simulation.
Remarks
None.
Examples
None.
from SimEntity)
Callback <GetFiles> (p. 676) Returns a list of file strings used by a custom
solver.
Callback <GetReader> (p. 677) Called to get the reader class name and some
options.
Callback <GetSteps> (p. 678) Called to know the list of time steps (or
frequencies) computed during the solve and
available for the post-processing.
Callback <IsAnalysisValid> (p. 679) Called to know if the analysis is valid.
<Solver>
from SimEntity)
from SimEntity)
Callback <OnBeforeSolve> (p. 682) Called before the solve process.
Callback <OnCheckResults> (p. 684) Called before any post processing evalutation.
SimEntity)
from SimEntity)
from SimEntity)
SimEntity)
from SimEntity)
SimEntity)
SimEntity)
Callback <OnSolve> (p. 694) Called to run the solve process.
from SimEntity)
from SimEntity)
Callback <OnWriteInputFile> (p. 697) Called to write the solver input file.
from SimEntity)
Attribute analysis= (p. 699) Analysis type.
ACT XML Tags
Attribute physics= (p. 704) Physics type.

Attribute toolbox= (p. 705) Toolbox name.
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
SimEntity)
Type
Remarks
<Solver>
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
Public
True
ACT XML Tags
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
Obsolete
False
<Solver>
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
ObsoleteMessage
None.
ACT XML Tags
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetFiles>
Returns 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.
ChildType
None.
<Solver>
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<GetReader>
Called to get the reader class name and some 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.
MinOccurence
0
ACT XML Tags
MaxOccurence
-1
RealParent
TypeId
<GetSteps>
Called to know the list of time steps (or frequencies) computed during the solve and 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
MaxOccurence
-1
<Solver>
RealParent
TypeId
<IsAnalysisValid>
Called to know if 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
RealParent
ACT XML Tags
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
TypeId
<Solver>
<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
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
<OnBeforeSolve>
Called before the solve process.
Type
<Solver>
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
Remarks
None.
ACT XML Tags
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnCheckResults>
Called before any post processing evalutation.
Type
Remarks
None.
Examples
None.
<Solver>
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.
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.
<Solver>
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.
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.
<Solver>
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.
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.
<Solver>
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.
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.
<Solver>
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.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSolve>
Called to run the solve process.
Type
Remarks
None.
Examples
None.
<Solver>
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.
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.
<Solver>
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnWriteInputFile>
Called 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.
ACT XML Tags
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
Examples
None.
<Solver>
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
analysis=
Analysis type.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
analysis
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
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.
<Solver>
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.
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
icon=
<Solver>
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
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
physics=
Physics type.
Type
System_String
Remarks
None.
<Solver>
Examples
None.
Details
Mandatory
True
Name
physics
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
toolbox=
Toolbox name.
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
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
<Step>
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Step>
Defines a step in a wizard or AIM custom template.
Remarks
None.
Examples
None.
from SimEntity)
ACT XML Tags
Tag <ComponentData> (p. 713) Defines the data of the components in the step's
layout.
Tag <ComponentStyle> (p. 714) Defines the styles of the components in the step's
layout.
Tag <Description> (p. 714) Gets or sets the description of the step.
from SimEntity)
from SimEntity)
SimEntity)
from SimEntity)
from SimEntity)
SimEntity)
from SimEntity)
Callback <onrefresh> (p. 725) Called when the step is initialized.
SimEntity)
Callback <onreset> (p. 727) Called when we go to the previous step.
SimEntity)
from SimEntity)
from SimEntity)
Callback <onupdate> (p. 731) Called when the step is finalized.
from SimEntity)
Attribute Context= (p. 735) Gets or sets the context name.
<Step>
Attribute Enabled= (p. 736) Gets or sets the enabled flag. This flag is true by
default.
Attribute helpFile= (p. 737) The file containing help html content.
Attribute Layout= (p. 739) 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>
SimEntity)
ACT XML Tags
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
<Step>
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
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
<Step>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<ComponentData>
Defines the data of the components in the step's layout.
Type
Ansys_ACT_Core_XmlDataModel_ComponentData (p. 50)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
ACT XML Tags
Mandatory
False
TypeId
<ComponentStyle>
Defines the styles of the components in the step's layout.
Type
Ansys_ACT_Core_XmlDataModel_ComponentStyle (p. 57)
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.
<Step>
Examples
<step | wizard>
</step | wizard>
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
ACT XML Tags
ObsoleteMessage
None.
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.
<Step>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
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
<Step>
MaxOccurence
-1
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
ACT XML Tags
RealParent
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
<Step>
TypeId
<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
ACT XML Tags
<OnHide>
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>
<Step>
Type
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
ACT XML Tags
Remarks
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.
<Step>
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onrefresh>
Called when the step is initialized.
Type
Remarks
None.
Examples
None.
ACT XML Tags
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.
<Step>
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onreset>
Called when we go to the previous step.
Type
Remarks
None.
Examples
None.
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.
<Step>
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.
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.
<Step>
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onupdate>
Called when the step is finalized.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Mandatory
False
Name
onupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
Examples
None.
<Step>
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.
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.
<Step>
Public
True
Description
None.
TypeId
Context=
Gets or sets the context name.
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
Context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
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
Enabled=
Gets or sets the enabled flag. This flag is true by default.
<Step>
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
Enabled
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
helpFile=
The file containing help html content.
Type
System_String
ACT XML Tags
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.
<Step>
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.
ACT XML Tags
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
<Step>
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.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Target>
Remarks
None.
Examples
None.
Attribute location= (p. 742) Sub-type when type==Analysis.

Attribute name= (p. 743) Name of the parent. This is the name of an object defined in the
extension xml file. Used only if type==UserObject.
Attribute type= (p. 744) Type of the target location.
location=
Sub-type when type==Analysis.
Type
Ansys_ACT_Interfaces_UserObject_ObjectLocationEnum
Remarks
None.
<Target>
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. This is the name of an object defined in the extension xml file. Used only if
type==UserObject.
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
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
<task>
Name
type
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<task>
Defines a task that encapsulate a single process or application.
Remarks
None.
Examples
None.
from SimEntity)
ACT XML Tags
Tag <ContextMenus> (p. 751) The user-defined custom context menu entries.
Tag <Inputs> (p. 752) The user-defined task input connections.
from SimEntity)
from SimEntity)
SimEntity)
Callback <ondelete> (p. 757) Callback for task deletion.
from SimEntity)
Callback <onedit> (p. 759) Callback for task EDIT entry.
from SimEntity)
SimEntity)
from SimEntity)
Callback <oninitialize> (p. 763) Callback for task creation.
Callback <onrefresh> (p. 766) Callback for task refresh.
SimEntity)
Callback <onreport> (p. 768) Callback for task reporting.
Callback <onreset> (p. 769) Callback for task reset.
SimEntity)
Callback <onstatus> (p. 771) Callback for task status.
from SimEntity)
from SimEntity)
Callback <onupdate> (p. 774) Callback for task update.
Tag <Outputs> (p. 775) The user-defined task output connections.
Tag <Parameters> (p. 776) The user-defined parameters to be exposed on
the task.
<task>
from SimEntity)
Tag <RsmJob> (p. 777) List of task-level RSM jobs.
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
ACT XML Tags
<Callbacks>
SimEntity)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
<task>
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.
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.
<task>
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
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. 60)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_ContextMenus
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Inputs>
The user-defined task input connections.
Type
Ansys_ACT_Core_XmlDataModel_Inputs (p. 215)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Inputs
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<task>
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
TypeId
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
<task>
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
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.
<task>
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<ondelete>
Callback for task deletion.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
ActionCallback_DataContainerReference__IFullContext_
Mandatory
False
Name
ondelete
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
<task>
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onedit>
Callback for task EDIT entry.
Type
Remarks
None.
Examples
None.
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.
<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.
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.
<task>
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<oninitialize>
Callback for task creation.
Type
Remarks
None.
Examples
None.
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.
<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.
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 for task refresh.
Type
Remarks
None.
Examples
None.
<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.
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 for task reporting.
Type
Remarks
None.
Examples
None.
<task>
Details
CallbackType
ActionCallback_DataContainerReference__IFullContext__object_
Mandatory
False
Name
onreport
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onreset>
Callback for task reset.
Type
Remarks
None.
Examples
None.
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.
<task>
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<onstatus>
Callback for task status.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
FuncCallback_DataContainerReference__IQueryContext__object_
Mandatory
False
Name
onstatus
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
<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.
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 for task update.
Type
Remarks
None.
Examples
None.
<task>
Details
CallbackType
Mandatory
False
Name
onupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Outputs>
The user-defined task output connections.
Type
Ansys_ACT_Core_XmlDataModel_Outputs (p. 395)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Outputs
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Parameters>
The user-defined parameters to be exposed on the task.
Type
Ansys_ACT_Core_XmlDataModel_Parameters (p. 431)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Parameters
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<task>
TypeId
<Property>
Type
Remarks
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. 590)
Remarks
None.
ACT XML Tags
Examples
None.
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
<task>
AllowedValues
None.
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
ACT XML Tags
MappedValues
None.
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
<task>
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.
Public
True
Description
None.
TypeId
ACT XML Tags
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.
TypeId
version=
<taskgroup>
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
<taskgroup>
Defines a collection of tasks.
Remarks
None.
ACT XML Tags
Examples
None.
Tag <Attributes> (p. 785) Defines the set of attributes for the task group.
from SimEntity)
Tag <IncludeGroup> (p. 789) Task group's list of nested task groups.
Tag <IncludeTask> (p. 790) Task group's list of tasks.
from SimEntity)
from SimEntity)
SimEntity)
from SimEntity)
from SimEntity)
SimEntity)
from SimEntity)
SimEntity)
SimEntity)
<taskgroup>
from SimEntity)
from SimEntity)
from SimEntity)
Attribute abbreviation= (p. 806) Task group abbreviation used for directory and
naming purposes.
Attribute category= (p. 808) Category to which the task group applies.
Attribute isparametricgroup= (p. 811) Indicates whether the taskgroup operates only on
parameters.
<Attributes>
Defines the set of attributes for the task group. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
ACT XML Tags
Mandatory
False
TypeId
<Callbacks>
SimEntity)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
<taskgroup>
Remarks
None.
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.
ACT XML Tags
Examples
None.
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.
<taskgroup>
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<IncludeGroup>
Task group's list of nested task groups.
Type
Ansys_ACT_Core_XmlDataModel_IncludeGroup (p. 204)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_IncludeGroup
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<IncludeTask>
Task group's list of tasks.
Type
Ansys_ACT_Core_XmlDataModel_IncludeTask (p. 207)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_IncludeTask
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<taskgroup>
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
TypeId
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
<taskgroup>
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
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.
<taskgroup>
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.
Examples
None.
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.
<taskgroup>
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.
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.
<taskgroup>
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.
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.
<taskgroup>
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.
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.
<taskgroup>
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.
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.
<taskgroup>
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<Property>
Type
Remarks
Examples
None.
ACT XML Tags
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.
<taskgroup>
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.
ACT XML Tags
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.
<taskgroup>
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
ACT XML Tags
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=
<taskgroup>
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
ACT XML Tags
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.
<taskgroup>
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.
ACT XML Tags
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<taskgroups>
Defines a collection of task groups.
Remarks
None.
Examples
None.
Tag <TaskGroup> (p. 814) Defines a collection of

tasks.
<TaskGroup>
Defines a collection of tasks.
<tasks>
Type
Ansys_ACT_Core_XmlDataModel_TaskGroup (p. 783)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_TaskGroup
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<tasks>
Defines the tasks collection.
Remarks
One or more custom tasks can be defined in the <tasks> node.
Examples
None.
Tag <Task> (p. 815) Defines a task that encapsulates a single process or
application.
<Task>
Defines a task that encapsulates a single process or application.
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Task (p. 745)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Task
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Templates>
Defines a collection of control templates.
Remarks
None.
Examples
None.
Tag <ControlTemplate> (p. 816) Defines a control template for the creation of groups of
properties.
<ControlTemplate>
Defines a control template for the creation of groups of properties.
<toolbar>
Type
Ansys_ACT_Core_XmlDataModel_ControlTemplate (p. 61)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<toolbar>
Defines a toolbar.
Remarks
None.
Examples
None.
Tag <Separator> (p. 818) Defines the separator for items in a

toolbar.
Attribute caption= (p. 818) Caption of the toolbar.
Attribute name= (p. 819) Name of the toolbar.
ACT XML Tags
<Separator>
Type
Ansys_ACT_Core_XmlDataModel_Separator (p. 668)
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
Caption of the toolbar.
Examples
None.
<toolbar>
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the toolbar.
Type
System_String
Remarks
Specifies the name used by the application to reference this toolbar.
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
<UIDefinition>
Remarks
None.
Examples
None.
Tag <ComponentDefinition> (p. 820) Defines the display of the component.

Tag <Layout> (p. 821) Defines the layout used to display the
extension.
Defines the display of the component.
Type
Ansys_ACT_Core_XmlDataModel_UI_ComponentDefinition (p. 52)
<UIDefinition>
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Layout>
Defines the layout used to display the extension.
Type
Ansys_ACT_Core_XmlDataModel_UI_Layout (p. 245)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
ACT XML Tags
RealParent
None.
Mandatory
False
TypeId
<Wizard>
Defines a wizard within the extension.
Remarks
None.
Examples
None.
Tag <Callbacks> (p. 822) Specifies the callbacks that will invoke functions from the IronPython
extension script.
Callback <canstart> (p. 823) Called to know if the wizard can be started.
Tag <Description> (p. 824) Defines the description for the wizard.
Tag <Step> (p. 825) Defines a step in a wizard or AIM custom template.
Attribute caption= (p. 825) Caption of the wizard.
Attribute context= (p. 826) Context or combination of contexts (separated using '|').
Attribute icon= (p. 827) Icon of the wizard.
Attribute layout= (p. 828) Layout to use to display the wizard.
Attribute name= (p. 829) Name of the wizard.
Attribute version= (p. 830) Major version of the wizard.
<Callbacks>
Type
Remarks
<Wizard>
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<canstart>
Called to know if the wizard can be started.
Type
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_string__bool_
Name
canstart
Public
True
Obsolete
False
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Description>
Defines the description for the wizard.
Type
System_String
Remarks
None.
Examples
<step | wizard>
</step | wizard>
Details
Description
Description of the wizard.
ValueName
description
Name
Description
Public
True
TypeId
<Wizard>
<Step>
Defines a step in a wizard or AIM custom template.
Type
Ansys_ACT_Core_XmlDataModel_Step (p. 707)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Step
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Caption of the wizard.
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
context=
Context or combination of contexts (separated using '|').
Type
Remarks
Examples
None.
Details
Mandatory
True
<Wizard>
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Icon of the wizard.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
layout=
Layout to use to display the wizard.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
layout
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<Wizard>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the wizard.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
version=
Major version of the wizard.
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.
<Workflow>
TypeId
<Workflow>
Defines custom workflows composed of tasks and task groups.
Remarks
Defines the top-level workflow tag within an ACT APP. Used to define process integration items (tasks
and task groups).
Examples
Defines the top-level workflow tag within an extension. Used to define process integration items (tasks
and task groups).
Tag <Attributes> (p. 832) Defines the set of attributes for the workflow.
from SimEntity)
from SimEntity)
from SimEntity)
SimEntity)
from SimEntity)
from SimEntity)
SimEntity)
from SimEntity)
ACT XML Tags
SimEntity)
SimEntity)
from SimEntity)
from SimEntity)
from SimEntity)
Tag <TaskGroups> (p. 852) Task groupings to be exposed as organized blocks
within the workflow.
Tag <Tasks> (p. 853) Tasks exposed by this workflow.
Attribute context= (p. 855) Context (application) to which this workflow
applies.
<Attributes>
Defines the set of attributes for the workflow. (Inherited from SimEntity)
Type
Remarks
None.
Examples
None.
<Workflow>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
SimEntity)
Type
Remarks
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Workflow>
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanRemove>
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<IsValid>
Type
<Workflow>
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAdd>
Type
Remarks
ACT XML Tags
Examples
None.
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.
<Workflow>
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
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.
<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.
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.
<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.
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.
<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.
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.
<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.
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.
<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.
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.
<Workflow>
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Property>
Type
Remarks
Examples
None.
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. 814)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_TaskGroups
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<Workflow>
TypeId
<Tasks>
Tasks exposed by this workflow.
Type
Ansys_ACT_Core_XmlDataModel_Tasks (p. 815)
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.
ACT XML Tags
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
<Workflow>
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
context=
Context (application) to which this workflow applies.
Type
Remarks
Examples
None.
Details
Mandatory
True
Name
context
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
<Workflow>
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.
ACT XML Tags
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.
<Workflow>
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

ACT XML Reference Guide

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

ACT XML Reference Guide

Caricato da

Copyright:

Formati disponibili

ANSYS ACT XML Reference Guide

ANSYS, Inc. Release 17.0

ANSYS, Inc. is certified to ISO 9001:2008.

U.S. Government Rights

Published in the U.S.A.

<Licenses> ............................................................................................................................. 132

<CanRemove> ........................................................................................................................ 178

<IsAnalysisValid> .................................................................................................................... 222

<OnMigrate> .......................................................................................................................... 271

IsLoad= .................................................................................................................................. 321

insideboundsconstraint= ........................................................................................................ 372

<OnReady> ............................................................................................................................ 418

keytype= ................................................................................................................................ 465

<Callbacks> ............................................................................................................................ 514

<OnClearData> ...................................................................................................................... 563

<OnSuppress> ....................................................................................................................... 613

maximumnumberofintegerlistparameters= ............................................................................. 663

<CanAdd> .............................................................................................................................. 710

<ondelete> ............................................................................................................................ 757

abbreviation= ......................................................................................................................... 806

<OnSuppress> ....................................................................................................................... 849

<ActionCallback> (p. 5) Defines the action callback.

<inputfile> (p. 213) Defines an input file.

Table 2: XML Tag Listing

Attribute caption= (p. 5) Caption for the action

Table 3: XML Tag Listing

Table 4: XML Tag Listing

Attribute name= (p. 17) Name of the

Table 5: XML Tag Listing

Table 6: XML Tag Listing

Attribute location= (p. 24) Location of

Table 7: XML Tag Listing

Attribute order= (p. 26) Call order.

Table 8: XML Tag Listing

Attribute name= (p. 28) Name

Table 9: XML Tag Listing

Table 10: XML Tag Listing

Attribute MaxWidth= (p. 42) Maximum width for the component.

Table 11: XML Tag Listing

Attribute component= (p. 51) Component for which data is being

Table 12: XML Tag Listing

Attribute Class= (p. 52) Class to control the component

Table 13: XML Tag Listing

Table 14: XML Tag Listing

Table 15: XML Tag Listing

Table 16: XML Tag Listing

Table 17: XML Tag Listing

Table 18: XML Tag Listing

Attribute name= (p. 125) Name of the entry.

Table 19: XML Tag Listing

Table 20: XML Tag Listing

Table 21: XML Tag Listing

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

Table 22: XML Tag Listing

Table 23: XML Tag Listing

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

Table 24: XML Tag Listing

Table 25: XML Tag Listing

Table 26: XML Tag Listing

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

Table 27: XML Tag Listing

Attribute id= (p. 213) Unique file ID. (Inherited

Table 28: XML Tag Listing

Tag <Input> (p. 216) Defines an input-level data connection