Page Comparison

...

Code Block

language	cpp
theme	Confluence

EdmiError edmiValidateModelWithParameters (SdaiModel         dataModelId, 
                                             SdaiString        diagnosticFile, 
                                             SdaiInteger       options, 
                                             SdaiRuleSchemaId  ruleSchemaId, 
                                             SdaiString        userOutputFile, 
                                             SdaiInstance      *validationErrorId, 
                                             SdaiPrimitiveType *returnValueDataType, 
                                             void              *returnValue, 
                                             SdaiInteger       numberOfParameters, 
                                              /* For each parameter: [SdaiPrimitiveType parameterDataType, parameterValue] */ 
                                              ... );

This function invokes the EDMmodelChecker to validate all instances in the specified data model against the rules and constraints specified in the <options> argument.

...

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: 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 data model against rules specified in an EDMruleSchema, only he following validation options are effective: FULL_VALIDATION, GLOBAL_RULES, LOCAL_RULES, UNIQUENESS_RULES. FULL_VALIDATION means in this context: GLOBAL_RULES | LOCAL_RULES | UNIQUENESS_RULES.

...

This

...

function is only applicable to data models.

...

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
SdaiModel	dataModelId	A numeric modelID that uniquely identifies the model in the EDMdatabase to validate.	The modelID is returned from the functions: sdaiCreateModel , sdaiCreateModelBN , sdaiOpenModelBN, edmiGetModel , edmiGetModelBN , sdaiGetInstanceModel
SdaiString	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. The EDMinterface current output device can be defined by the edmiDefineOutputFunction operation.	No diagnostics report will be produced by this function when the NO_PRINT_OUTPUT option is set.
SdaiInteger	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. All option names are defined in the header file sdai.h . See detailed descriptions of the available options below.
SdaiRuleSchemaId	ruleSchemaId	A numeric ruleSchemaID that uniquely identifies the rule schema instance in the EDMdatabase that defines the rules to be validated in this operation. The ruleSchemaID can be retrieved by the edmiGetRuleSchema operation.
SdaiString	userOutputFile	Specifies the name of a file that will be used to receive the result of executing the xpxPrintf and xpxOutputValue function during the validation operation. The specified file can be an existing file or the name of a file that will be created by the EDMmodelChecker. The default file extension is ".txt". The output from the xpxPrintf and xpxOutputValue function during the validation process will be written to the EDMinterface current output device when the <userOutputFile> is set to NULL. The EDMinterface current output device can be defined by the edmiDefineOutputFunction operation.
SdaiInstance	validationErrorId	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.
SdaiPrimitiveType	returnValueDataType	Address of a variable of type SdaiPrimitiveType that is used both as an input argument and an output argument: Input: specifies the expected datatype of the value returned in the <returnValue> argument. The returned value must be type compatible with the datatype specified in the <returnValueDataType> argument. Output: actual data type of the return value <returnValue>. When no value is returned the <returnValueDatatype> is set to sdaiINDETERMINATE.
void	returnValue	Address of variable that will receive the value from the actual validation process. The actual value must be specified by invoking the xpxReturnValueToCaller procedure in the validation process in the EDMexpressVM.
SdaiInteger	numberOfParameters	Specifies the number of parameters supplied in the actual invocation of the operation. For each parameter the following two arguments must be specified in this order:
SdaiPrimitiveType	parameterDataType	The datatype of the actual parameter value specified as a SdaiPrimitiveType value.
	parameterValue	Actual parameter value.

...

Return Value

...

Insert excerpt

	US:_r_EDMInterface
	US:_r_EDMInterface
nopanel	true

Options

...

data model are defined in the appropriate dictionary model (Express schema) or optionally defined in the EDMruleSchema specified in the <ruleSchemaName> argument.
<ruleSchemaName> NULL data model against all data model against all (Where rules) the specified data model will be validated against in the appropriate dictionary model (Express schema).
This option has no effect when the <ruleSchemaId> argument is specified unequal to the specified data model against all uniqueness rules defined in the appropriate dictionary model (Express schema) or defined in the specified EDMruleSchema Explicit is as OPTIONAL
has no effect argument specified to in specified data model
has no effect argument specified to in data model
has no effect argument specified to in data model are
has no effect argument specified to in the specified data model
has no effect argument specified to in data model constraint This option has no effect when the <ruleSchemaId> argument is specified unequal to

