AdvisorAction
Type describing the actions created by when clicking Actions in Engineering Rules Capture.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection AdvisorAction
AdvisorCheck
Type describing the checks created when clicking Check in the Engineering Rules Capture app.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection AdvisorRootRelation AdvisorRelation AdvisorCheck
Attributes
| Name | Type | Comment |
|---|---|---|
Result | Boolean | Describes the result of the check in the form of parameters (that can be used in a formula). |
Severity | Integer | Describes the type of the check (silent, warning, or information.) |
Warning | String | Describes the message that will be displayed when the check is launched. |
AdvisorConnection
Type describing an object that references other objects. This type cannot be instantiated.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection
Attributes
| Name | Type | Comment |
|---|---|---|
Parameters | List | Describes the list of parameters used by the relation. |
AdvisorEquivalentDimensions
Type describing the checks created when clicking Equivalent
Dimensions 
in the Engineering Rules Capture.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection AdvisorRootRelation AdvisorEquivalentDimensions
Attributes
| Name | Type | Comment |
|---|---|---|
Value | Real | Describes the value that can be applied to the selected parameters. |
AdvisorFeature
Type describing all Engineering Rules Capture features: Parameters, formulas and relations.
Inheritance Path
ObjectType Feature AdvisorFeature
AdvisorFormula
Type describing the formulas created when clicking the Formula 
.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection AdvisorRootRelation AdvisorRelation AdvisorFormula
AdvisorLaw
Type describing the law created when clicking Law in Engineering Rules Capture.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection AdvisorLaw
AdvisorMacrosSet
Type describing the macros with arguments created when clicking the Macro
with arguments icon 
in the Knowledge
Advisor app.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorMacrosSet
AdvisorParameterSet
Type describing the sets of parameters created by clicking Add Set of Parameters in the Engineering Rules Capture app.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorParameterSet
AdvisorReaction
Type describing the reactions created when clicking the Reaction icon in the Engineering Rules Capture app.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection AdvisorRootRelation AdvisorReaction
Attributes
| Name | Type | Comment |
|---|---|---|
EventsToReact | List | Describes the events available in the Engineering Rules Capture app. |
ReactionAction | AdvisorFeature | Enables you to specify if you want to write the action in Visual Basic or in the knowledge language. |
ReactionType | Integer | Enables you to choose what type of reaction will be fired when one of the events occurs. |
SourceList | List | Enables you to select a source in the 3D area or in the tree. |
TypeSource | List | Corresponds to the Source Type in the Reaction dialog box. This field enables you to select Selection or Owner. In the first case, you can manually select one or more items in the tree or in the 3D area. In the second case, you link the action with a feature of the 3D or of the tree. |
AdvisorRelation
Type describing all relations.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection AdvisorRootRelation AdvisorRelation
Attributes
| Name | Type | Comment |
|---|---|---|
Body | String | Describes the body of the relation. Note that this attribute is an internal representation. |
AdvisorRelationSet
Type describing the sets of relations created when clicking Add Set of
Relations 
in the
Engineering Rules Capture app.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorRelationSet
AdvisorRootRelation
Type describing all Engineering Rules Capture relations.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection AdvisorRootRelation
Attributes
| Name | Type | Comment |
|---|---|---|
Activity | Boolean | Indicates if the relation is enabled (true) or not (false). |
AdvisorRule
Type describing the rules created when clicking Rule 
in the Engineering Rules Capture app.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection AdvisorRootRelation AdvisorRelation AdvisorRule
AdvisorSetOfEquations
Type describing the sets of equations created when clicking Set of Equations in Engineering Rules Capture.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection AdvisorRootRelation AdvisorRelation AdvisorSetOfEquations
Attributes
| Name | Type | Comment |
|---|---|---|
BlackBoxAttempts | Integer | This option is only used for sets of constraints with more than one variable. This option changes the number of start points used by the solver. For instance, for a 2-dimensional problem, the following number of calls will be performed:
|
BlackBoxCacheSize | Integer | Enables you to choose the size of internal black boxes caches. Decrease this value only if you do not have enough memory. Increase this value if you have enough memory to reduce the computation time. |
BlackBoxEpsilon | Real | - |
BlackBoxHeurictic1 | String | - |
BlackBoxHeuristicN | String | - |
BlackBoxMaxCallsNb | Integer | Enables you to limit the number of measures calculation (equivalent to a time limit.) |
BlackBoxUnimodal | Real | Enables you to use special information about the interval of unimodality. |
IsGaussEliminationUsed | Integer | - |
IsStopDialogDisplayed | Integer | Enables you to display a "Stop" dialog box that will enable you to interrupt the computation. |
MaxCalculationTime | Integer | Enables you to indicate the computation time. If the indicated time is equal to 0, the computation will last until a solution is found. |
Precision | Real | Enables you to define the precision of the results. |
DTLotusSheetType
Type describing the Lotus design tables.
Inheritance Path
ObjectType Feature AdvisorFeature DTSheetType DTLotusSheetType
DTModelSheetType
Type describing the sheet stored in the model. In this case, the results are stored in the model.
Inheritance Path
ObjectType Feature AdvisorFeature DTSheetType DTModelSheetType
DTSheetType
Type describing the Excel design tables.
Inheritance Path
ObjectType Feature AdvisorFeature DTSheetType
Attributes
| Name | Type | Comment |
|---|---|---|
ColumnsNb | Integer | Indicates the number of columns of the design table. |
CopyMode | Integer | If set to 1, the data are stored in the model and in the file. If set to 0, the data are stored in the file only. |
FilePath | String | - |
RowsNb | Integer | Indicates the number of rows. |
SheetCopy | String | When CopyMode is set to 1, describes the file content. |
SheetIndex | Integer | Indicates the sheet number in Excel. |
VerticalColumns | Integer | Indicates if the columns are vertical or horizontal in Excel. |
Methods
The following methods are associated with this type:
DTTextSheetType
Type describing the .txt design tables.
Inheritance Path
ObjectType Feature AdvisorFeature DTSheetType DTTextSheetType
DesignTableType
Type describing the design tables created when clicking the Design Table icon in the Engineering Rules Capture app.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection AdvisorRootRelation DesignTableType
Attributes
| Name | Type | Comment |
|---|---|---|
Associations | List | Describes the association of the names of the columns and the parameters driven by the design table. |
ConfigurationRow | Integer | Indicates the line number of the design table used to valuate parameters. |
HiddenColumns | List | Describes the hidden columns of the design table. |
Sheet | DTSheetType | Indicates the sheet number of the design table (Excel only). |
DocumentTemplate
Type describing the document templates created in the PKT app.
Inheritance Path
ObjectType Feature AdvisorFeature DocumentTemplate
InternalParameter
Inheritance Path
ObjectType Literal InternalParameter
KWANamedURL
Type describing the URL that you can add to a relation by clicking the Comment and URLs icon in the Engineering Rules Capture app.
Inheritance Path
ObjectType Feature KWANamedURL
KnowledgePattern
Type describing the patterns created when clicking Knowledge
Pattern 
.
Inheritance Path
ObjectType Feature AdvisorFeature AdvisorConnection AdvisorAction KnowledgePattern
ProductTableType
Type describe the product table.
Inheritance Path
ObjectType Feature AdvisorFeature ProductTableType
Attributes
| Name | Type | Comment |
|---|---|---|
ConfigurationRow | Integer | - |
Sheet | DTSheetType | - |
RelationArgument
Type describing the relation argument.
Inheritance Path
ObjectType Feature RelationArgument
VBScript
Type describing the scripts created when clicking the Visual Basic Action icon.
Inheritance Path
ObjectType Feature AdvisorFeature VBScript