All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMExtrapol

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIGSMExtrapol
 

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


interface CATIGSMExtrapol

Extrapolation feature.
Role: Allows to access data of the Extrapol feature created by using an element (a curve or a surface), a boundary of this element (a point in case of curve extrapolation or a curve in case of surface extrapolation), and a limit (which can be specified by a length or a limit element).
Continuity between the extrapolated element and the extrapolation can be : tangent or curvature.
Extrapolation can be assembled or not with the extrapolated curve or surface. In case of surface extrapolation, extrapolation borders can be :
- normal to the boundary of the extrapolated surface,
- tangent to the edges of the extrapolated surface, that are adjacent to the boundary

See also:
CATGSMExtrapolLimitType, CATGSMExtrapolContinuityType, CATGSMExtrapolBorderType
See also:
CATIGSMFactory.CreateExtrapol


Method Index


o AddInternalEdgesElement(CATISpecObject_var&)
Adds an internal element like vertex or edge to the Extrapol The element is added at the end of the list.
o GetBorderType(CATGSMExtrapolBorderType&)
Gets the Border type of extrapolation (in case of surface extrapolation).
o GetBoundary(CATISpecObject_var&)
Gets the boundary of extrapolated curve or surface from which extrapolation begins.
o GetConstantLengthMode(CATBoolean&)
Gets the constant distance extrapolation mode in case of Length extrapolation limit.
o GetContinuityType(CATGSMExtrapolContinuityType&)
Gets the continuity type between extrapolated element and extrapolation.
o GetElemToExtrapol(CATISpecObject_var&)
Gets the curve or surface feature to extrapolate.
o GetElemUntil(CATISpecObject_var&)
Gets the surface or volume specifying the extrapolation limit (when Limit type is CATGSMUpToElementLimit).
o GetExtendEdgesMode(CATBoolean&)
Gets the extension of extrapolated edges mode in case of tangent continuity mode, tangent border mode and assembled result.
o GetExtendedBoundary(CATBody_var&,CATBody_var&,CATGeoFactory_var,CATTopData*,CATGSMExtrapolPropagationMode)
Gets the extended boundary in case of tangency propagation of the boundary.
o GetInternalEdgesElements(CATLISTV(CATISpecObject_var)&)
Gets all elements in the list of internal elements (vertex or edges).
o GetLength(CATICkeParm_var&)
Gets the Length specifying the extrapolation limit (when Limit type is CATGSMLengthLimit).
o GetLength(double&)
Gets the Length specifying the extrapolation limit (when Limit type is CATGSMLengthLimit).
o GetLimitType(CATGSMExtrapolLimitType&)
Gets limit type of extrapolation (a length or a surface or volume).
o GetPropagationMode(CATGSMExtrapolPropagationMode&)
Gets the propagation mode (in case of curvature extrapolation of a shell).
o GetSupport(CATISpecObject_var&)
Gets the support surface (in case of tangent extrapolation of a wire).
o IsAssemble(CATBoolean&)
Queries whether extrapolation is assembled with extrapolated curve or surface.
o RemoveAllInternalEdgesElement()
Removes all internal elements.
o RemoveInternalEdgesElement(CATISpecObject_var)
Removes an internal element to the Extrapol.
o SetAssemble(CATBoolean)
Sets ,if needed, the assemble option in extrapolation.
o SetBorderType(CATGSMExtrapolBorderType)
Sets the Border type of extrapolation (in case of surface extrapolation).
o SetBoundary(CATISpecObject_var)
Sets the boundary of extrapolated curve or surface from which extrapolation begins.
o SetConstantLengthMode(CATBoolean)
Sets the constant distance extrapolation mode in case of Length extrapolation limit.
o SetContinuityType(CATGSMExtrapolContinuityType)
Sets the continuity type between extrapolated element and extrapolation.
o SetElemToExtrapol(CATISpecObject_var)
Sets the curve or surface feature to extrapolate.
o SetElemUntil(CATISpecObject_var)
Sets the surface or volume specifying the extrapolation limit (when Limit type is CATGSMUpToElementLimit).
o SetExtendEdgesMode(CATBoolean)
Sets the extension of extrapolated edges mode in case of tangent continuity mode, tangent border mode and assembled result.
o SetLength(CATICkeParm_var)
Sets the Length specifying the extrapolation limit (when Limit type is CATGSMLengthLimit).
o SetLength(double)
Sets the Length specifying the extrapolation limit (when Limit type is CATGSMLengthLimit).
o SetLimitType(CATGSMExtrapolLimitType)
Sets limit type of extrapolation (a length or a surface or volume).
o SetPropagationMode(CATGSMExtrapolPropagationMode)
Sets the support surface (in case of curvature extrapolation of a shell).
o SetSupport(CATISpecObject_var)
Sets the support surface (in case of tangent extrapolation of a wire).

