...
| Code Block | ||||
|---|---|---|---|---|
| ||||
FUNCTION xpfValidateInstanceType (modelId : GENERIC;
entityId : GENERIC;
diagnosticFile : STRING;
options : INTEGER;
ruleSchemaId : GENERIC;
userOutputFile : STRING;
VAR validationResultsId : GENERIC)
result : INTEGER;
|
The xpfValidateInstanceType function validates that all instances of a specific type in a given model, do not violate any of the specified constraints/rules. When the XPXSUBTYPES is set in the options argument, all instances in the actual model that are subtypes of the specified type, will be validated as well.
<modelId>
Arguments
...
| Type | Name | Comment |
| GENERIC | modelId | The modelID that uniquely identifies the model to be validated. |
| GENERIC | entityId |
...
| The instanceID of the entity_definition that defines the actual instance type |
...
| STRING | diagnosticFile | Path to the diagnostic file |
| INTEGER | options | see below |
| GENERIC | ruleSchemaId | The unique id of the rule schema within the EDMdatabase |
| STRING | userOutputFile | Path tot he output file |
| GENERIC | validationResultsId |
Return Value
...
| Type | Name | Comment |
| INTEGER | result | comments |
Options
...
| Option | Comment |
|---|---|
XPXSUBTYPES | Specifies that in addition to all the instances of the type specified by the < entityId> argument, all instances in the actual data model that are a subtype of the <entityId> instance type will be validated as well. |
XPXFULL_VALIDATION | Specifies that the actual instances will be validated against all rules and constrains that is applicable for this particular instance types. When the argument <ruleSchemaId> is specified unequal to zero, this options means the following options: |
XPXGLOBAL_RULES | Specifies that all global rules appropriate for the specified instance types will be validated. These global rules are defined in the appropriate dictionary model (Express schema) or defined in the specified EDMruleSchema. |
XPXLOCAL_RULES | Specifies that all local rules (Where rules) appropriate for the specified instance types will be validated. These local rules are defined in the appropriate dictionary model (Express schema) or defined in the specified EDMruleSchema. |
XPXINVERSE_RULES | Specifies that all Inverse constraints defined for the actual instance types will be validated. This option is not applicable when the argument <ruleSchemaId> is set unequal zero. |
XPXUNIQUENESS_RULES | Specifies that all Uniqueness rules defined for the actual instance will be validated. |
XPXREQUIRED_ATTRIBUTES | Specifies that all mandatory attributes, i.e., all explicit attributes that are not declared to be OPTIONAL, of the instance will be checked for an assigned value, i.e., checked that the attribute values are set. This option is not applicable when the argument <ruleSchemaId> is set unequal zero. |
XPXATTRIBUTE_DATA_TYPE | Specifies that all attribute values of the instance will be checked for legal data type. This option is not applicable when the argument <ruleSchemaId> is set unequal zero. |
XPXAGGREGATE_DATA_TYPE | Specifies that all element values in all aggregates owned by the specified instance will be checked for legal data type. This option is not applicable when the argument <ruleSchemaId> is set unequal zero. |
XPXAGGREGATE_SIZE | Specifies that the number of elements in all aggregates owned by the specified instance is according to the related aggregate declarations. This option is not applicable when the argument <ruleSchemaId> is set unequal zero. |
XPXARRAY_REQUIRED_ELEMENTS | Specifies that all elements in arrays, that are not declared as OPTIONAL, owned by the instance, will be checked for an assigned value, i.e., checked that no unset elements exists. This option is not applicable when the argument <ruleSchemaId> is set unequal zero.. |
XPXAGGREGATE_UNIQUENESS | Specifies that all aggregates owned by the specified instance will be validated for uniqueness violation. Aggregates that have an uniqueness constraint are all SET aggregates, and ARRAY and LIST aggregates that are declared with the optional keyword UNIQUE. |
XPXUNSET_DERIVE_ATTRIBUTES | Specifies that warnings will be issued if unset derived attributes are found. This option is not applicable when the argument <ruleSchemaId> is set unequal zero. |
XPXOUTPUT_STEPID | Specifies that the stepID corresponding to the instanceID will be written to the validation report when the actual correspondence exists in a STEP Identifier model. |
XPXFULL_OUTPUT | Specifies that all available information about the source of the errors will be recorded in the diagnostic report from this command. |
XPXSTOP_ON_FIRST_ERROR | Specifies that the validation process should terminate when the first error is detected. |
Example
...
| Code Block | ||
|---|---|---|
| ||
<Missing Example> |
See also
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|