xpxValidateInstancesWithParameters

Owned by Former user (Deleted)
Last updated: Jan 23, 2018
5 min read


FUNCTION xpxValidateInstancesWithParameters(instances                  : GENERIC;
                                            diagnosticFile             : STRING;
                                            options                    : INTEGER;
                                            ruleSchemaId               : GENERIC;
                                            userOutputFile             : STRING;
                                            VAR validationResultId     : GENERIC;
                                            VAR returnValue            : GENERIC;
                                            numberOfParameters         : INTEGER;
                                            argument1, ... , argumentN : GENERIC)
                                            status                     : INTEGER;

Use this function to ....

Arguments

1TypeNameComment
2GENERICinstancesThe instanceID of the model that shall be validated
3STRINGdiagnosticFileSpecifies 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.
4INTEGERoptionsSpecifies the enabled options used by the EDMmodelChecker in the current invocation. The <options> value is specified as a bitwise OR between the enabled options.
5GENERICruleSchemaIdA numeric ruleSchemaID that uniquely identifies the rule schema instance in the EDMdatabase.  The ruleSchemaID can be retrieved by the xpxGetRuleSchema operation.
6STRINGuserOutputFileSpecifies the name of a file that will be used to receive the result of executing the xpxPrintf and xpxOutputValue function in the actual global rule. 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 of the xpxPrintf and xpxOutputValue function in the actual global rule 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.
7GENERICvalidationResultId

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 INDETERMINATE.
8GENERICreturnValueThe actual validation process values will be places here
9INTEGERnumberOfParametersSpecifies 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:
10GENERICargument(n)Actual parameter value.

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

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>

 

See also

Filter by label

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

Â