CATStrUseItf Interface CATIStrUseProfileLimitMngt

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


interface CATIStrUseProfileLimitMngt

Interface to manage limits of the SFD/SDD Profile.
Role: Interface to manage SFD/SDD limits for Profile. When a limit is specified with SetLimitingObject(), a default ShortPoint endcut is created at the elected extremity. when a limit is removed, the endcut is removed as well. However, you can specify a non-contextual endcut, ie, an endcut before applying a limit.


Method Index


o ExplicitLimits(CATStrProfileExtremity)
In case the profile support is a Panel/Plate(s), it will set the limit ancestor of the DelimitedMoldedSurface edge stopping the CanonicTrace as a limit.
o GetLimitType(CATStrProfileExtremity,CATStrProfileLimitType&)
Get the type of the limit applied on the Profile.
o GetLimitingObject(CATStrProfileExtremity,CATIMmiMechanicalFeature_var&)
Set a feature selected by the user on the extremity
o GetOffset(CATStrProfileExtremity,CATICkeParm_var&)
Get the limit offset
o InvertProfile()
Invert the definition of the start and end for the selected profile.
o RemoveLimit(CATStrProfileExtremity)
Remove the limit associated to the extremity.
o SetLimitType(CATStrProfileExtremity,CATStrProfileLimitType)
Set the type of the limit applied on the Profile.
o SetLimitingObject(CATStrProfileExtremity,CATIMmiMechanicalFeature_var&)
Set a feature selected by the user on the extremity

Methods


o ExplicitLimits
public virtual HRESULT ExplicitLimits( const CATStrProfileExtremity iExtr= catStrProfileExtremityUndefined) = 0
In case the profile support is a Panel/Plate(s), it will set the limit ancestor of the DelimitedMoldedSurface edge stopping the CanonicTrace as a limit. It sets the extremum limits only, so let's imagine the supporting Plate is concave with a U shape and the Stiffener crosses the concavity, the explicited limits are the two vertical Plate limits at both extremes. So the Stiffener can cross the "hole" in SDD.
Parameters:
iExtr
Extremity of the Profile that will be set with the Plate limit. If iExtr=catStrProfileExtremityUndefined, we reset both extremities.
o GetLimitType
public virtual HRESULT GetLimitType( const CATStrProfileExtremity iExtr,
CATStrProfileLimitType& oType) const = 0
Get the type of the limit applied on the Profile.
Parameters:
iExtr
Extremity of the Profile. If iExtr == 1 : Start extremity. If iExtr == 2 : End extremity.
oType
the Cke Parameter associated to the offset
o GetLimitingObject
public virtual HRESULT GetLimitingObject( const CATStrProfileExtremity iExtr,
CATIMmiMechanicalFeature_var& oLimitingObject) const = 0
Set a feature selected by the user on the extremity
Parameters:
iExtr
Extremity of the Profile where to Set the Limiting Object. If iExtr == 1 : Start extremity. If iExtr == 2 : End extremity.
oLimitingObject
the feature to be set on the extremity. Can be a geometric curves, surfaces or a SFD Profile, or a SFD Panel. The exported feature is retrieved if possible, otherwise the import.
o GetOffset
public virtual HRESULT GetOffset( const CATStrProfileExtremity iExtr,
CATICkeParm_var& ospOffset) = 0
Get the limit offset
Parameters:
iExtr
Extremity of the Profile. If iExtr == 1 : Start extremity. If iExtr == 2 : End extremity.
ospOffset
the Cke Parameter associated to the offset
o InvertProfile
public virtual HRESULT InvertProfile()= 0
Invert the definition of the start and end for the selected profile.
o RemoveLimit
public virtual HRESULT RemoveLimit( const CATStrProfileExtremity iExtr) = 0
Remove the limit associated to the extremity. Remove the Limit + EndCut.
Parameters:
iExtr
Extremity of the Profile. If iExtr == 1 : Start extremity. If iExtr == 2 : End extremity.
o SetLimitType
public virtual HRESULT SetLimitType( const CATStrProfileExtremity iExtr,
const CATStrProfileLimitType iType) = 0
Set the type of the limit applied on the Profile. This info is just captured at the support level and then realized at the Profile level in SDD.
Parameters:
iExtr
Extremity of the Profile. If iExtr == 1 : Start extremity. If iExtr == 2 : End extremity.
iType
See also:
CATStrProfileLimitType
o SetLimitingObject
public virtual HRESULT SetLimitingObject( const CATStrProfileExtremity iExtr,
const CATIMmiMechanicalFeature_var& iLimitingObject) = 0
Set a feature selected by the user on the extremity
Parameters:
iExtr
Extremity of the Profile where to Set the Limiting Object . If iExtr == 1 : Start extremity. If iExtr == 2 : End extremity.
iLimitingObject
The feature to be set on the extremity. Cannot be used to unset or remove the limit. iLimitingObject can not be null. Can be a geometric curves, surfaces or a SFD Profile, or a SFD Panel. The import is managed by the implementation. Cannot be used to unset or remove the limit. ispLimit can not be null.

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.