CATSmaUseItf Interface 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 :

Method Index


o GetBaseFeature(CATIMmiMechanicalFeature**)

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(CATLISTV(CATIMmiMechanicalFeature_var)&)

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(CATLISTV(CATIMmiMechanicalFeature_var)&)

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(CATLISTV(CATIMmiMechanicalFeature_var)&)

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(CATLISTV(CATIMmiMechanicalFeature_var)&)

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

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 GetSurfacicFlanges(CATLISTV(CATIMmiMechanicalFeature_var)&)

Role: This method retrieves the list of Surfacic Flanges of Surfacic Flange.
o SetBaseFeature(CATIMmiMechanicalFeature*)

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(CATLISTV(CATIMmiMechanicalFeature_var)&)

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(CATIMmiMechanicalFeature_var&,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(CATLISTV(CATIMmiMechanicalFeature_var)&)

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(CATLISTV(CATIMmiMechanicalFeature_var)&)

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

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
public virtual GetBaseFeature( opiBaseFeatureSpec)

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
public virtual GetBaseFeatureOrient( oBaseFeatureOrient)

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
public virtual GetBendRadiusType( oBendRadiusType)

Role: This method retrieves the bend radius type of the surfacic flange.
Parameters:
oBendRadiusType
a CATUnicodeString
Legal values:
  • "Constant".
o GetBendRadiusValue
public virtual GetBendRadiusValue( opiBendRadiusValueParam)

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
public virtual GetEOPElements( oEOPElementsList)

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
public virtual GetEOPLength( opiEOPLengthParam)

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
public virtual GetEOPType( oEOPType)

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
public virtual GetFlangeOrient( oFlangeOrient)

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
public virtual GetJoggleCompensation( oCompensation)

Role: This method retrieves if the joggle compensation is set on the surfacic flange.
Parameters:
oCompensation
a CATUnicodeString
Legal values:
  • "None",
  • "Apply",
o GetJoggles
public virtual GetJoggles( oJogglesList)

Role: This methode retrieves the list of joggles of the surfacic flange.
Parameters:
oJogglesList
List of specifications : Joggle(s).
o GetKFactor
public virtual GetKFactor( opiKFactorParam)

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
public virtual GetManufacturingProcessType( oManufProcType)

Role: This method retrieves the manufacturing process type of the surfacic flange.
Parameters:
oManufProcType
a CATUnicodeString
Legal values:
  • "Hydropressed",
  • "BreakFormed".
o GetMaterialOrient
public virtual GetMaterialOrient( oMaterialOrient)

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
public virtual GetSide1CompensationType( oCompensation)

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 GetSide1CompensationValue( oCompensation)

Role: This method retrieves the first side compensation value of the surfacic flange.
Parameters:
oCompensationValue
a double
o GetSide1CornerRadius
public virtual GetSide1CornerRadius( opiCornerRadiusParam)

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
public virtual GetSide1DressUpType( oDressUpType)

Role: This method retrieves the first side Dress-Up type of the surfacic flange.
Parameters:
oDressUpType
a CATUnicodeString
Legal values:
  • "None",
  • "Corner".
o GetSide1Elements
public virtual GetSide1Elements( oSideElementsList)

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
public virtual GetSide1Type( oSideType)

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
public virtual GetSide2CompensationType( oCompensation)

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 GetSide2CompensationValue( oCompensation)

Role: This method retrieves the second side compensation value of the surfacic flange.
Parameters:
oCompensationValue
a double
o GetSide2CornerRadius
public virtual GetSide2CornerRadius( opiCornerRadiusParam)

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
public virtual GetSide2DressUpType( oDressUpType)

Role: This method retrieves the second side Dress-Up type of the surfacic flange.
Parameters:
oDressUpType
a CATUnicodeString
Legal values:
  • "None",
  • "Corner".
o GetSide2Elements
public virtual GetSide2Elements( oSideElementsList)

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
public virtual GetSide2Type( oSideType)

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
public virtual GetSupport( opiSupportSpec)

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
public virtual GetSupportAngle( opiSupportAngleParam)

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
public virtual GetSupportApproxLength( opiApproxLengthParam)

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
public virtual GetSupportLength( opiLengthParam)

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
public virtual GetSupportType( oSupportType)

Role: This method retrieves the support type of the surfacic flange.
Parameters:
oSupportType
a CATUnicodeString
Legal values:
  • "Exact",
  • "Approximation",
  • "Angle".
o GetSurfacicFlanges
public virtual GetSurfacicFlanges( oSurfacicFlangeList)

Role: This method retrieves the list of Surfacic Flanges of Surfacic Flange.
Parameters:
oSurfacicFlangeList
List of specifications : SurfacicFlange(s).
o SetBaseFeature
public virtual SetBaseFeature( const ipiBaseFeatureSpec)

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
public virtual SetBaseFeatureOrient( const iBaseFeatureOrient)

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
public virtual SetBendRadiusType( const iBendRadiusType)

Role: This method sets the bend radius type of the surfacic flange.
Parameters:
iBendRadiusType
a CATUnicodeString
Legal values:
  • "Constant".
o SetEOPElements
public virtual SetEOPElements( const iEOPElementsList)

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
public virtual SetEOPType( const iEOPType)

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
public virtual SetFlangeOrient( const iFlangeOrient)

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
public virtual SetJoggleCompensation( const ispPrtPartSpec,
const iCompensation)

Role: This method sets the joggle compensation of the surfacic flange. !!! The joggle compensation method is defined on the sheet metal parameters.
Parameters:
ispPrtPartSpec
The Part Feature
iCompensation
a CATUnicodeString
Legal values:
  • "None",
  • "Apply",
o SetManufacturingProcessType
public virtual SetManufacturingProcessType( const iManufProcType)

Role: This method sets the manufacturing process type of the surfacic flange.
Parameters:
iManufProcType
a CATUnicodeString
Legal values:
  • "Hydropressed",
  • "BreakFormed".
o SetMaterialOrient
public virtual SetMaterialOrient( const iMaterialOrient)

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
public virtual SetSide1CompensationType( const iCompensation)

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 SetSide1CompensationValue( const iCompensation)

Role: This method valuate the first side compensation value of the surfacic flange.
Parameters:
iCompensationValue
a double
o SetSide1DressUpType
public virtual SetSide1DressUpType( const iDressUpType)

Role: This method sets the first side Dress-Up type of the surfacic flange.
Parameters:
iDressUpType
a CATUnicodeString
Legal values:
  • "None",
  • "Corner".
o SetSide1Elements
public virtual SetSide1Elements( const iSideElementsList)

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
public virtual SetSide1Type( const iSideType)

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
public virtual SetSide2CompensationType( const iCompensation)

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 SetSide2CompensationValue( const iCompensation)

Role: This method valuate the second side compensation value of the surfacic flange.
Parameters:
iCompensationValue
a double
o SetSide2DressUpType
public virtual SetSide2DressUpType( const iDressUpType)

Role: This method sets the second side Dress-Up type of the surfacic flange.
Parameters:
iDressUpType
a CATUnicodeString
Legal values:
  • "None",
  • "Corner".
o SetSide2Elements
public virtual SetSide2Elements( const iSideElementsList)

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
public virtual SetSide2Type( const iSideType)

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
public virtual SetSupport( const ipiSupportSpec)

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
public virtual SetSupportType( const iSupportType)

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

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