All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSOUseItf Interface CATIGSMUseDevelop

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

interface CATIGSMUseDevelop

Interface to develop feature.
Role:Allows to access data of the Develop feature created by using a wire, a revolution surface and positioning parameters.

See also:

Method Index

o GetInclination(CATICkeParm_var&): Gets the inclination literal feature.
o GetMode(enum CATGSMDevelopMethod&): Gets the develop method mode.
o GetOrientation(int&): Gets the surface orientation used for develop computation.
o GetPlaneAxisAngle(CATICkeParm_var&): Gets the numerical positioning angle parameter.
o GetPlaneAxisCoord(CATICkeParm_var&,int): Gets the numerical positioning parameters.
o GetPlaneAxisDirection(CATIGSMUseDirection_var&): Gets the positioning parameter: plane axis direction.
o GetPlaneAxisOrigin(CATIMmiMechanicalFeature_var&): Gets the positioning parameter : plane axis origin.
o GetPlaneAxisSwapAxes(enum CATGSMAxisInversionMode&): Gets the positioning parameter : axes inversion from previous definition.
o GetPointOnSupport(CATIMmiMechanicalFeature_var&): Gets the point on the revolution surface.
o GetPosMode(enum CATGSMPositionMode&): Gets the positioning mode.
o GetPositionedWire(CATIMmiMechanicalFeature_var&): Gets the positioning transformation.
o GetRadiantness(CATICkeParm_var&): Gets the radiantness literal feature.
o GetRadius(CATICkeParm_var&): Gets the Radius literal feature.
o GetSupport(CATIMmiMechanicalFeature_var&): Gets the revolution surface on which to develop.
o GetWirePlane(CATIMmiMechanicalFeature_var&): Gets the plane feature that MAY be given explicitly.
o GetWireToDevelop(CATIMmiMechanicalFeature_var&): Gets the planar wire element to be developed.
o SetInclination(CATICkeParm_var): Sets the inclination literal feature.
o SetMode(enum CATGSMDevelopMethod): Sets the develop method mode.
o SetOrientation(int): Sets the surface orientation used for develop computation.
o SetPlaneAxisAngle(double): Sets the numerical positioning angle parameter.
o SetPlaneAxisAngle(CATICkeParm_var): Sets the numerical positioning angle parameter.
o SetPlaneAxisCoord(double,int): Sets the numerical positioning coordinates parameters.
o SetPlaneAxisCoord(CATICkeParm_var,int): Sets the numerical positioning coordinates parameters.
o SetPlaneAxisDirection(CATIGSMUseDirection_var): Sets the positioning parameter : plane axis direction.
o SetPlaneAxisOrigin(CATIMmiMechanicalFeature_var): Sets the positioning parameter : plane axis origin.
o SetPlaneAxisSwapAxes(enum CATGSMAxisInversionMode): Sets the positioning parameter : axes inversion from previous definition.
o SetPointOnSupport(CATIMmiMechanicalFeature_var): Sets the point on the revolution surface.
o SetPosMode(enum CATGSMPositionMode): Sets the positioning mode.
o SetPositionedWire(CATIMmiMechanicalFeature_var): Sets the positioning transformation.
o SetRadiantness(CATICkeParm_var): Sets the radiantness literal feature.
o SetRadius(CATICkeParm_var): Sets the Radius literal feature.
o SetSupport(CATIMmiMechanicalFeature_var): Sets the revolution surface on which to develop.
o SetWirePlane(CATIMmiMechanicalFeature_var): Sets the plane feature that MAY be given explicitly.
o SetWireToDevelop(CATIMmiMechanicalFeature_var): Sets the planar wire element to be developed.

Methods

o GetInclination

public virtual GetInclination( oElem)

Gets the inclination literal feature.

Parameters:

oElem: Inclination literal feature

o GetMode

public virtual GetMode( oElem)

Gets the develop method mode.

Parameters:

oElem: CATGSMDevelopMethod_DevDev or CATGSMDevelopMethod_DevProj

