xpxValidateInstanceType

FUNCTION xpxValidateInstanceType (modelId, entityId       : GENERIC;
                                  diagnosticFile          : STRING;
                                  options                 : INTEGER;
                                  VAR validationResultsId : GENERIC)
                                  status                  : INTEGER;

This function invokes the EDMmodelChecker to validate all instances of the specified instance type in the specified data model. Optionally also all instances in the same data model that is a subtype instance of the specified instance type will be validated. The result of the validation can be a text report, a population of the Express schema EDM_Validation_Result_Schema or both. The latter case enables the caller to make his own diagnostic report in his own format. There exist two options that will influence the amount of information in the validation report produced by this function: NO_PRINT_OUTPUT and FULL_OUTPUT A standard validation report will be produced when none of these options are set in the <options> argument. A validation report with all available detailed information is produced when the FULL_OUTPUT option is set. No validation report will be produced when the NO_PRINT_OUTPUT option is enabled. The validation result would then normally be in a population of the EDM_Validation_Result_Schema. When validating an instance against rules specified in an EDMruleSchema, only he following validation options are effective: FULL_VALIDATION, GLOBAL_RULES, LOCAL_RULES, and UNIQUENESS_RULES. FULL_VALIDATION means in this context: GLOBAL_RULES | LOCAL_RULES | UNIQUENESS_RULES . This function is only applicable to application instances. The data model that holds the instance to validate must be open before this operation can be successfully performed.
The expressions logging can be used to log (trace) the execution of the validation process in the EDMexpressVM. The EDMsupervisor and the interactive EDMdebugger can be used for testing and debugging the rules as well as getting detailed information of a validation process.

Arguments

Type	Name	Comment
GENERIC	modelId	The modelID that uniquely identifies the model to be validated.
GENERIC	entityId	A numeric entityID that uniquely identifies an entity definition (instance type) in a dictionary model in the EDMdatabase . This entity definition must be defined in the underlying schema of the actual model specified by the <dataModelId> argument. All instances of the type defined by this entity definition and optionally all instances that is a subtype of this particular instance type, located in the same data model, will be validated.
STRING	diagnosticFile	Specifies the file name for diagnostic information generated by this function. If no file name is supplied, i.e. the <diagnosticFile> argument is set to NULL, all diagnostic information will be written to the EDMinterface current output device.
INTEGER	options	Specifies the enabled options used by the EDMmodelChecker in the current invocation. The <options> value is specified as a bitwise OR between the enabled options.
GENERIC	validationResultsId	The address of a variable of type SdaiInstance that will receive a numeric instanceID that uniquely identifies an instance of type validation_error in a population of the EDM_Validation_Result_Schema that contains all details of the violations detected in the last invocation of the EDMmodelChecker. No population of the EDM_Validation_Result_Schema will be produced when the <validationErrorId> argument is NULL on input.

Return Value

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_XPX_Return_Value'.

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.
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.
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.
XPXATTRIBUTE_DATA_TYPE	Specifies that all attribute values of the instance will be checked for legal data type.
XPXAGGREGATE_DATA_TYPE	Specifies that all element values in all aggregates owned by the specified instance will be checked for legal data type.
XPXAGGREGATE_SIZE	Specifies that the number of elements in all aggregates owned by the specified instance is according to the related aggregate declarations.
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.
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.
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

<Missing Example>

EDMsix

xpxValidateInstanceType

Arguments

Return Value

Options

Example

See also

Filter by label