xpxValidateModelBN




FUNCTION xpxValidateModelBN (repositoryId              : GENERIC;
                             modelName, diagnosticFile : STRING;
                             options                   : INTEGER;
                             VAR validationResultsId   : GENERIC) 
                             status                    : INTEGER; 

The xpxValidateModelBN function validates a model, i.e. checks that the attribute values of all instances in the model do not violate any of the constraints/rules defined in their corresponding entity definitions.

Arguments


TypeNameComment
GENERICrepositoryIdA numeric ID that uniquely identifies the repository in the EDMdatabase to validate.
STRINGmodelNameThe name the identifies a model within the EDMdatabase
STRINGdiagnosticFileSpecifies 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
INTEGERoptionsSpecifies the enabled options used by the EDMmodelChecker in the current invocation. The <options> value is specified as a bitwise OR between the enabled options
GENERICresultModelIdThe 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 <resultModelId> 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


OptionComment

XPXFULL_VALIDATION

Specifies that the actual instance will be validated against all rules and constrains that is applicable for this particular instance. 

XPXGLOBAL_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.

XPXLOCAL_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.

XPXINVERSE_RULES

Specifies that all Inverse constraints defined for the actual instance 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 constraints 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>

 

See also

Filter by label

There are no items with the selected labels at this time.

Â