All Frameworks Class Hierarchy This Framework Indexes Previous Next

MeasureGeometryInterfaces Interface CATIMeasurableInContext

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

interface CATIMeasurableInContext

Get measurements on the object.

Two types of measurement can be done:

itself : gives dimensions related to the object itself (ex the radius of a circle).
between : gives dimensions related to another object (ex the distance between two products).

Methods on VOLUME : GetVolume GetArea GetCOG GetVolume_Area_COfG Methods on SURFACE : GetArea GetCOG GetPerimeter GetArea_COfG Methods on PLANE : GetArea GetCOG GetPlane Methods on CYLINDER : GetArea GetCOG GetAxis GetPointsOnAxis GetRadius Methods on CONE : GetArea GetCOG GetAxis GetPointsOnAxis GetAngle Methods on SPHERE : GetArea GetCOG GetRadius GetCenter Methods on CURVE : GetLength GetCOG GetPointsOnCurve Methods on LINE : GetLength GetCOG GetPointsOnCurve GetDirection Methods on CIRCLE : GetLength GetCOG GetPointsOnCurve GetRadius GetCenter GetAngle GetAxis Methods on POINT : GetPoint Methods on AXIS SYST : GetAxisSystem

Method Index

o Angle(CATIMeasurable_var&,CATMathAxis&,double&,CATMathPoint*,CATMathPoint*): Compute the angle between the object and another.
o GetAngle(double&): Get the half angle of a circle or cone.
o GetArea(double&): Get the area of the surface or wet area from volume.
o GetArea_COfG(double&,CATMathPoint&): Get the Area and the Center Of Gravity of the volume.
o GetAxis(CATMathVector&): Get the axis vector of the cylinder or a cone.
o GetAxisSystem(CATMathAxis&): Get the position of the the axis system.
o GetAxisSystemFromMeasurable(CATMathAxis&): Get the position of the axis system of the object with respect to the absolute axis system.
o GetCOG(CATMathPoint&): Get the position of the center of gravity of a curve, surface and volume.
o GetCenter(CATMathPoint&): Get the position of the center of a circle or sphere.
o GetComputationMode(CATMeasModeOfCalc&): Get the mode of computation of the object.
o GetDirection(CATMathDirection&): Get the direction of the line, .
o GetEntityType(CATIMeasurableType&): Get the type of measured object.
o GetLength(double&): Get the length of the curve.
o GetPerimeter(double&): Get the perimeter of the surface.
o GetPlane(CATMathPlane&): Get the position of the plane.
o GetPoint(CATMathPoint&): Get the position of the point.
o GetPointsOnAxis(CATMathPoint*,CATMathPoint*,CATMathPoint*): Get the characteristic points of the axis with respect of the size of the revolution object.
o GetPointsOnCurve(CATMathPoint&,CATMathPoint&,CATMathPoint&): Get the characteristic points of the curve.
o GetRadius(double&): Get the radius of an arc, cylinder or sphere.
o GetResultComputationMode(CATSiCalculationType&,CATMeasResultData): Get the resulting mode of computation of the object.
o GetShapeName(char*&)
o GetShapeName(CATMeasurableName&): Get the classname of higher interface of the object.
o GetVolume(double&): Get the volume of the volume.
o GetVolume_Area_COfG(double&,double&,CATMathPoint&): Get the volume, the Area and the Center Of Gravity of the volume.
o MinimumDistance(CATMathPoint&,double&,CATMathPoint&): Compute the minimum distance between the object and a CATMathPoint.
o MinimumDistance(CATIMeasurable_var&,CATMathAxis&,double&,CATMathPoint&,CATMathPoint&): Compute the minimum distance between the object and another.
o SetAxisSystemOnMeasurable(CATMathAxis&): Set the position of the axis system of the object with respect to the absolute axis system.
o SetComputationMode(CATMeasModeOfCalc&): Set the mode of computation of the object.

Methods

o Angle

