All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFastenerUseItf Interface CATIFmaCheckRule

Usage: you can reimplement this interface by deriving the supplied CATAFmaCheckRule adapter class.

interface CATIFmaCheckRule

Interface to run the Customer-defined check rule.

Role: User has to create the Component CAAFmaXXXRule where XXX is the name of the rule and implement the interface on the component.

Default implementation is provided by adapter.

BOA information: this interface CAN NOT be implemented using the BOA (Basic Object Adapter).

Method Index

o RunRule(CATUnicodeString*,CATBoolean*,CATOmbObjectInContext*,CATOmbObjectInContext*): Runs this custom check rule.
o SetParameters(CATListOfCATUnicodeString&,CATLISTP(CATBaseUnknown)&): Stores the parameters values of a custom rule.

Methods

o RunRule

public virtual RunRule(		`opMessage`,
		`opKOStatus`,
		`ipCurrentFastener`,
		`ipComparisonFastener`)

Runs this custom check rule.
Role: This method calls the different methods to compute the result of a custom rule and return its status and diagnosis message.

Parameters:

opMessage: [out] The message to be displayed if the rule is KO.
opKOStatus: [out] The rule status (True for KO).
ipCurrentFastener: [in] The current fastener to be checked.
ipComparisonFastener: [in] Another fastener of the product structure when the rule is binary, NULL otherwise.

Returns:

Legal values:

S_OK: if the rule was successfully run.
E_FAIL: a failure has been encountered while processing the rule.

o SetParameters

public virtual SetParameters(		`iListOfRuleParamID`,
		`iListOfRuleParamValue`)

Stores the parameters values of a custom rule.
Role: This method store the parameters values of a custom rule read from the standard files. The parameters can be retrieved on the client implementation using the CATAFmaCheckRule::GetParameters method. This method must not be overloaded by the customer implementation.

Parameters:

opListOfRuleParamID: [out] The list of parameters ID.

Returns:

Legal values:

S_OK: if the list of parameters was successfully retrieved.
E_FAIL: a failure has been encountered while retrieving the list of parameters.

This object is included in the file: CATIFmaCheckRule.h
If needed, your Imakefile.mk should include the module: CATPLMFmaBrowseInterfaces