CATStrUseItf Interface CATIStrUseFlange
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIStrUseFlange
Interface representing Flange object.
The Structure flange is implemented for the Structure Functional Design
and Structure Detail Design models. A flange is applied to a Plate for either
of these models. An flange is created and accessed by the CATIStrUseFlangeMngt
interfaces, which is implemented for the Plate object.
- See also:
-
Method Index
- o
GetBendingAngle(CATICkeParm_var&)
- Gets the Bending angle.
- o
GetBendingRadius(CATICkeParm_var&)
- Gets the Bending radius.
- o
GetEdge(CATIMmiMechanicalFeature_var&)
- Gets the Edge of the plate.
- o
GetEndEndCutAngle(CATICkeParm_var&)
- Gets the End EndCut Angle.
- o
GetEndEndCutDistance(CATICkeParm_var&)
- Gets the End EndCut Distance.
- o
GetEndEndCutOffset(CATICkeParm_var&)
- Gets the End EndCut Offset.
- o
GetEndEndCutRadius(CATICkeParm_var&)
- Gets the End EndCut Radius.
- o
GetFlangeEndLimit(CATIMmiMechanicalFeature_var&)
- Gets the Flange End Limit.
- o
GetFlangeStartLimit(CATIMmiMechanicalFeature_var&)
- Gets the Flange Start Limit.
- o
GetFlangeWidth(CATICkeParm_var&)
- Gets the Flange Width.
- o
GetOperatedPlate(CATIMmiMechanicalFeature_var&)
- Gets the operated plate on which flange is created.
- o
GetStartEndCutAngle(CATICkeParm_var&)
- Gets the Start EndCut Angle.
- o
GetStartEndCutDistance(CATICkeParm_var&)
- Gets the Start EndCut Distance.
- o
GetStartEndCutOffset(CATICkeParm_var&)
- Gets the Start EndCut Offset.
- o
GetStartEndCutRadius(CATICkeParm_var&)
- Gets the Start EndCut Radius.
- o
GetType(CATStrFlangeType&)
- Gets the Type of flange.
- o
GetWidthMeasurementType(CATStrFlangeWidthMeasurementType&)
- Gets the Width Measurement Type.
- o
SetEdges(CATLISTV(CATIMmiMechanicalFeature_var)&)
- Sets the Edges for Flange creation.
- o
SetFlangeEndLimit(CATIMmiMechanicalFeature_var&)
- Sets the Flange End Limit.
- o
SetFlangeStartLimit(CATIMmiMechanicalFeature_var&)
- Sets the Flange Start Limit.
- o
SetType(CATStrFlangeType)
- Sets the Type of flange.
- o
SetWidthMeasurementType(CATStrFlangeWidthMeasurementType)
- Sets the Width Measurement Type.
- o
Update()
- Updates the Flanges Created.
Methods
o GetBendingAngle
public virtual GetBendingAngle( | | oAngle) |
-
Gets the Bending angle. This angle is aligned to plane of plate. (@see CATICkeParm)
- Parameters:
-
- oAngle
- Angle
Valuate the Bending Angle as per required.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetBendingRadius
public virtual GetBendingRadius( | | oRadius) |
-
Gets the Bending radius. This is the radius of arc between planes of plate and flange.
The bending radius is computed on the interior side of the Flange. (@see CATICkeParm)
- Parameters:
-
- oRadius
- Radius
Valuate the Bending Radius as per required.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetEdge
public virtual GetEdge( | | oEdgeIndex) |
-
Gets the Edge of the plate.
- Parameters:
-
- oEdgeIndex
- EdgeIndex
Gets the Edge of plate.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetEndEndCutAngle
public virtual GetEndEndCutAngle( | | oEndEndCutAngle) |
-
Gets the End EndCut Angle. (@see CATICkeParm)
Always counted from the vertical edge of the flange.
- Parameters:
-
- oEndEndCutAngle
- EndEndCutAngle
Valuate the End EndCut Angle as per required.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetEndEndCutDistance
public virtual GetEndEndCutDistance( | | oEndEndCutDistance) |
-
Gets the End EndCut Distance. (@see CATICkeParm)
Distance from the free edge to position the end cut. Distance should not be greater than flange width.
- Parameters:
-
- oEndEndCutDistance
- EndEndCutDistance
Valuate the End EndCut Distance as per required.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetEndEndCutOffset
public virtual GetEndEndCutOffset( | | oEndEndCutOffset) |
-
Gets the End EndCut Offset. (@see CATICkeParm)
Offset to apply from the extremity of the edge.
Positive offset stretches the flange and negative offset shrinks the flange.
A flange can not extended beyond the limit of the selected edge.
If a user has not applied a limit, then a positive offset would not have impact of the flange result.
- Parameters:
-
- oEndEndCutOffset
- EndEndCutOffset
Valuate the End EndCut Offset as per required.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetEndEndCutRadius
public virtual GetEndEndCutRadius( | | oEndEndCutRadius) |
-
Gets the End EndCut Radius. (@see CATICkeParm)
- Parameters:
-
- oEndEndCutRadius
- EndEndCutRadius
Valuate the End EndCut Radius as per required.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetFlangeEndLimit
public virtual GetFlangeEndLimit( | | oEndLimit) |
-
Gets the Flange End Limit.
- Parameters:
-
- oEndLimit
- EndLimit
Gets the Flange End Limit.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetFlangeStartLimit
public virtual GetFlangeStartLimit( | | oStartLimit) |
-
Gets the Flange Start Limit.
- Parameters:
-
- oStartLimit
- StartLimit
Gets the Flange Start Limit.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetFlangeWidth
public virtual GetFlangeWidth( | | oWidth) |
-
Gets the Flange Width. (@see CATICkeParm)
- Parameters:
-
- oWidth
- Width
Valuate the Flange Width as per required.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetOperatedPlate
public virtual GetOperatedPlate( | | ospOperatedPlate) |
-
Gets the operated plate on which flange is created. Either SfdPlate or SddPlate.
- Parameters:
-
- oOperatedPlate
- Operated Plate
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetStartEndCutAngle
public virtual GetStartEndCutAngle( | | oStartEndCutAngle) |
-
Gets the Start EndCut Angle. (@see CATICkeParm)
Always counted from the vertical edge of the flange.
- Parameters:
-
- oStartEndCutAngle
- StartEndCutAngle
Valuate the Start EndCut Angle as per required.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetStartEndCutDistance
public virtual GetStartEndCutDistance( | | oStartEndCutDistance) |
-
Gets the Start EndCut Distance. (@see CATICkeParm)
Distance from the free edge to position the end cut. Distance should not be greater than flange width.
- Parameters:
-
- oStartEndCutDistance
- StartEndCutDistance
Valuate the Start EndCut Distance as per required.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetStartEndCutOffset
public virtual GetStartEndCutOffset( | | oStartEndCutOffset) |
-
Gets the Start EndCut Offset. (@see CATICkeParm)
Offset to apply from the extremity of the edge.
Positive offset stretches the flange and negative offset shrinks the flange.
A flange can not extended beyond the limit of the selected edge.
If a user has not applied a limit, then a positive offset would not have impact of the flange result.
- Parameters:
-
- oStartEndCutOffset
- StartEndCutOffset
Valuate the Start EndCut Offset as per required.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetStartEndCutRadius
public virtual GetStartEndCutRadius( | | oStartEndCutRadius) |
-
Gets the Start EndCut Radius. (@see CATICkeParm)
- Parameters:
-
- oStartEndCutRadius
- StartEndCutRadius
Valuate the Start EndCut Radius as per required.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetType
public virtual GetType( | | oType) |
-
Gets the Type of flange. (@see CATStrFlangeType)
- Parameters:
-
- oType
- Type
Gets the Flange Type.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o GetWidthMeasurementType
public virtual GetWidthMeasurementType( | | oWidthMeasurementType) |
-
Gets the Width Measurement Type. (@see CATStrFlangeWidthMeasurementType)
- Parameters:
-
- oWidthMeasurementType
- WidthMeasurementType
Gets Flange Width Measurement Type.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o SetEdges
public virtual SetEdges( | const | iListOfLimits) |
-
Sets the Edges for Flange creation.
- Parameters:
-
- iListOfLimits
- iListOfLimits
Sets the Edges.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o SetFlangeEndLimit
public virtual SetFlangeEndLimit( | | iEndLimit) |
-
Sets the Flange End Limit. This section is optional. The user may or may not define limits.
The user can select planes or surfaces to limit the flange.
Those limits should intersect the edge selected to become a limit.
The limits could be Member, Stiffener, StiffenerOnFreeEdge, Plane, Edge or Sketch.
For SfdFlange, limit could be SfdPlate.
For SddFlange, limit could be SddPlate.
- Parameters:
-
- iEndLimit
- EndLimit
Sets the Flange End Limit.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o SetFlangeStartLimit
public virtual SetFlangeStartLimit( | | iStartLimit) |
-
Sets the Flange Start Limit. This section is optional. The user may or may not define limits.
The user can select planes or surfaces to limit the flange.
Those limits should intersect the edge selected to become a limit.
The limits could be Member, Stiffener, StiffenerOnFreeEdge, Plane, Edge or Sketch.
For SfdFlange, limit could be SfdPlate.
For SddFlange, limit could be SddPlate.
- Parameters:
-
- iStartLimit
- StartLimit
Sets the Flange Start Limit.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o SetType
public virtual SetType( | | iType) |
-
Sets the Type of flange. (@see CATStrFlangeType)
- Parameters:
-
- iType
- Type
iType - 1 - Centered
iType - 2 - Tangent
Sets the Flange Type.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o SetWidthMeasurementType
public virtual SetWidthMeasurementType( | | iWidthMeasurementType) |
-
Sets the Width Measurement Type. (@see CATStrFlangeWidthMeasurementType)
- Parameters:
-
- iWidthMeasurementType
- WidthMeasurementType
iWidthMeasurementType - 1 - FlangeWidthToInnerFace
iWidthMeasurementType - 2 - FlangeWidthToOuterFace
iWidthMeasurementType - 3 - FlangeWidthToNeutralFibre (Not implemented)
Sets Flange Width Measurement Type.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
o Update
-
Updates the Flanges Created.
- Returns:
- HRESULT Returns code of function. S_OK if everything ran ok.
This object is included in the file: CATIStrUseFlange.h
If needed, your Imakefile.mk should include the module: CATStrUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.