All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFastenerUseItf Interface CATIFmaRulesParameters

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

interface CATIFmaRulesParameters

Interface to use customer defined parameters values in fastener design check process.

Role: User has to create the Component CAAFmaRulesParametersXXX 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 GetRuleParameterValue(CATICkeParm**,CATUnicodeString&,CATOmbObjectInContext*): Gets the customized rule parameter value.

Methods

o GetRuleParameterValue

public virtual GetRuleParameterValue(		`oppParm`,
	const	`iRuleParamID`,
	const	`ipFastener`)

Gets the customized rule parameter value.
Role: This method aims to allow customizing the value of a parameter iRuleParamID for a given rule applied on a given fastener occurrence.

Parameters:

oppParm: [out] The volatile value that will be used by the corresponding check rule.
iRuleParamID: [in] The corresponding rule parameter ID given in the Fastener Reference file . Example: FCE_Distance
ipFastener: [in] The fastener occurrence to be checked.

Returns:

Legal values:

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

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