Methods


o AddInternalEdgesElement
public virtual HRESULT AddInternalEdgesElement(CATISpecObject_var& InternalElement) = 0
Adds an internal element like vertex or edge to the Extrapol The element is added at the end of the list.
Parameters:
InternalElement
element vertex or edge from the spec to extrapol
o GetBorderType
public virtual HRESULT GetBorderType(CATGSMExtrapolBorderType& oBorderType) = 0
Gets the Border type of extrapolation (in case of surface extrapolation). In case of surface extrapolation, extrapolation borders can be : - normal to the boundary of the extrapolated surface, - tangent to the edges of the extrapolated surface, that are adjacent to the boundary
Parameters:
oBorderType
Border Type (CATGSMNormalBorder or CATGSMTangentBorder)
See also:
CATGSMExtrapolBorderType
o GetBoundary
public virtual HRESULT GetBoundary(CATISpecObject_var& oElem) = 0
Gets the boundary of extrapolated curve or surface from which extrapolation begins.
Parameters:
oElem
boundary point (or curve) of extrapolated curve (or surface)
o GetConstantLengthMode
public virtual HRESULT GetConstantLengthMode(CATBoolean& oConstantLengthMode) = 0
Gets the constant distance extrapolation mode in case of Length extrapolation limit.
Parameters:
oConstantLengthMode
Constant length option (TRUE or FALSE)
o GetContinuityType
public virtual HRESULT GetContinuityType(CATGSMExtrapolContinuityType& oContinuityType) = 0
Gets the continuity type between extrapolated element and extrapolation. Continuity can be tangent or curvature
Parameters:
oContinuityType
Continuity Type (CATGSMTangentContinuity or CATGSMCurvatureContinuity)
See also:
CATGSMExtrapolContinuityType
o GetElemToExtrapol
public virtual HRESULT GetElemToExtrapol(CATISpecObject_var& oElem) = 0
Gets the curve or surface feature to extrapolate.
Parameters:
oElem
curve or surface feature to extrapolate
o GetElemUntil
public virtual HRESULT GetElemUntil(CATISpecObject_var& oElem) = 0
Gets the surface or volume specifying the extrapolation limit (when Limit type is CATGSMUpToElementLimit).
Parameters:
oElem
surface or volume specifying the extrapolation limit
o GetExtendEdgesMode
public virtual HRESULT GetExtendEdgesMode(CATBoolean& oExtendMode) = 0
Gets the extension of extrapolated edges mode in case of tangent continuity mode, tangent border mode and assembled result.
Parameters:
oExtendMode
Extend edges option (TRUE or FALSE)
o GetExtendedBoundary
public virtual HRESULT GetExtendedBoundary(CATBody_var& ioBodyExtendedBoundary,
CATBody_var& iBodyToExtrapol,
CATGeoFactory_var iFactory,
CATTopData* iTopData,
CATGSMExtrapolPropagationMode iPropagationMode= CATGSMNoPropagation)=0
Gets the extended boundary in case of tangency propagation of the boundary.
Parameters:
ioBodyExtendedBoundary
the extended boundary
iFactory
Geometric factory
iTopData
The topological data
o GetInternalEdgesElements
public virtual HRESULT GetInternalEdgesElements(CATLISTV(CATISpecObject_var)& oInternalElements) =0
Gets all elements in the list of internal elements (vertex or edges).
Parameters:
CATLISTV
oInternalElements list of internal elements
o GetLength
public virtual HRESULT GetLength(CATICkeParm_var& oLength) = 0
Gets the Length specifying the extrapolation limit (when Limit type is CATGSMLengthLimit).
Parameters:
oLength
Length
See also:
CATICkeParm
o GetLength
public virtual HRESULT GetLength(double& oLength) = 0
Gets the Length specifying the extrapolation limit (when Limit type is CATGSMLengthLimit).
Parameters:
oLength
Length
o GetLimitType
public virtual HRESULT GetLimitType(CATGSMExtrapolLimitType& oLimitType) = 0
Gets limit type of extrapolation (a length or a surface or volume).
Parameters:
oLimitType
Limit type of extrapolation (CATGSMLengthLimit or CATGSMUpToElementLimit)
o GetPropagationMode
public virtual HRESULT GetPropagationMode(CATGSMExtrapolPropagationMode& oPropagationMode) = 0
Gets the propagation mode (in case of curvature extrapolation of a shell).
Parameters:
oPropagationMode
propagation mode
o GetSupport
public virtual HRESULT GetSupport(CATISpecObject_var& oSupport) = 0
Gets the support surface (in case of tangent extrapolation of a wire). If a support surface is given, the extrapolation will lie on it.
Parameters:
oSupport
support
o IsAssemble
public virtual HRESULT IsAssemble(CATBoolean& oAssemble) = 0
Queries whether extrapolation is assembled with extrapolated curve or surface.
Parameters:
oAssemble
Assemble option (TRUE or FALSE)
o RemoveAllInternalEdgesElement
public virtual HRESULT RemoveAllInternalEdgesElement()= 0
Removes all internal elements.
o RemoveInternalEdgesElement
public virtual HRESULT RemoveInternalEdgesElement( const CATISpecObject_var iElem) = 0
Removes an internal element to the Extrapol.
Parameters:
iElem
internal element to be removed
o SetAssemble
public virtual HRESULT SetAssemble(CATBoolean iAssemble) = 0
Sets ,if needed, the assemble option in extrapolation.
i.e: assemble of extrapolation with extrapolated element.
Parameters:
iAssemble
Assemble option on (TRUE) or off (FALSE)
o SetBorderType
public virtual HRESULT SetBorderType(CATGSMExtrapolBorderType iBorderType) = 0
Sets the Border type of extrapolation (in case of surface extrapolation). In case of surface extrapolation, extrapolation borders can be : - normal to the boundary of the extrapolated surface, - tangent to the edges of the extrapolated surface, that are adjacent to the boundary
Parameters:
iBorderType
Border Type (CATGSMNormalBorder or CATGSMTangentBorder)
See also:
CATGSMExtrapolBorderType
o SetBoundary
public virtual HRESULT SetBoundary( const CATISpecObject_var iElem) = 0
Sets the boundary of extrapolated curve or surface from which extrapolation begins.
Parameters:
iElem
boundary point (or curve) of extrapolated curve (or surface)
o SetConstantLengthMode
public virtual HRESULT SetConstantLengthMode( const CATBoolean iConstantLengthMode) = 0
Sets the constant distance extrapolation mode in case of Length extrapolation limit.
Parameters:
iConstantLengthMode
Constant length option on (TRUE) or off (FALSE)
o SetContinuityType
public virtual HRESULT SetContinuityType(CATGSMExtrapolContinuityType iContinuityType) = 0
Sets the continuity type between extrapolated element and extrapolation. Continuity can be tangent or curvature
Parameters:
iContinuityType
Continuity Type (CATGSMTangentContinuity or CATGSMCurvatureContinuity)
See also:
CATGSMExtrapolContinuityType
o SetElemToExtrapol
public virtual HRESULT SetElemToExtrapol( const CATISpecObject_var iElem) = 0
Sets the curve or surface feature to extrapolate.
Parameters:
iElem
curve or surface feature to extrapolate
o SetElemUntil
public virtual HRESULT SetElemUntil( const CATISpecObject_var iElem) = 0
Sets the surface or volume specifying the extrapolation limit (when Limit type is CATGSMUpToElementLimit).
Parameters:
iElem
surface or volume specifying the extrapolation limit
o SetExtendEdgesMode
public virtual HRESULT SetExtendEdgesMode( const CATBoolean iExtendMode) = 0
Sets the extension of extrapolated edges mode in case of tangent continuity mode, tangent border mode and assembled result.
Parameters:
iExtendMode
Extend edges option on (TRUE) or off (FALSE)
o SetLength
public virtual HRESULT SetLength( const CATICkeParm_var iLength) = 0
Sets the Length specifying the extrapolation limit (when Limit type is CATGSMLengthLimit).
Parameters:
iLength
Length
See also:
CATICkeParm
o SetLength
public virtual HRESULT SetLength(double iLength) = 0
Sets the Length specifying the extrapolation limit (when Limit type is CATGSMLengthLimit).
Parameters:
iLength
Length
o SetLimitType
public virtual HRESULT SetLimitType(CATGSMExtrapolLimitType iLimitType) = 0
Sets limit type of extrapolation (a length or a surface or volume).
Parameters:
iLimitType
Limit type of extrapolation (CATGSMLengthLimit or CATGSMUpToElementLimit)
o SetPropagationMode
public virtual HRESULT SetPropagationMode( const CATGSMExtrapolPropagationMode iPropagationMode) = 0
Sets the support surface (in case of curvature extrapolation of a shell).
Parameters:
iPropagationMode
propagation mode
o SetSupport
public virtual HRESULT SetSupport( const CATISpecObject_var iSupport) = 0
Sets the support surface (in case of tangent extrapolation of a wire). If a support surface is given, the extrapolation will lie on it.
Parameters:
iSupport
support

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

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