All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFastenerUseItf Interface CATIFmaRuleInit

Usage: you can freely reimplement this interface.

interface CATIFmaRuleInit

Interface to initialize 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.

No default implementation is provided by adapter.

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

Method Index

o GetCustoRuleLongName(CATUnicodeString*): Retrieves the custom rule long name.
o GetParametersID(CATListOfCATUnicodeString*): Retrieves the list of a custom rule parameters ID.
o GetRuleType(CATBoolean*): Retrieves the custom rule type Unitary / Binary.

Methods

o GetCustoRuleLongName

public virtual GetCustoRuleLongName( opRuleLongName)

Retrieves the custom rule long name.
Role: This method specifies the full name of the rule which will be displayed in Tools/Options section and in the label associated to a fastener when the rule is KO.

Parameters:

opRuleLongName: [out] The full name of the rule.

Returns:

Legal values:

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

o GetParametersID

public virtual GetParametersID( opListOfRuleParamID)

Retrieves the list of a custom rule parameters ID.
Role: This method specifies the parameters ID for a given custom rule. These parameters IDs have to be consistent with the one stored in the reference fastener type files.

Parameters:

opListOfRuleParamID: [out] The list of parameters ID. If the parameter defined in the Reference Fastener file is called Fma_RULES_CUSTO1_Distance, the value appended in the list opListOfRuleParamID should be CUSTO1_Distance.

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.

o GetRuleType

public virtual GetRuleType( opUnitaryRule)

Retrieves the custom rule type Unitary / Binary.
Role: This method specifies if the custom rule is unitary or not. Unitary rules are run sequentially on each fastener of the product structure while binary rules are run for each couple of fasteners of the product structure.

Parameters:

oUnitaryRule: [out] The type of the rule : unitary (True) or binary (False).

Returns:

Legal values:

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

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