All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATWeightEquivalentUseItf Interface CATIDeclaredWeightEquivalentUse

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

interface CATIDeclaredWeightEquivalentUse

Interface to access to the declared weight values.
This is the interface that permits to access to the computed weight values. In order to access to the other inertia values, use the CATIDeclaredEquivalentUse interface.

See also:

Method Index

o GetMass(double&): Permits to get the weight of itself.
o GetMassTolerance(double&): Permits to get the tolerance associated to the declared weight.
o SetMass(double): Permits to set the weight on itself.
o SetMassTolerance(double): Permits to set the tolerance associated to the declared weight.

Methods

o GetMass

public virtual GetMass( oMass)

Permits to get the weight of itself.

Parameters:

oMass: [out] The weight of the object
Unit: kg

Returns:

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

o GetMassTolerance

public virtual GetMassTolerance( oMassTolerance)

Permits to get the tolerance associated to the declared weight.

Parameters:

oMassTolerance: [out] The tolerance
Unit: kg

Returns:

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

o SetMass

public virtual SetMass( iMass)

Permits to set the weight on itself.

Parameters:

iMass: [in] The weight of the object
Unit: kg

Returns:

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

o SetMassTolerance

public virtual SetMassTolerance( iMassTolerance)

Permits to set the tolerance associated to the declared weight.

Parameters:

iMassTolerance: [in] The tolerance
Unit: kg

Returns:

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

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