All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSmaInterfaces Interface CATIStmFlangeSurf
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIStmFlangeSurf
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIStmFlangeSurf
Interface to manage the aerospace sheet metal surfacic flange feature.
Role: Provides the basic methods to access data of a sheet metal
surfacic flange feature.
A surfacic flange is defined by :
- base feature : the web or another surfacic flange,
- support : a surface or a curve,
- fillet radius : a length,
- edge of part : a curve or a length,
- first side : a curve or a plane,
- first side corner radius : a length,
- second side : a curve or a plane,
- second side corner radius : a length,
- manufacturing process : a parameter,
- joggle compensation : a parameter,
- first side compensation : a parameter,
- second side compensation : a parameter.
Method Index
- o
GetBaseFeature(CATISpecObject**)
-
Role: This method retrieves the base feature of the surfacic flange.
- o
GetBaseFeatureOrient(CATOrientation&)
-
Role: This method retrieves the base feature orientation of the Surfacic Flange,
it defines the base feature side to keep compared to the flange support orientation.
- o
GetBendRadiusType(CATUnicodeString&)
-
Role: This method retrieves the bend radius type of the surfacic flange.
- o
GetBendRadiusValue(CATICkeParm**)
-
Role: This method retrieves the bend radius value of the surfacic flange.
- o
GetEOPElements(CATLISTP(CATISpecObject)&)
-
Role: This methode retrieves the list of elements of the edge of part
if the edge of part type is equal to Element FD or Element FP.
- o
GetEOPLength(CATICkeParm**)
-
Role: This methode retrieves the length of the edge of part of the surfacic flange
if the edge of part type is equal to Length from OML.
- o
GetEOPType(CATUnicodeString&)
-
Role: This method retrieves the edge of part type of the surfacic flange.
- o
GetFlangeOrient(CATOrientation&)
-
Role: This method retrieves the flange orientation of the Surfacic Flange,
it defines the fillet orientation compared to the base feature support orientation.
- o
GetJoggleCompensation(CATUnicodeString&)
-
Role: This method retrieves if the joggle compensation is set on the surfacic flange.
- o
GetJoggles(CATLISTP(CATISpecObject)&)
-
Role: This methode retrieves the list of joggles of the surfacic flange.
- o
GetKFactor(CATICkeParm**)
-
Role: This method retrieves the K_Factor associated to the fillet of the surfacic flange.
- o
GetManufacturingProcessType(CATUnicodeString&)
-
Role: This method retrieves the manufacturing process type of the surfacic flange.
- o
GetMaterialOrient(CATOrientation&)
-
Role: This method retrieves the material orientation of the surfacic flange.
- o
GetSide1CompensationType(CATUnicodeString&)
-
Role: This method retrieves the first side compensation of the surfacic flange.
- o
GetSide1CompensationValue(double&)
-
Role: This method retrieves the first side compensation value of the surfacic flange.
- o
GetSide1CornerRadius(CATICkeParm**)
-
Role: This method retrieves the first side corner value of the surfacic flange
if its DressUp type is equal to Corner.
- o
GetSide1DressUpType(CATUnicodeString&)
-
Role: This method retrieves the first side Dress-Up type of the surfacic flange.
- o
GetSide1Elements(CATLISTP(CATISpecObject)&)
-
Role: This method retrieves the first side elements of the surfacic flange
if it's type is equal to Element FD or Element FD.
- o
GetSide1Type(CATUnicodeString&)
-
Role: This method retrieves the first side type of the surfacic flange.
- o
GetSide2CompensationType(CATUnicodeString&)
-
Role: This method retrieves the second side compensation of the surfacic flange.
- o
GetSide2CompensationValue(double&)
-
Role: This method retrieves the second side compensation value of the surfacic flange.
- o
GetSide2CornerRadius(CATICkeParm**)
-
Role: This method retrieves the second side corner value of the surfacic flange
if its Dress-Up type is equal to Corner.
- o
GetSide2DressUpType(CATUnicodeString&)
-
Role: This method retrieves the second side Dress-Up type of the surfacic flange.
- o
GetSide2Elements(CATLISTP(CATISpecObject)&)
-
Role: This method retrieves the second side elements of the surfacic flange
if it's type is equal to Element FD or Element FD.
- o
GetSide2Type(CATUnicodeString&)
-
Role: This method retrieves the second side type of the surfacic flange.
- o
GetSupport(CATISpecObject**)
-
Role: This method retrieves the support of the surfacic flange.
- o
GetSupportAngle(CATICkeParm**)
-
Role: This method retrieves the Angle of the support and the base feature support
if Support type is equal to Angle.
- o
GetSupportApproxLength(CATICkeParm**)
-
Role: This method retrieves the approximate length of the surfacic flange
if Support type is equal to Approximation.
- o
GetSupportLength(CATICkeParm**)
-
Role: This method is usefull to limit the support of the surfacic flange
if the support type is "Angle" or "Exact".
- o
GetSupportType(CATUnicodeString&)
-
Role: This method retrieves the support type of the surfacic flange.
- o
SetBaseFeature(CATISpecObject*)
-
Role: This method sets the base feature of the surfacic flange.
- o
SetBaseFeatureOrient(CATOrientation&)
-
Role: This method sets the base feature orientation of the Surfacic Flange,
it defines the base feature side to keep compared to the flange support orientation.
- o
SetBendRadiusType(CATUnicodeString&)
-
Role: This method sets the bend radius type of the surfacic flange.
- o
SetEOPElements(CATLISTP(CATISpecObject)&)
-
Role: This methode sets the list of elements of the edge of part
if the edge of part type is equal to Element FD or Element FP.
- o
SetEOPType(CATUnicodeString&)
-
Role: This method sets the edge of part type of the surfacic flange.
- o
SetFlangeOrient(CATOrientation&)
-
Role: This method sets the flange orientation of the Surfacic Flange,
it defines the fillet orientation compared to the base feature support orientation.
- o
SetJoggleCompensation(CATISpecObject*,CATUnicodeString&)
-
Role: This method sets the joggle compensation of the surfacic flange.
- o
SetManufacturingProcessType(CATUnicodeString&)
-
Role: This method sets the manufacturing process type of the surfacic flange.
- o
SetMaterialOrient(CATOrientation&)
-
Role: This method sets the material orientation of the surfacic flange.
- o
SetSide1CompensationType(CATUnicodeString&)
-
Role: This method sets the first side compensation of the surfacic flange.
- o
SetSide1CompensationValue(double&)
-
Role: This method valuate the first side compensation value of the surfacic flange.
- o
SetSide1DressUpType(CATUnicodeString&)
-
Role: This method sets the first side Dress-Up type of the surfacic flange.
- o
SetSide1Elements(CATLISTP(CATISpecObject)&)
-
Role: This method sets the first side elements of the surfacic flange
if it's type is equal to Element FD or Element FD.
- o
SetSide1Type(CATUnicodeString&)
-
Role: This method sets the first side type of the surfacic flange.
- o
SetSide2CompensationType(CATUnicodeString&)
-
Role: This method sets the second side compensation of the surfacic flange.
- o
SetSide2CompensationValue(double&)
-
Role: This method valuate the second side compensation value of the surfacic flange.
- o
SetSide2DressUpType(CATUnicodeString&)
-
Role: This method sets the second side Dress-Up type of the surfacic flange.
- o
SetSide2Elements(CATLISTP(CATISpecObject)&)
-
Role: This method sets the second side elements of the surfacic flange
if it's type is equal to Element FD or Element FD.
- o
SetSide2Type(CATUnicodeString&)
-
Role: This method sets the second side type of the surfacic flange.
- o
SetSupport(CATISpecObject*)
-
Role: This method sets the support of the surfacic flange.
- o
SetSupportType(CATUnicodeString&)
-
Role: This method sets the support type of the surfacic flange.
Methods
o GetBaseFeature
-
Role: This method retrieves the base feature of the surfacic flange.
- Parameters:
-
- opiBaseFeatureSpec
- Specification of the base feature
Legal values:
- the web,
- another surfacic flange.
o GetBaseFeatureOrient
-
Role: This method retrieves the base feature orientation of the Surfacic Flange,
it defines the base feature side to keep compared to the flange support orientation.
- Parameters:
-
- oBaseFeatureOrient
- A reference to a CATOrientation instance.
Legal values:
- CATOrientationNegative: The base feature side to keep is opposite to the flange support orientation,
- CATOrientationPositive: The base feature side to keep is same as the flange support orientation,
- CATOrientationUnknown : The orientation is unknown.
o GetBendRadiusType
-
Role: This method retrieves the bend radius type of the surfacic flange.
- Parameters:
-
- oBendRadiusType
- a CATUnicodeString
Legal values:
o GetBendRadiusValue
-
Role: This method retrieves the bend radius value of the surfacic flange.
- Parameters:
-
- opiBendRadiusValueParam
- a CATICkeParm : use the method Valuate to modify the bend radius value. @see CATICkeParm.
o GetEOPElements
-
Role: This methode retrieves the list of elements of the edge of part
if the edge of part type is equal to Element FD or Element FP.
- Parameters:
-
- oEOPElementsList
- List of specifications : curves or opened sketchs.
o GetEOPLength
-
Role: This methode retrieves the length of the edge of part of the surfacic flange
if the edge of part type is equal to Length from OML.
- Parameters:
-
- opiEOPLengthParam
- a CATICkeParm : use the method Valuate to modify the Length From OML value. @see CATICkeParm.
o GetEOPType
-
Role: This method retrieves the edge of part type of the surfacic flange.
- Parameters:
-
- oEOPType
- a CATUnicodeString
Legal values:
- "Length From OML",
- "Element FD",
- "Element FP".
o GetFlangeOrient
-
Role: This method retrieves the flange orientation of the Surfacic Flange,
it defines the fillet orientation compared to the base feature support orientation.
- Parameters:
-
- oFlangeOrient
- A reference to a CATOrientation instance.
Legal values:
- CATOrientationNegative: The fillet and the base feature support orientations are opposite,
- CATOrientationPositive: The fillet and the base feature support orientations are the same,
- CATOrientationUnknown : The orientation is unknown.
o GetJoggleCompensation
-
Role: This method retrieves if the joggle compensation is set on the surfacic flange.
- Parameters:
-
- oCompensation
- a CATUnicodeString
Legal values:
o GetJoggles
-
Role: This methode retrieves the list of joggles of the surfacic flange.
- Parameters:
-
- oJogglesList
- List of specifications : Joggle(s).
o GetKFactor
-
Role: This method retrieves the K_Factor associated to the fillet of the surfacic flange.
- Parameters:
-
- opiKFactorParam
- a CATICkeParm : use the method Valuate to modify the K_Factor value. @see CATICkeParm.
o GetManufacturingProcessType
-
Role: This method retrieves the manufacturing process type of the surfacic flange.
- Parameters:
-
- oManufProcType
- a CATUnicodeString
Legal values:
- "Hydropressed",
- "BreakFormed".
o GetMaterialOrient
-
Role: This method retrieves the material orientation of the surfacic flange.
It defines the thickness direction compared to the surfacic flange support orientation.
- Parameters:
-
- oMaterialOrient
- A reference to a CATOrientation instance.
Legal values:
- CATOrientationNegative: The thickness and the surfacic flange support orientations are opposite,
- CATOrientationPositive: The thickness and the surfacic flange support orientations are the same,
- CATOrientationUnknown : The orientation is unknown.
o GetSide1CompensationType
-
Role: This method retrieves the first side compensation of the surfacic flange.
- Parameters:
-
- oCompensation
- a CATUnicodeString
Legal values:
- "None",
- "Automatic",
- "Angle",
- "Length".
o GetSide1CompensationValue
public virtual HRESULT __stdcall GetSide1CompensationValue( | double& | oCompensation) = 0 |
-
Role: This method retrieves the first side compensation value of the surfacic flange.
- Parameters:
-
- oCompensationValue
- a double
o GetSide1CornerRadius
-
Role: This method retrieves the first side corner value of the surfacic flange
if its DressUp type is equal to Corner.
- Parameters:
-
- opiCornerRadiusParam
- a CATICkeParm : use the method Valuate to modify the first side corner radius value. @see CATICkeParm.
o GetSide1DressUpType
-
Role: This method retrieves the first side Dress-Up type of the surfacic flange.
- Parameters:
-
- oDressUpType
- a CATUnicodeString
Legal values:
o GetSide1Elements
-
Role: This method retrieves the first side elements of the surfacic flange
if it's type is equal to Element FD or Element FD.
- Parameters:
-
- oSideElementsList
- List of specifications : curve(s) or opened sketch(s) or plane(s).
o GetSide1Type
-
Role: This method retrieves the first side type of the surfacic flange.
- Parameters:
-
- oSideType
- a CATUnicodeString
Legal values:
- "Standard",
- "None",
- "Element FD",
- "Element FP".
o GetSide2CompensationType
-
Role: This method retrieves the second side compensation of the surfacic flange.
- Parameters:
-
- oCompensation
- a CATUnicodeString
Legal values:
- "None",
- "Automatic",
- "Angle",
- "Length".
o GetSide2CompensationValue
public virtual HRESULT __stdcall GetSide2CompensationValue( | double& | oCompensation) = 0 |
-
Role: This method retrieves the second side compensation value of the surfacic flange.
- Parameters:
-
- oCompensationValue
- a double
o GetSide2CornerRadius
-
Role: This method retrieves the second side corner value of the surfacic flange
if its Dress-Up type is equal to Corner.
- Parameters:
-
- opiCornerRadiusParam
- a CATICkeParm : use the method Valuate to modify the first side corner radius value. @see CATICkeParm.
o GetSide2DressUpType
-
Role: This method retrieves the second side Dress-Up type of the surfacic flange.
- Parameters:
-
- oDressUpType
- a CATUnicodeString
Legal values:
o GetSide2Elements
-
Role: This method retrieves the second side elements of the surfacic flange
if it's type is equal to Element FD or Element FD.
- Parameters:
-
- oSideElementsList
- List of specifications : curve(s) or opened sketch(s) or plane(s).
o GetSide2Type
-
Role: This method retrieves the second side type of the surfacic flange.
- Parameters:
-
- oSideType
- a CATUnicodeString
Legal values:
- "Standard",
- "None",
- "Element FD",
- "Element FP".
o GetSupport
-
Role: This method retrieves the support of the surfacic flange.
- Parameters:
-
- opiSupportSpec
- Specification of the support
Legal values:
- a surface (if support type is different from "Angle"),
- a curve (if support type is equal to "Angle").
o GetSupportAngle
-
Role: This method retrieves the Angle of the support and the base feature support
if Support type is equal to Angle.
- Parameters:
-
- opiSupportAngleParam
- a CATICkeParm : use the method Valuate to modify the bend radius value. @see CATICkeParm.
o GetSupportApproxLength
-
Role: This method retrieves the approximate length of the surfacic flange
if Support type is equal to Approximation.
- Parameters:
-
- opiApproxLengthParam
- a CATICkeParm : Do not modify this value.
o GetSupportLength
-
Role: This method is usefull to limit the support of the surfacic flange
if the support type is "Angle" or "Exact".
- Parameters:
-
- opiLengthParam
- a CATICkeParm : use the method Valuate to modify the support length value. @see CATICkeParm.
o GetSupportType
-
Role: This method retrieves the support type of the surfacic flange.
- Parameters:
-
- oSupportType
- a CATUnicodeString
Legal values:
- "Exact",
- "Approximation",
- "Angle".
o SetBaseFeature
-
Role: This method sets the base feature of the surfacic flange.
- Parameters:
-
- ipiBaseFeatureSpec
- Specification of the base feature
Legal values:
- the web,
- another surfacic flange.
o SetBaseFeatureOrient
-
Role: This method sets the base feature orientation of the Surfacic Flange,
it defines the base feature side to keep compared to the flange support orientation.
- Parameters:
-
- iBaseFeatureOrient
- A reference to a CATOrientation instance.
Legal values:
- CATOrientationNegative: The base feature side to keep is opposite to the flange support orientation,
- CATOrientationPositive: The base feature side to keep is same as the flange support orientation,
- CATOrientationUnknown : The orientation is unknown.
o SetBendRadiusType
-
Role: This method sets the bend radius type of the surfacic flange.
- Parameters:
-
- iBendRadiusType
- a CATUnicodeString
Legal values:
o SetEOPElements
-
Role: This methode sets the list of elements of the edge of part
if the edge of part type is equal to Element FD or Element FP.
- Parameters:
-
- iEOPElementsList
- List of specifications : curves or opened sketchs.
o SetEOPType
-
Role: This method sets the edge of part type of the surfacic flange.
- Parameters:
-
- iEOPType
- a CATUnicodeString
Legal values:
- "Length From OML",
- "Element FD",
- "Element FP".
o SetFlangeOrient
-
Role: This method sets the flange orientation of the Surfacic Flange,
it defines the fillet orientation compared to the base feature support orientation.
- Parameters:
-
- iFlangeOrient
- A reference to a CATOrientation instance.
Legal values:
- CATOrientationNegative: The fillet and the base feature support orientations are opposite,
- CATOrientationPositive: The fillet and the base feature support orientations are the same,
- CATOrientationUnknown : The orientation is unknown.
o SetJoggleCompensation
-
Role: This method sets the joggle compensation of the surfacic flange.
!!! The joggle compensation method is defined on the sheet metal parameters.
- Parameters:
-
- ipiPrtPartSpec
- The Part Feature
- iCompensation
- a CATUnicodeString
Legal values:
o SetManufacturingProcessType
-
Role: This method sets the manufacturing process type of the surfacic flange.
- Parameters:
-
- iManufProcType
- a CATUnicodeString
Legal values:
- "Hydropressed",
- "BreakFormed".
o SetMaterialOrient
-
Role: This method sets the material orientation of the surfacic flange.
It defines the thickness direction compared to the surfacic flange support orientation.
- Parameters:
-
- iMaterialOrient
- A reference to a CATOrientation instance.
Legal values:
- CATOrientationNegative: The thickness and the surfacic flange support orientations are opposite,
- CATOrientationPositive: The thickness and the surfacic flange support orientations are the same,
- CATOrientationUnknown : The orientation is unknown.
o SetSide1CompensationType
-
Role: This method sets the first side compensation of the surfacic flange.
- Parameters:
-
- iCompensation
- a CATUnicodeString
Legal values:
- "None",
- "Automatic",
- "Angle",
- "Length".
o SetSide1CompensationValue
public virtual HRESULT __stdcall SetSide1CompensationValue( | const double& | iCompensation) = 0 |
-
Role: This method valuate the first side compensation value of the surfacic flange.
- Parameters:
-
- iCompensationValue
- a double
o SetSide1DressUpType
-
Role: This method sets the first side Dress-Up type of the surfacic flange.
- Parameters:
-
- iDressUpType
- a CATUnicodeString
Legal values:
o SetSide1Elements
-
Role: This method sets the first side elements of the surfacic flange
if it's type is equal to Element FD or Element FD.
- Parameters:
-
- iSideElementsList
- List of specifications : curve(s) or opened sketch(s) or plane(s).
o SetSide1Type
-
Role: This method sets the first side type of the surfacic flange.
- Parameters:
-
- iSideType
- a CATUnicodeString
Legal values:
- "Standard",
- "None",
- "Element FD",
- "Element FP".
o SetSide2CompensationType
-
Role: This method sets the second side compensation of the surfacic flange.
- Parameters:
-
- iCompensation
- a CATUnicodeString
Legal values:
- "None",
- "Automatic",
- "Angle",
- "Length".
o SetSide2CompensationValue
public virtual HRESULT __stdcall SetSide2CompensationValue( | const double& | iCompensation) = 0 |
-
Role: This method valuate the second side compensation value of the surfacic flange.
- Parameters:
-
- iCompensationValue
- a double
o SetSide2DressUpType
-
Role: This method sets the second side Dress-Up type of the surfacic flange.
- Parameters:
-
- iDressUpType
- a CATUnicodeString
Legal values:
o SetSide2Elements
-
Role: This method sets the second side elements of the surfacic flange
if it's type is equal to Element FD or Element FD.
- Parameters:
-
- iSideElementsList
- List of specifications : curve(s) or opened sketch(s) or plane(s).
o SetSide2Type
-
Role: This method sets the second side type of the surfacic flange.
- Parameters:
-
- iSideType
- a CATUnicodeString
Legal values:
- "Standard",
- "None",
- "Element FD",
- "Element FP".
o SetSupport
-
Role: This method sets the support of the surfacic flange.
- Parameters:
-
- ipiSupportSpec
- Specification of the support
Legal values:
- a surface (if support type is different from "Angle"),
- a curve (if support type is equal to "Angle").
o SetSupportType
-
Role: This method sets the support type of the surfacic flange.
- Parameters:
-
- iSupportType
- a CATUnicodeString
Legal values:
- "Exact",
- "Approximation",
- "Angle".
This object is included in the file: CATIStmFlangeSurf.h
If needed, your Imakefile.mk should include the module: CATSmaInterfaces