o GetOrientation

public virtual GetOrientation( oOri)

Gets the surface orientation used for develop computation.
Note: to be use for build purposes.
It is automatically set to 2 when creating a develop.
Then, at the first evaluation, it is set to 1 (support surface orientation) or 0 (opposite support surface orientation) depending on algorithm recommendation : given the point on the support, the orientation is taken 'external'.
Once set, it is not supposed to change ever. This has been implemented to garantee stability.
Note: to be use for build purposes.

Parameters:

Elem: 0 (support surface orientation), 1 (opposite) or 2 (unset)

o GetPlaneAxisAngle

public virtual GetPlaneAxisAngle( oElem)

Gets the numerical positioning angle parameter.
It corresponds to the angle from the default position of the X axis.

Parameters:

oElem: Numerical parameter (literal feature)

o GetPlaneAxisCoord

public virtual GetPlaneAxisCoord(		`oElem`,
	const	`iI`)

Gets the numerical positioning parameters.
It corresponds to the two coordinates of the new origin in the default plane axis system.

Parameters:

oElem: Numerical parameter (literal feature)
oI: Index of the parameter (1 or 2)

o GetPlaneAxisDirection

public virtual GetPlaneAxisDirection( oElem)

Gets the positioning parameter: plane axis direction.
The plane is the one on which lies the wire to be developed.
The direction is the one that the X axis follows.
The Y axis direction is given by the vector product of the Z axis of the default computed axis system and the present direction.

Parameters:

oElem: Direction feature

o GetPlaneAxisOrigin

public virtual GetPlaneAxisOrigin( oElem)

Gets the positioning parameter : plane axis origin.
The plane is the one on which lies the wire to be developed.

Parameters:

oElem: Origin feature

o GetPlaneAxisSwapAxes

public virtual GetPlaneAxisSwapAxes( oI)

Gets the positioning parameter : axes inversion from previous definition.

Parameters:

oI: State of axes :
- CATGSMAxisInversionMode_None : no axis inverted
- CATGSMAxisInversionMode_X : only X axis inverted
- CATGSMAxisInversionMode_Y : only Y axis inverted
- CATGSMAxisInversionMode_Both : both axes inverted

o GetPointOnSupport

public virtual GetPointOnSupport( oElem)

Gets the point on the revolution surface.
It corresponds to the origin of the axis on this surface.

Parameters:

oElem: Point on surface feature

o GetPosMode

public virtual GetPosMode( oElem)

Gets the positioning mode.

Parameters:

oElem: CATGSMPositionMode_Develop if a positioning operation is operated, CATGSMPositionMode_NoneOrPositioned if not

o GetPositionedWire

public virtual GetPositionedWire( oElem)

Gets the positioning transformation.
It allows to get the user positioned planar wire axis.
The result of this feature is the planar wire, positioned in the support-linked axis.

Parameters:

oElem: Positioning transformation feature (or positioned wire)

o GetRadiantness

public virtual GetRadiantness( oElem)

Gets the radiantness literal feature.

Parameters:

oElem: Radiantness literal feature

o GetRadius

public virtual GetRadius( oElem)

Gets the Radius literal feature.

Parameters:

oElem: Radius literal feature

o GetSupport

public virtual GetSupport( oElem)

Gets the revolution surface on which to develop.

Parameters:

oElem: Revolution surface feature

o GetWirePlane

public virtual GetWirePlane( oElem)

Gets the plane feature that MAY be given explicitly.

Parameters:

oElem: Plane feature, NULL_var if not given explicitly

o GetWireToDevelop

public virtual GetWireToDevelop( oElem)

Gets the planar wire element to be developed.

Parameters:

oElem: Planar wire feature

o SetInclination

public virtual SetInclination( const iElem)

Sets the inclination literal feature.

Parameters:

iElem: Inclination literal feature

o SetMode

public virtual SetMode( const iElem)

Sets the develop method mode.

Parameters:

