CATPLMFastenerUseItf CATAFmaCheckRule
Usage: you can derive this class.
public class CATAFmaCheckRule
Constructor and Destructor Index
- o
CATAFmaCheckRule()
-
- o
~CATAFmaCheckRule()
-
Method Index
- o
GetParameters(CATListOfCATUnicodeString**,CATLISTP(CATBaseUnknown)**)
- Get the rules parameters.
- o
RunRule(CATUnicodeString*,CATBoolean*,CATOmbObjectInContext*,CATOmbObjectInContext*)
- Run this custom check rule.
- o
SetParameters(CATListOfCATUnicodeString&,CATLISTP(CATBaseUnknown)&)
- Set the rules parameters.
Constructor and Destructor
o CATAFmaCheckRule
| public CATAFmaCheckRule( | ) |
-
o ~CATAFmaCheckRule
| public virtual ~CATAFmaCheckRule( | ) |
-
Methods
o GetParameters
| public GetParameters( | | oppListOfRuleParamID, |
| | oppListOfRuleParamValue) |
-
Get the rules parameters.
Role: This method returns the stored rules parameters.
- Parameters:
-
- oppListOfRuleParamID
- [out] List of parameters IDs
- oppListOfRuleParamValue
- [out] List of parameters values
- Returns:
-
Legal values:
- S_OK
o RunRule
| public virtual RunRule( | | opMessage, |
| | opKOStatus, |
| | ipCurrentFastener, |
| | ipComparisonFastener) |
-
Run 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 SetParameters( | | iListOfRuleParamID, |
| | iListOfRuleParamValue) |
-
Set the rules parameters.
Role: This method stores the rules parameters.
- Parameters:
-
- iListOfRuleParamID
- [in] List of parameters IDs
- iListOfRuleParamValue
- [in] List of parameters values
- Returns:
-
Legal values:
- S_OK
This object is included in the file: CATAFmaCheckRule.h
If needed, your Imakefile.mk should include the module: CATPLMFmaBrowseInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.