All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSmaInterfaces Interface CATIStmJoggle

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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 :


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 GetPlane(CATISpecObject**)

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(CATISpecObject**)

Role: This method retrieves the support of the joggle.
o ManageOnSupport(CATISpecObject*,CATISpecObject*)
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 SetPlane(CATISpecObject*)

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(CATISpecObject*)

Role: This method sets the support of the joggle.

Methods


o GetClearance
public virtual HRESULT __stdcall GetClearance(CATICkeParm** opiClearanceParam) = 0

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 HRESULT __stdcall GetDepth(CATICkeParm** opiDepthParam) = 0

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 HRESULT __stdcall GetDepthOrient(CATOrientation& oDepthOrient) = 0

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 HRESULT __stdcall GetEndRadius(CATICkeParm** opiRadiusParam) = 0

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 GetPlane
public virtual HRESULT __stdcall GetPlane(CATISpecObject** opiPlaneSpec) = 0

Role: This method retrieves the start plane of the joggle.
Parameters:
opiPlaneSpec
a plane or a planar face.
o GetRunout
public virtual HRESULT __stdcall GetRunout(CATICkeParm** opiRunoutParam) = 0

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 HRESULT __stdcall GetRunoutOrient(CATOrientation& oRunoutOrient) = 0

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 HRESULT __stdcall GetRunoutType(int& RunoutType) = 0

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 HRESULT __stdcall GetStartRadius(CATICkeParm** opiRadiusParam) = 0

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 HRESULT __stdcall GetSupport(CATISpecObject** opiSupportSpec) = 0

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 HRESULT __stdcall ManageOnSupport( const CATISpecObject* ipiPrtPartSpec,
const CATISpecObject* ipiPrevSupportSpec) = 0
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 HRESULT __stdcall SetDepthOrient( const CATOrientation& iDepthOrient) = 0

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 SetPlane
public virtual HRESULT __stdcall SetPlane( const CATISpecObject* ipiPlaneSpec) = 0

Role: This method sets the start plane of the joggle.
Parameters:
ipiPlaneSpec
a plane or a planar face.
o SetRunoutOrient
public virtual HRESULT __stdcall SetRunoutOrient( const CATOrientation& iRunoutOrient) = 0

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 HRESULT __stdcall SetSupport( const CATISpecObject* ipiSupportSpec) = 0

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: CATSmaInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.