CATSmaUseItf Interface CATIStmJoggle
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIStmJoggle
Interface to manage the aerospace sheet metal joggle feature.
Role: Provides the basic methods to access data of a sheet metal
joggle feature.
A joggle is a local deformation of a surfacic flange or a Web.
A joggle is defined by :
- support : a surfacic flange or the web,
- plane : a CATPlane or a planar face,
- depth : the offset value of the joggle support surface,
- runout : the length of the joggle,
- start radius : the value of the start fillet radius of the joggle,
- end radius : the value of the end fillet radius of the joggle.
Method Index
- o
GetClearance(CATICkeParm**)
-
Role: This method retrieves the clearance length of the Joggle.
- o
GetDepth(CATICkeParm**)
-
Role: This method retrieves the depth length parameter of to the joggle.
- o
GetDepthOrient(CATOrientation&)
-
Role: This method retrieves the relative orientation of the depth compared to the joggle support.
- o
GetEndRadius(CATICkeParm**)
-
Role: This method retrieves the radius of the end fillet of the Joggle.
- o
GetJogglePlaneRole(int&)
-
Role: This method retrieves the Role of the Plane of the joggle.
- o
GetPlane(CATIMmiMechanicalFeature**)
-
Role: This method retrieves the start plane of the joggle.
- o
GetRunout(CATICkeParm**)
-
Role: This method retrieves the runout length parameter of the joggle.
- o
GetRunoutOrient(CATOrientation&)
-
Role: This method retrieves the relative orientation of the runout compared to the joggle plane.
- o
GetRunoutType(int&)
-
Role: This method retrieves the runout definition type of the joggle.
- o
GetStartRadius(CATICkeParm**)
-
Role: This method retrieves the radius of the start fillet of the Joggle.
- o
GetSupport(CATIMmiMechanicalFeature**)
-
Role: This method retrieves the support of the joggle.
- o
ManageOnSupport(CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature*)
- Role: Method to manage Joggle internal specifications.
- o
SetDepthOrient(CATOrientation&)
-
Role: This method sets the relative orientation of the depth compared to the joggle support.
- o
SetJogglePlaneRole(int&)
-
Role: This method valuates the Role of the Plane of the joggle.
- o
SetPlane(CATIMmiMechanicalFeature*)
-
Role: This method sets the start plane of the joggle.
- o
SetRunoutOrient(CATOrientation&)
-
Role: This method sets the relative orientation of the runout compared to the joggle plane.
- o
SetSupport(CATIMmiMechanicalFeature*)
-
Role: This method sets the support of the joggle.
Methods
o GetClearance
| public virtual GetClearance( | | opiClearanceParam) |
-
Role: This method retrieves the clearance length of the Joggle.
- Parameters:
-
- opiClearanceParam
- a CATICkeParm : use the method Valuate to modify the Clearance length. @see CATICkeParm.
o GetDepth
| public virtual GetDepth( | | opiDepthParam) |
-
Role: This method retrieves the depth length parameter of to the joggle.
- Parameters:
-
- opiDepth
- a CATICkeParm : use the method Valuate to modify the depth length. @see CATICkeParm.
o GetDepthOrient
| public virtual GetDepthOrient( | | oDepthOrient) |
-
Role: This method retrieves the relative orientation of the depth compared to the joggle support.
- Parameters:
-
- oDepthOrient
- A reference to a CATOrientation instance.
Legal values:
- CATOrientationNegative: The orientations are opposite,
- CATOrientationPositive: The orientations are the same,
- CATOrientationUnknown : The orientation is unknown.
o GetEndRadius
| public virtual GetEndRadius( | | opiRadiusParam) |
-
Role: This method retrieves the radius of the end fillet of the Joggle.
- Parameters:
-
- opiRadiusParam
- a CATICkeParm : use the method Valuate to modify the radius length. @see CATICkeParm.
o GetJogglePlaneRole
| public virtual GetJogglePlaneRole( | | oPlaneRole) |
-
Role: This method retrieves the Role of the Plane of the joggle.
- Parameters:
-
- oPlaneRole
- an integer
Legal values:
- 1 : the Joggle Plane is on the start of the joggle,
- 2 : the Joggle Plane is on the end of the joggle ( Default ).
o GetPlane
| public virtual GetPlane( | | opiPlaneSpec) |
-
Role: This method retrieves the start plane of the joggle.
- Parameters:
-
- opiPlaneSpec
- a plane or a planar face.
o GetRunout
| public virtual GetRunout( | | opiRunoutParam) |
-
Role: This method retrieves the runout length parameter of the joggle.
- Parameters:
-
- Runout
- a CATICkeParm : use the method Valuate to modify the runout length. @see CATICkeParm.
o GetRunoutOrient
| public virtual GetRunoutOrient( | | oRunoutOrient) |
-
Role: This method retrieves the relative orientation of the runout compared to the joggle plane.
- Parameters:
-
- oRunoutOrient
- A reference to a CATOrientation instance.
Legal values:
- CATOrientationNegative: The orientations are opposite,
- CATOrientationPositive: The orientations are the same,
- CATOrientationUnknown : The orientation is unknown.
o GetRunoutType
| public virtual GetRunoutType( | | RunoutType) |
-
Role: This method retrieves the runout definition type of the joggle.
This definition is set by the sheet metal parameters for all the
joggles created in the current Part.
- Parameters:
-
- RunoutType
- an integer
Legal values:
- 1 : the runout length includes the joggle fillets,
- 2 : the runout length excludes partially the joggle fillets.
o GetStartRadius
| public virtual GetStartRadius( | | opiRadiusParam) |
-
Role: This method retrieves the radius of the start fillet of the Joggle.
- Parameters:
-
- opiRadiusParam
- a CATICkeParm : use the method Valuate to modify the radius length. @see CATICkeParm.
o GetSupport
| public virtual GetSupport( | | opiSupportSpec) |
-
Role: This method retrieves the support of the joggle.
- Parameters:
-
- opiSupportSpec
- Specification of the support : a surfacic flange or a Web.
o ManageOnSupport
| public virtual ManageOnSupport( | const | ispPrtPartSpec, |
| const | ipiPrevSupportSpec) |
-
Role: Method to manage Joggle internal specifications.
A call to this method is mandatory BEFORE updating the Joggle.
- if the Support has been modified :
the Joggle will be removed from its Previous Support (if any).
- if the Joggle Plane has been modified :
the Joggle will be inserted on the Support according with other Joggles (if any).
- a new OFFSET Surface of the Support will be created if necessary.
- Parameters:
-
- ipiPrtPartSpec
- Part Feature
- ipiPrevSupportSpec
- Suppport of the Joggle BEFORE any Joggle modification ( is NULL if NEW Joggle ).
o SetDepthOrient
| public virtual SetDepthOrient( | const | iDepthOrient) |
-
Role: This method sets the relative orientation of the depth compared to the joggle support.
- Parameters:
-
- iDepthOrient
- A reference to a CATOrientation instance.
Legal values:
- CATOrientationNegative: The orientations are opposite,
- CATOrientationPositive: The orientations are the same,
- CATOrientationUnknown : The orientation is unknown.
o SetJogglePlaneRole
| public virtual SetJogglePlaneRole( | const | iPlaneRole) |
-
Role: This method valuates the Role of the Plane of the joggle.
- Parameters:
-
- iPlaneRole
- an integer
Legal values:
- 1 : the Joggle Plane is on the start of the joggle,
- 2 : the Joggle Plane is on the end of the joggle ( Default ).
o SetPlane
| public virtual SetPlane( | const | ipiPlaneSpec) |
-
Role: This method sets the start plane of the joggle.
- Parameters:
-
- ipiPlaneSpec
- a plane or a planar face.
o SetRunoutOrient
| public virtual SetRunoutOrient( | const | iRunoutOrient) |
-
Role: This method sets the relative orientation of the runout compared to the joggle plane.
- Parameters:
-
- iRunoutOrient
- A reference to a CATOrientation instance.
Legal values:
- CATOrientationNegative: The orientations are opposite,
- CATOrientationPositive: The orientations are the same,
- CATOrientationUnknown : The orientation is unknown.
o SetSupport
| public virtual SetSupport( | const | ipiSupportSpec) |
-
Role: This method sets the support of the joggle.
- Parameters:
-
- ipiSupportSpec
- Specification of the support : a surfacic flange or a Web.
This object is included in the file: CATIStmJoggle.h
If needed, your Imakefile.mk should include the module: CATSmaUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.