All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseCircleCenterAxis

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

interface CATIGSMUseCircleCenterAxis

Interface to circle feature defined by a center and an axis.
Role: Allows you to acess data of circle feature created from the center and axis/line specified.

See also:

Method Index

o GetAxis(CATIMmiMechanicalFeature_var&): Gets the axis.
o GetDiameter(CATICkeParm_var&): Gets the diameter of the circle.
o GetDiameterMode(CATBoolean&): Gets DiameterMode.
o GetPoint(CATIMmiMechanicalFeature_var&): Gets the point.
o GetProjectionMode(CATBoolean&): Gets ProjectionMode.
o GetRadius(CATICkeParm_var&): Gets the radius of the circle.
o SetAxis(CATIMmiMechanicalFeature_var): Sets the axis.
o SetDiameter(CATICkeParm_var): Sets DiameterMode to TRUE and then sets the diameter.
o SetDiameterMode(CATBoolean): Sets DiameterMode.
o SetPoint(CATIMmiMechanicalFeature_var): Sets the point.
o SetProjectionMode(CATBoolean): Sets ProjectionMode.
o SetRadius(CATICkeParm_var): Sets DiameterMode to FALSE and then sets the radius.

Methods

o GetAxis

public virtual GetAxis( ohAxis)

Gets the axis.

Parameters:

ohAxis: Axis of plane in which circle is lying

o GetDiameter

public virtual GetDiameter( ohDiameter)

Gets the diameter of the circle.
Note: Succeeds only if DiameterMode is set to TRUE

Parameters:

ohDiameter: diameter

o GetDiameterMode

public virtual GetDiameterMode( oDiameterMode)

Gets DiameterMode.
DiameterMode = FALSE implies radius (default),
DiameterMode = TRUE implies diameter.

Parameters:

oDiameterMode: Diameter Mode

o GetPoint

public virtual GetPoint( ohPoint)

Gets the point.

Parameters:

ohPoint: Element used for center computation

o GetProjectionMode

public virtual GetProjectionMode( oProjection)

Gets ProjectionMode.
ProjectionMode = TRUE (default) implies point will be projected on to axis/line,
ProjectionMode = FALSE implies that point will be center of the circle.

Parameters:

oProjection: Projection Mode

o GetRadius

public virtual GetRadius( ohRadius)

Gets the radius of the circle.
Note: Succeeds only if DiameterMode is set to FALSE

Parameters:

ohRadius: radius

o SetAxis

public virtual SetAxis( const ihAxis)

Sets the axis.

Parameters:

ihAxis: Axis of plane in which circle is lying

o SetDiameter

public virtual SetDiameter( const ihDiameter)

Sets DiameterMode to TRUE and then sets the diameter.

Parameters:

ihDiameter: diameter

o SetDiameterMode

public virtual SetDiameterMode( const iDiameterMode)

Sets DiameterMode.
DiameterMode = FALSE implies radius (default),
DiameterMode = TRUE implies diameter.
Note: When DiameterMode is changed, Radius/Diameter value which is stored will not be modified.

Parameters:

iDiameterMode: Diameter Mode

o SetPoint

public virtual SetPoint( const ihPoint)

Sets the point.

Parameters:

ihPoint: Element used for center computation

o SetProjectionMode

public virtual SetProjectionMode( const iProjection)

Sets ProjectionMode.
ProjectionMode = TRUE (default) implies point will be projected on to axis/line,
ProjectionMode = FALSE implies that point will be center of the circle.

Parameters:

iProjection: Projection Mode

o SetRadius

public virtual SetRadius( const ihRadius)

Sets DiameterMode to FALSE and then sets the radius.

Parameters:

ihRadius: radius

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