All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATWeightEquivalentUseItf Interface CATIEquivalentProxyBSMUse

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIEquivalentProxyBSMUse

Interface representing a bridge from the product reference to weight values.
Components that implement CATIEquivalentProxyBSMUse are PCCMemVPMReference and BSMReference

Example:

  // example that retrieves a mass previously declared on a product reference
  consider a (CATIPLMNavReference*):  myReference
  CATIEquivalentProxyBSMUse * myBridge = NULL;
  HRESULT hRC = myReference->QueryInterface(IID_CATIEquivalentProxyBSMUse,
                                     (void**) &myBridge);
  if (SUCCEEDED(hRC))
  {
     CATIDeclaredEquivalent * declaredEquivalent = NULL ;
     hRC = myBSMExt->RetrieveDeclaredExt(declaredEquivalent) ;
     if (SUCCEEDED(hRC))
     {
         double myMasse = 0. ;
         declaredEquivalent->GetMass(myMasse) ;

         declaredEquivalent->Release() ;
         declaredEquivalent = NULL ;
     }
     myBSMExt->Release() ;
     myBSMExt = NULL ;
  }

Method Index

o CreateOrRetrieveDeclaredInertiaExtension(CATIDeclaredEquivalentUse*&,int): Permits to create/get a pointer on the declared inertia values associated to itself.
o CreateOrRetrieveDeclaredWeightExtension(CATIPLMNavOccurrence*,CATIDeclaredWeightEquivalentUse*&,int): Permits to get a pointer on the declared weight values associated to itself.
o RetrieveComputedExtension(CATIComputedEquivalentUse*&,int): Permits to get a pointer on the computed weight and inertia values associated to itself.
o RetrieveDeclaredInertiaExtension(CATIDeclaredEquivalentUse*&): Permits to get a pointer on the declared inertia values associated to itself.
o RetrieveDeclaredWeightExtension(CATIPLMNavOccurrence*,CATIDeclaredWeightEquivalentUse*&)

Methods

o CreateOrRetrieveDeclaredInertiaExtension

public virtual CreateOrRetrieveDeclaredInertiaExtension(		`oDeclaredEquivalent`,
		`iForceCreation`	`=0`)

Permits to create/get a pointer on the declared inertia values associated to itself.

Parameters:

oDeclaredEquivalent: [out, CATBaseUnknown#Release] The declared inertia values (CoG, inertia matrix)
iForceCreation: [in] iForceCreation equal to 0 - the declared equivalent given is the one that already exist; if nothing exist, we do not force any creation [in] iForceCreation equal to 1 - if no declared equivalent prealably exists, we force the creation of a declared inertia equivalent

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

o CreateOrRetrieveDeclaredWeightExtension

public virtual CreateOrRetrieveDeclaredWeightExtension(	`iMyContext`,
	`oDeclaredEquivalent`,
	`iForceCreation`	`=0`)

Permits to get a pointer on the declared weight values associated to itself.

Parameters:

iMyContext: [in] The occurrence on which we retrieve the declared weight extension
oDeclaredEquivalent: [out, CATBaseUnknown#Release] The declared weight values
iForceCreation: [in] iForceCreation equal to 0 - the declared equivalent given is the one that already exist; if nothing exist, we do not force any creation [in] iForceCreation equal to 1 - if no declared equivalent prealably exists, we force the creation of a declared weight equivalent

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

o RetrieveComputedExtension

public virtual RetrieveComputedExtension(		`oComputedEquivalent`,
		`iTryAnUpdate`	`=0`)

Permits to get a pointer on the computed weight and inertia values associated to itself.

Parameters:

oComputedEquivalent: [out, CATBaseUnknown#Release] The computed weight values
iTryAnUpdate: [in] iTryAnUpdate=0 will give the weight value without relaunching a computation [in] iTryAnUpdate=1 will relaunch a weight synthesis without computing the values on terminal nodes [in] iTryAnUpdate=2 will relaunch a weight synthesis with prealably computing the values on terminal nodes

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

o RetrieveDeclaredInertiaExtension

public virtual RetrieveDeclaredInertiaExtension( oDeclaredEquivalent)

Permits to get a pointer on the declared inertia values associated to itself.

Parameters:

oDeclaredEquivalent: [out, CATBaseUnknown#Release] The declared inertia values (CoG, inertia matrix)

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

o RetrieveDeclaredWeightExtension

public virtual RetrieveDeclaredWeightExtension(		`iMyContext`,
		`oDeclaredEquivalent`)

Deprecated:

V6R2013x

Parameters:

iMyContext: [in] The occurrence on which we retrieve the declared weight extension
oDeclaredEquivalent: [out, CATBaseUnknown#Release] The declared weight values

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

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