xpfValidateInstanceTypeWithParametersBN

FUNCTION xpfValidateInstanceTypeWithParametersBN (modelId                    : GENERIC;
                                                  entityName                 : STRING;
                                                  diagnosticFile             : STRING;
                                                  options                    : INTEGER;
                                                  ruleSchemaName             : STRING;
                                                  userOutputFile             : STRING;
                                                  VAR validationResultId     : GENERIC;
                                                  VAR returnValue            : GENERIC;
                                                  numberOfParameters         : INTEGER;
                                                  argument1, ... , argumentN : GENERIC)
                                                  result                     : LOGICAL;

This function invokes the EDMmodelChecker to validate all instances of the specified instance type in the specified data model. 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. The result of the validation can be a text report, a population of the Express schema EDM_Validation_Result_Schema or both. A population of the EDM_Validation_Result_Schema 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: XPXNO_PRINT_OUTPUT and XPXFULL_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 XPXFULL_OUTPUT option is set. No validation report will be produced when the XPXNO_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: XPXFULL_VALIDATION, XPXGLOBAL_RULES, XPXLOCAL_RULES, XPXUNIQUENESS_RULES. XPXFULL_VALIDATION means in this context: XPXGLOBAL_RULES ~| XPXLOCAL_RULES ~| XPXUNIQUENESS_RULES . A number of arguments can be supplied to the ?instance type validation process? in the arguments argument1, ?, argumentN. Hence the validation process can be made parameterized. The validation process can return a value to the caller through the returnValue argument. The value to return must be set in the validation process by invoking the xpxReturnValueToCaller operation. 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.

See related functions: xpxGetNumberOfUserParameters, xpxGetUserParameter

Arguments

Type	Name	Comment
GENERIC	modelId	The modelID that uniquely identifies the model to be validated.
STRING	entityName	The name of the entity that defines the instance types to be validated.
STRING	diagnosticFile	Path to the diagnostic file
INTEGER	options	see below
STRING	ruleSchemaName	The name of the rule schema within the EDMdatabase
STRING	userOutputFile	Path tot he output file
GENERIC	validationResultsId
GENERIC	returnValue
INTEGER	numberOfParameters	Number of argument to be sent to the validation process
GENERIC	argument(1)	Arguments for the validation process

Return Value

Type	Name	Comment
LOGICAL	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: GLOBAL_RULES, LOCAL_RULES, UNIQUENESS_RULES
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. This option is not applicable when the argument <ruleSchemaId> is set unequal zero.
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

<Missing Example>

EDMsix

xpfValidateInstanceTypeWithParametersBN

Arguments

Return Value

Options

Example

See also

Filter by label