Option	Comment
FULL_VALIDATION	Specifies that the actual	instance will be validated against all rules and constrains that	is applicable for this particular instance. When the argument	<ruleSchemaId> is specified unequal to	zero, this options means the following options: GLOBAL_RULES	, LOCAL_RULES	, UNIQUENESS_RULES
GLOBAL_RULES	Specifies that all global rules appropriate for the specified	instance will be validated	. These global rules are defined in the appropriate dictionary model (Express schema) or defined in the specified EDMruleSchema.
LOCAL_RULES	Specifies that all local rules (Where rules) appropriate for the specified	instance will be validated	. These local rules	are defined in the appropriate dictionary model (Express schema) or defined in the specified EDMruleSchema.
INVERSE_RULES	Specifies that	all Inverse constraints defined	for the actual instance will be validated. This option is not applicable when the argument <ruleSchemaId> is set unequal zero.
UNIQUENESS_RULES	Specifies that	all Uniqueness rules defined for the actual instance will be validated	.
REQUIRED_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.
ATTRIBUTE_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.
AGGREGATE_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.
AGGREGATE_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.
ARRAY_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.
AGGREGATE_UNIQUENESS	Specifies that all aggregates	owned by the specified	instance will be validated for uniqueness violation. Aggregates that have an uniqueness	constraints 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.
UNSET_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.
OUTPUT_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.
FULL_OUTPUT	Specifies that all available information about the source of the errors will be recorded in the diagnostic report from this command.
STOP_ON_FIRST_ERROR	Specifies that the validation process should terminate when the first error is detected.

Returns:
A completion code of datatype EdmiError is the returned function value. The completion code has the following values:
Completion code = 0 : Operation successfully performed.
Completion code != 0: Error in operation. Completion code is an EDMinterface error code. Use edmiGetErrorText to get the error text corresponding to the error code.
EXAMPLE
EdmiError rstat;
SdaiModel dataModelId;
SdaiRuleSchema ruleSchemaId;
SdaiInstance validationErrorId;
SdaiAggr errorsId, warningsId;
SdaiInteger errors, warnings;
SdaiAppInstance returnedInstance;
. . .
if (rstat = edmiValidateModelWithParameters(
dataModelId,

Example

...

Code Block

language	cpp

 EdmiError rstat;
 SdaiModel dataModelId;
 SdaiRuleSchema ruleSchemaId;
 SdaiInstance validationErrorId;
 SdaiAggr errorsId, warningsId;
 SdaiInteger errors, warnings;
 SdaiAppInstance returnedInstance;
 . . .
 if (rstat = edmiValidateModelWithParameters(
 dataModelId, 
 "/usr/hkd/ifc/data/validation_result.text",

...

 
 FULL_VALIDATION | UNSET_DERIVE_ATTRIBUTES |

...

 
 FULL_OUTPUT,

...

0,

...


 "/usr/hkd/ifc/data/validation_print.text",

...

 
 &validationErrorId,

...

 
 sdaiINSTANCE,

...

 
 (void *) &returnedInstance,

...

2,

...

 
 sdaiSTRING, "NORWEGIAN_RULES",

...

 
 sdaiINTEGER, 9900487)) {

...

 
 /* Error in operation */

...

 
 printf("\nError: %s in edmiValidateModelWithParameters\n",

...

 
 edmiGetErrorText(rstat));

...

 
 goto error;

...

 
 }
 printf("\nReturned instance from edmiValidateModelWithParameters: %lu",

...


 returnedInstance);

...

 
 /* Test for errors and warnings during validation operation */

...


 sdaiGetAttrsBN(validationErrorId, 2, "Errors" , sdaiAGGR, &errorsId,

...


 "Warnings", sdaiAggr, &warningsId);

...

 
 if (errorsId) {

...


 errors = sdaiGetMemberCount(errorsId); /* errors = number of errors */

...

. .

...

 .  
 }
 if (waningsId) {

...


 warnings = sdaiGetMemberCount(waningsId); /* Get number of warnings */

...

. .

...

 .  
 }
 . . .

Versions Compared

Old Version 1

New Version 2

Key

Arguments

Return Value

Options

Example

See also