public virtual Angle(	`iOtherObject`,
	`iOtherMathAxis`,
	`oAngle`,
	`iPointOnOtherObject`	`= NULL`,
	`iPointOnObject`	`= NULL`)

Compute the angle between the object and another.

Parameters:

iOtherObject: The other object to measure.
iOtherMathAxis: The position.
oAngle: The angle between the objects.
ioPointOnObject: A point of the object . It is used to determine if the angle to calculate is the angle or its complementary
ioPointOnOtherObject: A point of the other object. It is used to determine if the angle to calculate is the angle or its complementary

Returns:

HRESULT

o GetAngle

public virtual GetAngle( oAngle)

Get the half angle of a circle or cone.

Parameters:

oAngle: The angle.

Returns:

HRESULT

o GetArea

public virtual GetArea( oArea)

Get the area of the surface or wet area from volume.

Parameters:

oArea: The area.

Returns:

HRESULT

o GetArea_COfG

public virtual GetArea_COfG(		`oSurface`,
		`oCOfG`)

Get the Area and the Center Of Gravity of the volume. Use for better performance

Parameters:

oArea: The area.
oCOfG: The position with respect to absolute axis system.

Returns:

HRESULT

o GetAxis

public virtual GetAxis( ioVector)

Get the axis vector of the cylinder or a cone.

Parameters:

ioVector: The axis vector with respect to absolute axis system.

Returns:

HRESULT

o GetAxisSystem

public virtual GetAxisSystem( ioAxis)

Get the position of the the axis system.

Parameters:

ioAxis: The position with respect to absolute axis system.

Returns:

HRESULT

o GetAxisSystemFromMeasurable

public virtual GetAxisSystemFromMeasurable( oAxis)

Get the position of the axis system of the object with respect to the absolute axis system. This position corresponds to the product positioning matrix.

All coordinates are internally computed using the axis system of the object. To provide these coordinates with respect to absolute axis system, it is required to know the position of the axis system of the object.

Parameters:

oAxis: The position.

Returns:

HRESULT

o GetCOG

public virtual GetCOG( ioPoint)

Get the position of the center of gravity of a curve, surface and volume.

Parameters:

ioPoint: The position with respect to absolute axis system.

Returns:

HRESULT

o GetCenter

public virtual GetCenter( ioPoint)

Get the position of the center of a circle or sphere.

Parameters:

ioPoint: The position with respect to absolute axis system.

Returns:

HRESULT

o GetComputationMode

public virtual GetComputationMode( oComputationMode)

Get the mode of computation of the object.

Parameters:

oComputationMode: The computation mode of the object

Returns:

HRESULT

o GetDirection

public virtual GetDirection( ioDirection)

Get the direction of the line, .

Parameters:

ioDirection: The direction with respect to absolute axis system.

Returns:

HRESULT

o GetEntityType

public virtual GetEntityType( oObjectType)

Get the type of measured object.

Parameters:

oComputationMode: The type of the object : Exact or facetted.

Returns:

HRESULT

o GetLength

public virtual GetLength( oLength)

Get the length of the curve.

Parameters:

oLength: The length.

Returns:

HRESULT

o GetPerimeter

public virtual GetPerimeter( oPerimeter)

Get the perimeter of the surface.

Parameters:

oPerimeter: The Perimeter

Returns:

HRESULT

o GetPlane

public virtual GetPlane( ioPlane)

Get the position of the plane.

Parameters:

ioPlane: The position with respect to absolute axis system.

Returns:

HRESULT

o GetPoint

public virtual GetPoint( ioPoint)

Get the position of the point.

Parameters:

ioPoint: The position with respect to absolute axis system.

Returns:

HRESULT

o GetPointsOnAxis

public virtual GetPointsOnAxis(	`oCenterPoint`,
	`oStartPoint`	`= NULL`,
	`oEndPoint`	`= NULL`)

Get the characteristic points of the axis with respect of the size of the revolution object.