iElem: CATGSMDevelopMethod_DevDev or CATGSMDevelopMethod_DevProj

o SetOrientation

public virtual SetOrientation( const iOri)

Sets the surface orientation used for develop computation.
Note: to be use for build purposes.

Parameters:

iOri: 0 (support surface orientation), 1 (opposite) or 2 (unset)

o SetPlaneAxisAngle

public virtual SetPlaneAxisAngle( const iElem)

Sets the numerical positioning angle parameter.
It corresponds to the angle from the default position of the X axis.

Parameters:

iElem: Numerical value

o SetPlaneAxisAngle

public virtual SetPlaneAxisAngle( const iElem)

Sets the numerical positioning angle parameter.
It corresponds to the angle from the default position of the X axis.

Parameters:

iElem: Numerical parameter (literal feature)

o SetPlaneAxisCoord

public virtual SetPlaneAxisCoord(	const	`iElem`,
	const	`iI`)

Sets the numerical positioning coordinates parameters.
It corresponds to the two coordinates of the new origin in the default plane axis system.

Parameters:

iElem: Numerical value
iI: Index of the parameter (1 or 2)

o SetPlaneAxisCoord

public virtual SetPlaneAxisCoord(	const	`iElem`,
	const	`iI`)

Sets the numerical positioning coordinates parameters.
It corresponds to the two coordinates of the new origin in the default plane axis system.

Parameters:

iElem: Numerical parameter (literal feature)
iI: Index of the parameter (1 or 2)

o SetPlaneAxisDirection

public virtual SetPlaneAxisDirection( const iElem)

Sets the positioning parameter : plane axis direction.
The plane is the one on which lies the wire to be developed.
The direction is the one that the X axis follows.
The Y axis direction is given by the vector product of the Z axis of the default computed axis system and the present direction.

Parameters:

iElem: Direction feature

o SetPlaneAxisOrigin

public virtual SetPlaneAxisOrigin( const iElem)

Sets the positioning parameter : plane axis origin.
The plane is the one on which lies the wire to be developed.

Parameters:

iElem: Origin feature

o SetPlaneAxisSwapAxes

public virtual SetPlaneAxisSwapAxes( const iI)

Sets the positioning parameter : axes inversion from previous definition.

Parameters:

iI: State of axes :
- CATGSMAxisInversionMode_None : no axis inverted
- CATGSMAxisInversionMode_X : only X axis inverted
- CATGSMAxisInversionMode_Y : only Y axis inverted
- CATGSMAxisInversionMode_Both : both axes inverted

o SetPointOnSupport

public virtual SetPointOnSupport( const iElem)

Sets the point on the revolution surface.
It corresponds to the origin of the axis on this surface.

Parameters:

iElem: Point on surface feature

o SetPosMode

public virtual SetPosMode( const iElem)

Sets the positioning mode.

Parameters:

iElem: CATGSMPositionMode_Develop if a positioning operation is operated, CATGSMPositionMode_NoneOrPositioned if not

o SetPositionedWire

public virtual SetPositionedWire( const iElem)

Sets the positioning transformation.

Parameters:

iElem: Positioning transformation feature

Returns:

S_OK if OK, E_FAIL if failure

o SetRadiantness

public virtual SetRadiantness( const iElem)

Sets the radiantness literal feature.

Parameters:

iElem: Radiantness literal feature

o SetRadius

public virtual SetRadius( const iElem)

Sets the Radius literal feature.

Parameters:

iElem: Radius literal feature

o SetSupport

public virtual SetSupport( const iElem)

Sets the revolution surface on which to develop.

Parameters:

iElem: Revolution surface feature

o SetWirePlane

public virtual SetWirePlane( const iElem)

Sets the plane feature that MAY be given explicitly.

Parameters:

iElem: Plane feature

o SetWireToDevelop

public virtual SetWireToDevelop( const iElem)

Sets the planar wire element to be developed.

Parameters:

iElem: Planar wire feature

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