Parameters:

oCenterPoint: The position of the Center point with respect to absolute axis system.
oStartPoint: The position of the Start point with respect to absolute axis system.
oEndPoint: The position of the End point with respect to absolute axis system.

Returns:

HRESULT

o GetPointsOnCurve

public virtual GetPointsOnCurve(		`ioStartPoint`,
		`ioMidPoint`,
		`ioEndPoint`)

Get the characteristic points of the curve.

Parameters:

ioStartPoint: The position of the start point with respect to absolute axis system.
ioMidPoint: The position of the mid point with respect to absolute axis system.
ioEndPoint: The position of the end point with respect to absolute axis system.

Returns:

HRESULT

o GetRadius

public virtual GetRadius( oRadius)

Get the radius of an arc, cylinder or sphere.

Parameters:

oARadius: The radius.

Returns:

HRESULT

o GetResultComputationMode

public virtual GetResultComputationMode(		`oComputationMode`,
		`iResultData`	`= CATMeasGlobalResults`)

Get the resulting mode of computation of the object.

Parameters:

oComputationMode: The computation mode of the object : Exact or Approximate.

Returns:

HRESULT

o GetShapeName

public virtual GetShapeName( const oClassName)

o GetShapeName

public virtual GetShapeName( oClassName)

Get the classname of higher interface of the object.

Parameters:

oClassName: The name of the interface

Returns:

HRESULT

o GetVolume

public virtual GetVolume( oVolume)

Get the volume of the volume.

Parameters:

oVolume: The volume.

Returns:

HRESULT

o GetVolume_Area_COfG

public virtual GetVolume_Area_COfG(		`oVolume`,
		`oSurface`,
		`oCOfG`)

Get the volume, the Area and the Center Of Gravity of the volume. Use for better performance

Parameters:

oVolume: The volume.
oArea: The area.
oCOfG: The position with respect to absolute axis system.

Returns:

HRESULT

o MinimumDistance

public virtual MinimumDistance(		`iPoint`,
		`oDistance`,
		`ioPointOnObject`)

Compute the minimum distance between the object and a CATMathPoint.

Parameters:

iPoint: The point to measure.
oDistance: The distance between the objects.
ioPointOnObject: The point of the object that realizes the minimum distance.

Returns:

HRESULT

o MinimumDistance

public virtual MinimumDistance(		`iOtherObject`,
		`iOtherMathAxis`,
		`oDistance`,
		`ioPointOnObject`,
		`ioPointOnOtherObject`)

Compute the minimum distance between the object and another.

Parameters:

iOtherObject: The other object to measure.
iOtherMathAxis: The position.
oDistance: The distance between the objects.
ioPointOnObject: The point of the object that realizes the minimum distance.
ioPointOnOtherObject: The point of the other object that realizes the minimum distance.

Returns:

HRESULT

o SetAxisSystemOnMeasurable

public virtual SetAxisSystemOnMeasurable( iAxisPositioning)

Set the position of the axis system of the object with respect to the absolute axis system. This position corresponds to the product positioning matrix.

Parameters:

iAxisPositioning: The position.

Returns:

HRESULT

Example:

The following example get this coordinate of a point in a assembly newExplode

 CATIMeasurableInContext_var spMeasurableObject = PointObject;
 if (NULL_var != spMeasurableObject)
 {
    spMeasurableObject->SetAxisSystemOnMeasurable(iAxisPositioning);
    CATMeasurableName  ClassName = CATMeasurableUnknown;
    spMeasurableObject->GetShapeName(ClassName);
    if (oClassName == CATMeasurablePoint) spMeasurableObject->GetPoint(oMathPoint);
 }

o SetComputationMode

public virtual SetComputationMode( iComputationMode)

Set the mode of computation of the object.

Parameters:

iComputationMode: The computation mode of the object : Exact else Approximate Exact only Approximate only.

Returns:

HRESULT

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