All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseSweepSegment

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

interface CATIGSMUseSweepSegment

Interface to linear sweep feature.
Role: Allows you to access (query and modifications) data of the linear sweep.

See also:

Method Index

o AddDraftAngleDefinitionLocation(CATIMmiMechanicalFeature_var&,CATICkeParm_var&): Adds a geometrical element and a value necessary for draft angle definition.
o DelAngle(): Removes all angles.
o DelGuideCrv(): Removes all guide curves.
o DelGuideSurf(): Removes all guide surfaces.
o DelLength(): Removes all lengths.
o GetAngle(double&,int): Gets the value of an angle given its index.
o GetAngle(CATICkeParm_var&,int): Gets the literal feature representing an angle given its index.
o GetAngularLaw(CATICkeLaw_var&): Gets angular law feature.
o GetAngularLaw(CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType&): Gets information about angular law.
o GetAngularLawInversion(CATBoolean&): Gets information whether angular law has to be inverted or not.
o GetAngularLawType(enum CATGSMBasicLawType&): Gets angular law type.
o GetCanonicalDetectionMode(CATGSMCanonicalSurfaceDetection&): Gets information about detection of canonical surfaces of the output surface.
o GetChoiceNo(int&,int&,int&): Gets a sequence which identifies a solution amongst all possibilities of a line-profile swept surface, case CATGSMLinearSweep_GuideAndTangencySurface.
o GetChoiceNoSurfaces(int&,int&,int&,int&,int&): Gets a sequence which identifies a solution amongst all possibilities of a line-profile swept surface, case CATGSMLinearSweep_TwoTangencySurfaces.
o GetContext(CATGSMFeatureContextType&): Gets the context of the Sweep.
o GetDraftAngleDefinitionLocations(CATListValCATIMmiMechanicalFeature_var&,CATListValCATBaseUnknown_var&): Gets geometrical elements and values necessary for draft angle definition.
o GetDraftComputationMode(enum CATGSMLinearDraftSweepComp&): Gets linear swept surface with draft direction computation mode: CATGSMLinearDraftSweepComp_Square for square, CATGSMLinearDraftSweepComp_ConeEnvelop for cone envelop.
o GetDraftDirection(CATIGSMUseDirection_var&): Gets draft direction.
o GetFirstLengthDefinitionType(enum CATGSMLinearSweepLengthType&,CATIMmiMechanicalFeature_var&): Gets first length definition for linear swept surfaces (for draft surfaces only, so far).
o GetGuideCrv(CATIMmiMechanicalFeature_var&): Gets first guide curve.
o GetGuideCrv(CATIMmiMechanicalFeature_var&,int): Gets a guide curve given its index.
o GetGuideDeviation(double&): Gets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
o GetGuideDeviation(CATICkeParm_var&): Gets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
o GetGuideDeviationActivity(CATBoolean&): Gets information whether a deviation from guide curves is allowed or not during sweeping operation in order to smooth it.
o GetGuideSurf(CATIMmiMechanicalFeature_var&): Gets first guide surface.
o GetGuideSurf(CATIMmiMechanicalFeature_var&,int): Gets a guide surface given its index.
o GetLength(double&,int): Gets the value of a length given its index.
o GetLength(CATICkeParm_var&,int): Gets the literal feature representing an length given its index.
o GetLengthLawInversions(CATBoolean&,CATBoolean&): Gets information whether length laws have to be inverted or not.
o GetLengthLawTypes(enum CATGSMBasicLawType&,enum CATGSMBasicLawType&): Gets length law types.
o GetLengthLaws(CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType&,CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType&): Gets information about both length laws.
o GetLengthLaws(CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&,enum CATGSMBasicLawType&,CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&,enum CATGSMBasicLawType&): Gets information about both length laws (including advanced law features).
o GetLongitudinalRelimiters(CATIMmiMechanicalFeature_var&,CATBoolean&,CATIMmiMechanicalFeature_var&,CATBoolean&): Gets the elements relimiting the spine (or the default spine).
o GetMode(enum CATGSMLinearSweepCase&): Gets linear sweep case number (also called mode).
o GetNbAngle(int&): Gets the number of angles.
o GetNbGuideCrv(int&): Gets the number of guide curves.
o GetNbGuideSurf(int&): Gets the number of guide surfaces.
o GetNbLength(int&): Gets the number of lengths.
o GetSecondLengthDefinitionType(enum CATGSMLinearSweepLengthType&,CATIMmiMechanicalFeature_var&): Gets second length definition for linear swept surfaces (for draft surfaces only, so far).
o GetSmoothActivity(CATBoolean&): Gets information whether sweeping operation is smoothed or not.
o GetSmoothAngleThreshold(double&): Gets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
o GetSmoothAngleThreshold(CATICkeParm_var&): Gets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
o GetSolutionNo(int&): Gets the current solution number of the four possible solutions.
o GetSpine(CATIMmiMechanicalFeature_var&): Gets the spine.
o GetTrimOption(enum CATGSMSweepTrimMode&): Gets trim option status for the first (or only) tangency surface.
o GetTrimOptions(enum CATGSMSweepTrimMode&,enum CATGSMSweepTrimMode&): Gets trim option statuses for both tangency surfaces.
o InsertDraftAngleDefinitionLocationAfterPos(CATIMmiMechanicalFeature_var&,CATICkeParm_var&,int): Inserts a geometrical element and a value necessary for draft angle definition after a given position in the lists.
o InsertDraftAngleDefinitionLocationBeforePos(CATIMmiMechanicalFeature_var&,CATICkeParm_var&,int): Inserts a geometrical element and a value necessary for draft angle definition before a given position in the lists.
o RemoveAllDraftAngleDefinitionLocations(): Removes all geometrical elements and values necessary for draft angle definition.
o RemoveDraftAngleDefinitionLocationPosition(int): Removes a geometrical element and a value necessary for draft angle definition at a given position in the lists.
o SetAngle(double,int): Sets the value of an angle given its index.
o SetAngle(CATICkeParm_var,int): Sets the literal feature representing an angle given its index.
o SetAngularLaw(CATICkeLaw_var&): Sets angular law feature.
o SetAngularLaw(CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType): Sets information about angular law.
o SetAngularLawInversion(CATBoolean): Sets information whether angular law has to be inverted or not.
o SetAngularLawType(enum CATGSMBasicLawType): Sets angular law type.
o SetCanonicalDetectionMode(CATGSMCanonicalSurfaceDetection): Sets information about detection of canonical surfaces of the output surface.
o SetChoiceNo(int,int,int): Sets a sequence which identifies a solution (see above), case CATGSMLinearSweep_GuideAndTangencySurface.
o SetChoiceNoSurfaces(int,int,int,int,int): Sets a sequence which identifies a solution (see above), case CATGSMLinearSweep_TwoTangencySurfaces.
o SetContext(CATGSMFeatureContextType): Sets the context of the Sweep.
o SetDraftComputationMode(enum CATGSMLinearDraftSweepComp): Sets linear swept surface with draft direction computation mode: CATGSMLinearDraftSweepComp_Square for square, CATGSMLinearDraftSweepComp_ConeEnvelop for cone envelop.
o SetDraftDirection(CATIGSMUseDirection_var&): Sets draft direction.
o SetFirstLengthDefinitionType(enum CATGSMLinearSweepLengthType,CATIMmiMechanicalFeature_var&): Sets first length definition for linear swept surfaces (for draft surfaces only, so far).
o SetGuideCrv(CATIMmiMechanicalFeature_var): Modify first guide curve.
o SetGuideCrv(CATIMmiMechanicalFeature_var,int): Sets a guide curve given its index.
o SetGuideDeviation(double): Sets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
o SetGuideDeviation(CATICkeParm_var&): Sets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
o SetGuideDeviationActivity(CATBoolean): Sets information whether a deviation from guide curves is allowed or not during sweeping operation in order to smooth it.
o SetGuideSurf(CATIMmiMechanicalFeature_var): Sets first guide surface.
o SetGuideSurf(CATIMmiMechanicalFeature_var,int): Sets a guide surface given its index.
o SetLength(double,int): Sets the value of a length given its index.
o SetLength(CATICkeParm_var,int): Sets the literal feature representing an length given its index.
o SetLengthLawInversions(CATBoolean,CATBoolean): Sets information whether length laws have to be inverted or not.
o SetLengthLawTypes(enum CATGSMBasicLawType,enum CATGSMBasicLawType): Sets length law types.
o SetLengthLaws(CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType,CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType): Sets information about both length laws.
o SetLengthLaws(CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&,enum CATGSMBasicLawType,CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&,enum CATGSMBasicLawType): Sets information about both length laws (including advanced law features).
o SetLongitudinalRelimiters(CATIMmiMechanicalFeature_var&,CATBoolean,CATIMmiMechanicalFeature_var&,CATBoolean): Sets the elements relimiting the spine (or the default spine).
o SetMode(enum CATGSMLinearSweepCase): Sets linear sweep case number.
o SetSecondLengthDefinitionType(enum CATGSMLinearSweepLengthType,CATIMmiMechanicalFeature_var&): Sets second length definition for linear swept surfaces (for draft surfaces only, so far).
o SetSmoothActivity(CATBoolean): Sets information whether sweeping operation is smoothed or not.
o SetSmoothAngleThreshold(double): Sets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
o SetSmoothAngleThreshold(CATICkeParm_var&): Sets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
o SetSolutionNo(int): Sets the current solution number of the four possible solutions.
o SetSpine(CATIMmiMechanicalFeature_var): Sets the spine.
o SetTrimOption(enum CATGSMSweepTrimMode): Sets trim option status for the first (or only) tangency surface.
o SetTrimOptions(enum CATGSMSweepTrimMode,enum CATGSMSweepTrimMode): Sets trim option statuses for both tangency surfaces.

Methods

o AddDraftAngleDefinitionLocation

public virtual AddDraftAngleDefinitionLocation(	const	`iLoc`,
	const	`iVal`)

Adds a geometrical element and a value necessary for draft angle definition.

Parameters:

iLoc: Geometrical element
iVal: Angular parameter

o DelAngle

public virtual DelAngle(

)

Removes all angles.

o DelGuideCrv

public virtual DelGuideCrv(

)

Removes all guide curves.

o DelGuideSurf

public virtual DelGuideSurf(

)

Removes all guide surfaces.

o DelLength

public virtual DelLength(

)

Removes all lengths.

o GetAngle

public virtual GetAngle(		`oElem`,
	const	`iI`)

Gets the value of an angle given its index.

Parameters:

oElem: Angle value
iI: Index of the angle (starting from one)

o GetAngle

public virtual GetAngle(		`oElem`,
	const	`iI`)

Gets the literal feature representing an angle given its index.

Parameters:

oElem: Angle literal feature
iI: Index of the angle (starting from one)

See also:

o GetAngularLaw

public virtual GetAngularLaw( Elem)

Gets angular law feature.

Parameters:

Elem: Angular law feature

See also:

o GetAngularLaw

public virtual GetAngularLaw(		`ParamStart`,
		`ParamEnd`,
		`eType`)

Gets information about angular law.

Parameters:

ParamStart: Start angle literal feature
ParamEnd: End angle literal feature
eType: Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.

See also:

o GetAngularLawInversion

public virtual GetAngularLawInversion( oInversion)

Gets information whether angular law has to be inverted or not.

Parameters:

oInversion: TRUE or FALSE (FALSE if not specified).

See also:

o GetAngularLawType

public virtual GetAngularLawType( eType)

Gets angular law type.

Parameters:

eType: Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.

See also:

o GetCanonicalDetectionMode

public virtual GetCanonicalDetectionMode( oDetection)

Gets information about detection of canonical surfaces of the output surface.

Parameters:

oDetection: If canonical surfaces are detected. Possible values are CATGSMNoDetection and CATGSMCanonicalDetection.

See also:

o GetChoiceNo

public virtual GetChoiceNo(		`oSurfOri`,
		`oCrvOri`,
		`oNo`)

Gets a sequence which identifies a solution amongst all possibilities of a line-profile swept surface, case CATGSMLinearSweep_GuideAndTangencySurface.

Parameters:

oSurfOri: This orientation determines the location of the results with regard to the surface. Possible values are:
* +1 : the result is in the semi-space defined by the normal to the surface,
* -1 : the result is in the semi-space defined by the opposite to the normal to the surface,
* 0 : no orientation is specified, all the results are output,
* 2 : the result changes of semi-space along the spine.
oCrvOri: This orientation determines the location of the results with regard to the guide curve (CATGSMLinearSweep_GuideAndTangencySurface); let's define a trihedron with the guide curve, the normal to the surface and the tangent to the linear profile, then possible values are:
* +1 : the result is such that the triedron is counter clockwise,
* -1 : the result is such that the triedron is clockwise,
* 0 : no orientation is specified, all the results are output,
* 2 : the orientation of the trihedron changes along the spine.
oNo: Given the previous orientations, solution number in a distance ordered list.

o GetChoiceNoSurfaces

public virtual GetChoiceNoSurfaces(		`oSurfOri1`,
		`oSurfOri2`,
		`oSurfCouplOri1`,
		`oSurfCouplOri2`,
		`oNo`)

Gets a sequence which identifies a solution amongst all possibilities of a line-profile swept surface, case CATGSMLinearSweep_TwoTangencySurfaces.

Parameters:

oSurfOri1: This orientation determines the location of the results with regard to the first surface. Possible values are:
* +1 : the result is in the semi-space defined by the normal to the surface,
* -1 : the result is in the semi-space defined by the opposite to the normal to the ,
* 0 : no orientation is specified, all the results are output,
* 2 : the result changes of semi-space along the spine.
oSurfOri2: This orientation determines the location of the results with regard to the second surface.
oSurfCouplOri1: This orientation determines the location of the results with regard to the triedron defined by the the spine, the normal to the first surface and the tangent to the linear profile. Possible values are:
* +1 : the output results are such that the triedron is counter clockwise,
* -1 : the output results are such that the triedron is clockwise,
* 0 : no orientation is specified, all the results are output,
* 2 : the orientation of the trihedron changes along the spine.
oSurfCouplOri2: This orientation determines the location of the results with regard to the triedron defined by the the spine, the normal to the second surface and the tangent to the linear profile.
oNo: Given the previous orientations, solution number in a distance ordered list.

o GetContext

public virtual GetContext( oContext)

Gets the context of the Sweep.

Parameters:

oContextType: CATGSMSurfaceCtxt if the result is surface, CATGSMVolumeCtxt if it is volume

See also:

o GetDraftAngleDefinitionLocations

public virtual GetDraftAngleDefinitionLocations(		`oListLoc`,
		`oListVal`)

Gets geometrical elements and values necessary for draft angle definition. There can be three possibilities: 1) a list of curves and a list of angular parameters (case: constant angles by G1 section), 2) a list of points and a list of angular parameters (case: variable angle with given values at given points), 3) no geometry and only one angular parameter for the whole sweeping operation.

Parameters:

oListLoc: List of geometrical elements
oListVal: List of angular parameters

o GetDraftComputationMode

public virtual GetDraftComputationMode( oElem)

Gets linear swept surface with draft direction computation mode: CATGSMLinearDraftSweepComp_Square for square, CATGSMLinearDraftSweepComp_ConeEnvelop for cone envelop.

Parameters:

oElem: Computation mode

o GetDraftDirection

public virtual GetDraftDirection( oElem)

Gets draft direction.

Parameters:

oElem: Direction feature

o GetFirstLengthDefinitionType

public virtual GetFirstLengthDefinitionType(		`oType`,
		`oElem`)

Gets first length definition for linear swept surfaces (for draft surfaces only, so far).

Parameters:

oElem: CATGSMLinearSweepLengthType_None: undefined length type,
CATGSMLinearSweepLengthType_Standard: length of the swept line in the sweeping plane from guide curve,
CATGSMLinearSweepLengthType_FromCurve: no numerical value is required, equivalent to standard length at zero,
CATGSMLinearSweepLengthType_Reference: up to or from a geometrical reference (a surface),
CATGSMLinearSweepLengthType_FromExtremum: only for draft surfaces, length computed in the draft direction from an extremum point on the guide curve (available from V5R8SP3),
CATGSMLinearSweepLengthType_AlongSurface: only for draft surfaces, length will be used in a way similar to euclidean parallel curve distance on the swept surface (available from V5R11)

o GetGuideCrv

public virtual GetGuideCrv( oElem)

Gets first guide curve.

Parameters:

oElem: First guide curve feature.

o GetGuideCrv

public virtual GetGuideCrv(		`oElem`,
	const	`iI`)

Gets a guide curve given its index.

Parameters:

oElem: Guide curve feature.
iI: Guide curve index : 1 or 2

o GetGuideDeviation

public virtual GetGuideDeviation( oElem)

Gets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.

Parameters:

oElem: Numerical value.

o GetGuideDeviation

public virtual GetGuideDeviation( oElem)

Gets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.

Parameters:

oElem: Length literal feature.

o GetGuideDeviationActivity

public virtual GetGuideDeviationActivity( oActi)

Gets information whether a deviation from guide curves is allowed or not during sweeping operation in order to smooth it.

Parameters:

oSmooth: TRUE or FALSE (FALSE if not specified).

o GetGuideSurf

public virtual GetGuideSurf( oElem)

Gets first guide surface.

Parameters:

oElem: First guide surface feature.

o GetGuideSurf

public virtual GetGuideSurf(		`oElem`,
	const	`iI`)

Gets a guide surface given its index.

Parameters:

oElem: Guide surface feature.
iI: Guide surface index : 1 or 2

o GetLength

public virtual GetLength(		`oElem`,
	const	`iI`)

Gets the value of a length given its index.

Parameters:

oElem: Length value
iI: Index of the length (starting from one)

o GetLength

public virtual GetLength(		`oElem`,
	const	`iI`)

Gets the literal feature representing an length given its index.

Parameters:

oElem: Length literal feature
iI: Index of the length (starting from one)

See also:

o GetLengthLawInversions

public virtual GetLengthLawInversions(		`oInversion1`,
		`oInversion2`)

Gets information whether length laws have to be inverted or not.

Parameters:

oInversion1: TRUE or FALSE (FALSE if not specified) for first length law.
oInversion2: TRUE or FALSE (FALSE if not specified) for second length law.

See also:

o GetLengthLawTypes

public virtual GetLengthLawTypes(		`eFirstType`,
		`eSecondType`)

Gets length law types.

Parameters:

eFirstType: First type of law (from CATGSMBasicLawType enumeration).
eSecondType: Second type of law (from CATGSMBasicLawType enumeration).

See also:

o GetLengthLaws

public virtual GetLengthLaws(		`FirstParamStart`,
		`FirstParamEnd`,
		`eFirstType`,
		`SecondParamStart`,
		`SecondParamEnd`,
		`eSecondType`)

Gets information about both length laws. PREFER PREVIOUS METHOD WHICH INCLUDES ADVANCED LAW FEATURES.

Parameters:

FirstParamStart: Start first angle literal feature
FirstParamEnd: End first angle literal feature
eFirstType: First type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
SecondParamStart: Start second angle literal feature
SecondParamEnd: End second angle literal feature
eSecondType: Second type of law (from CATGSMBasicLawType enumeration).

See also:

o GetLengthLaws

public virtual GetLengthLaws(		`FirstParamStart`,
		`FirstParamEnd`,
		`eFirstType`,
		`SecondParamStart`,
		`SecondParamEnd`,
		`eSecondType`)

Gets information about both length laws (including advanced law features).

Parameters:

FirstParamStart: Start first angle literal feature, or law feature if advanced
FirstParamEnd: End first angle literal feature, or NULL_var if advanced
eFirstType: First type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
SecondParamStart: Start second angle literal feature, or law feature if advanced
SecondParamEnd: End second angle literal feature, or NULL_var if advanced
eSecondType: Second type of law (from CATGSMBasicLawType enumeration).

See also:

o GetLongitudinalRelimiters

public virtual GetLongitudinalRelimiters(		`oElem1`,
		`boInv1`,
		`oElem2`,
		`boInv2`)

Gets the elements relimiting the spine (or the default spine).

Parameters:

oElem1: First relimiting feature (plane or point)
boInv1: Split direction for the first relimitation
FALSE means that the beginning of the spine (considering its orientation) is removed, TRUE means that the end of the spine is removed
oElem2: Second relimiting feature (plane or point)
boInv2: Split direction for the second relimitation

o GetMode

public virtual GetMode( oElem)

Gets linear sweep case number (also called mode). Possible cases are:
- CATGSMLinearSweep_None: unidentified mode
- CATGSMLinearSweep_TwoGuides: two guide curves and two possible length values
- CATGSMLinearSweep_GuideAndAngleCurve: one guide curve, one reference angle curve, one angle value and two length values
- CATGSMLinearSweep_GuideAndMiddle: two guide curves with one given as middle curve
- CATGSMLinearSweep_GuideAndRefSurfaceAngle: one guide curve lying on a reference surface, an angle value and two length values
- CATGSMLinearSweep_GuideAndTangencySurface: one guide curve and one tangency surface
- CATGSMLinearSweep_GuideAndDraftDirection: one guide curve and a draft direction
- CATGSMLinearSweep_TwoTangencySurfaces: one spine (or guide curve) and two tangency surfaces

Parameters:

oElem: Case number

See also:

o GetNbAngle

public virtual GetNbAngle( oI)

Gets the number of angles.

Parameters:

oI: Number of angles

o GetNbGuideCrv

public virtual GetNbGuideCrv( oI)

Gets the number of guide curves.

Parameters:

oI: Number of guide curves

o GetNbGuideSurf

public virtual GetNbGuideSurf( oI)

Gets the number of guide surfaces.

Parameters:

oI: Number of guide surfaces

o GetNbLength

public virtual GetNbLength( oI)

Gets the number of lengths.

Parameters:

oI: Number of lengths

o GetSecondLengthDefinitionType

public virtual GetSecondLengthDefinitionType(		`oType`,
		`oElem`)

Gets second length definition for linear swept surfaces (for draft surfaces only, so far).

Parameters:

oElem: Length type

o GetSmoothActivity

public virtual GetSmoothActivity( oSmooth)

Gets information whether sweeping operation is smoothed or not.

Parameters:

oSmooth: TRUE or FALSE (FALSE if not specified).

o GetSmoothAngleThreshold

public virtual GetSmoothAngleThreshold( oElem)

Gets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.

Parameters:

oElem: Numerical value.

o GetSmoothAngleThreshold

public virtual GetSmoothAngleThreshold( oElem)

Gets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.

Parameters:

oElem: Angular literal feature.

o GetSolutionNo

public virtual GetSolutionNo( oSolNo)

Gets the current solution number of the four possible solutions.

Parameters:

oSolNo: is the solution number.

o GetSpine

public virtual GetSpine( oElem)

Gets the spine.

Parameters:

oElem: Spine feature

o GetTrimOption

public virtual GetTrimOption( oOption)

Gets trim option status for the first (or only) tangency surface. Possible cases are :
- CATGSMSweepTrimMode_None: no trim computed or undefined,
- CATGSMSweepTrimMode_On: trim computed.

Parameters:

oOption: Trim option value

See also:

o GetTrimOptions

public virtual GetTrimOptions(		`oOption1`,
		`oOption2`)

Gets trim option statuses for both tangency surfaces. Possible cases are :
- CATGSMSweepTrimMode_None: no trim computed or undefined,
- CATGSMSweepTrimMode_On: trim computed.

Parameters:

oOption1: Trim option value for the first tangency surface
oOption2: Trim option value for the second tangency surface

See also:

o InsertDraftAngleDefinitionLocationAfterPos

public virtual InsertDraftAngleDefinitionLocationAfterPos(	const	`iLoc`,
	const	`iVal`,
	const	`iPos`)

Inserts a geometrical element and a value necessary for draft angle definition after a given position in the lists.

Parameters:

iLoc: Geometrical element
iVal: Angular parameter
iPos: Position in lists

o InsertDraftAngleDefinitionLocationBeforePos

public virtual InsertDraftAngleDefinitionLocationBeforePos(	const	`iLoc`,
	const	`iVal`,
	const	`iPos`)

Inserts a geometrical element and a value necessary for draft angle definition before a given position in the lists.

Parameters:

iLoc: Geometrical element
iVal: Angular parameter
iPos: Position in lists

o RemoveAllDraftAngleDefinitionLocations

public virtual RemoveAllDraftAngleDefinitionLocations(

)

Removes all geometrical elements and values necessary for draft angle definition.

o RemoveDraftAngleDefinitionLocationPosition

public virtual RemoveDraftAngleDefinitionLocationPosition( const iPos)

Removes a geometrical element and a value necessary for draft angle definition at a given position in the lists.

Parameters:

iPos: Position in lists

o SetAngle

public virtual SetAngle(	const	`iElem`,
	const	`iI`)

Sets the value of an angle given its index.

Parameters:

iElem: Angle value
iI: Index of the angle (starting from one)

o SetAngle

public virtual SetAngle(	const	`iElem`,
	const	`iI`)

Sets the literal feature representing an angle given its index.

Parameters:

iElem: Angle literal feature
iI: Index of the angle (starting from one)

See also:

o SetAngularLaw

public virtual SetAngularLaw( const Elem)

Sets angular law feature.

Parameters:

Elem: Angular law feature

See also:

o SetAngularLaw

public virtual SetAngularLaw(	const	`ParamStart`,
	const	`ParamEnd`,
	const	`eType`)

Sets information about angular law.

Parameters:

ParamStart: Start angle literal feature
ParamEnd: End angle literal feature
eType: Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.

See also:

o SetAngularLawInversion

public virtual SetAngularLawInversion( const iInversion)

Sets information whether angular law has to be inverted or not.

Parameters:

iInversion: TRUE or FALSE.

See also:

o SetAngularLawType

public virtual SetAngularLawType( const eType)

Sets angular law type.

Parameters:

eType: Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.

See also:

o SetCanonicalDetectionMode

public virtual SetCanonicalDetectionMode( iDetection = CATGSMNoDetection)

Sets information about detection of canonical surfaces of the output surface.

Parameters:

iDetection: If canonical surfaces are detected. Possible values are CATGSMNoDetection and CATGSMCanonicalDetection.

See also:

o SetChoiceNo

public virtual SetChoiceNo(	const	`iSurfOri`,
	const	`iCrvOri`,
	const	`iNo`)

Sets a sequence which identifies a solution (see above), case CATGSMLinearSweep_GuideAndTangencySurface.

Parameters:

iNo
iSurfOri
iCrvOri

o SetChoiceNoSurfaces

public virtual SetChoiceNoSurfaces(	const	`iSurfOri1`,
	const	`iSurfOri2`,
	const	`iSurfCouplOri1`,
	const	`iSurfCouplOri2`,
	const	`iNo`)

Sets a sequence which identifies a solution (see above), case CATGSMLinearSweep_TwoTangencySurfaces.

Parameters:

iNo
iFirstOri
iSecondOri

o SetContext

public virtual SetContext( const iContext)

Sets the context of the Sweep.

Parameters:

iContextType: CATGSMSurfaceCtxt to generate a surface, CATGSMVolumeCtxt (requires GSO License) to generate a volume

See also:

o SetDraftComputationMode

public virtual SetDraftComputationMode( const iElem)

Sets linear swept surface with draft direction computation mode: CATGSMLinearDraftSweepComp_Square for square, CATGSMLinearDraftSweepComp_ConeEnvelop for cone envelop.

Parameters:

iElem: Computation mode

o SetDraftDirection

public virtual SetDraftDirection( const iElem)

Sets draft direction.

Parameters:

iElem: Direction feature

o SetFirstLengthDefinitionType

public virtual SetFirstLengthDefinitionType(	const	`iType`,
	const	`iElem`	`= NULL_var`)

Sets first length definition for linear swept surfaces (for draft surfaces only, so far).

Parameters:

iElem: Length type

o SetGuideCrv

public virtual SetGuideCrv( const iElem)

Modify first guide curve.

Parameters:

iElem: First guide curve feature.

o SetGuideCrv

public virtual SetGuideCrv(	const	`iElem`,
	const	`iI`)

Sets a guide curve given its index.

Parameters:

iElem: Guide curve feature.
iI: Guide curve index : 1 or 2

o SetGuideDeviation

public virtual SetGuideDeviation( const iElem)

Sets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.

Parameters:

iElem: Numerical value.

o SetGuideDeviation

public virtual SetGuideDeviation( const iElem)

Sets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.

Parameters:

iElem: Length literal feature.

o SetGuideDeviationActivity

public virtual SetGuideDeviationActivity( const iActi)

Sets information whether a deviation from guide curves is allowed or not during sweeping operation in order to smooth it.

Parameters:

iSmooth: TRUE or FALSE.

o SetGuideSurf

public virtual SetGuideSurf( const iElem)

Sets first guide surface.

Parameters:

iElem: First guide surface feature.

o SetGuideSurf

public virtual SetGuideSurf(	const	`iElem`,
	const	`iI`)

Sets a guide surface given its index.

Parameters:

iElem: Guide surface feature.
iI: Guide surface index : 1 or 2

o SetLength

public virtual SetLength(	const	`iElem`,
	const	`iI`)

Sets the value of a length given its index.

Parameters:

iElem: Length value
iI: Index of the length (starting from one)

o SetLength

public virtual SetLength(	const	`iElem`,
	const	`iI`)

Sets the literal feature representing an length given its index.

Parameters:

iElem: Length literal feature
iI: Index of the length (starting from one)

See also:

o SetLengthLawInversions

public virtual SetLengthLawInversions(	const	`iInversion1`,
	const	`iInversion2`)

Sets information whether length laws have to be inverted or not.

Parameters:

iInversion1: TRUE or FALSE for first length law.
iInversion2: TRUE or FALSE for second length law.

See also:

o SetLengthLawTypes

public virtual SetLengthLawTypes(	const	`eFirstType`,
	const	`eSecondType`)

Sets length law types.

Parameters:

eFirstType: First type of law (from CATGSMBasicLawType enumeration).
eSecondType: Second type of law (from CATGSMBasicLawType enumeration).

See also:

o SetLengthLaws

public virtual SetLengthLaws(	const	`FirstParamStart`,
	const	`FirstParamEnd`,
	const	`eFirstType`,
	const	`SecondParamStart`,
	const	`SecondParamEnd`,
	const	`eSecondType`)

Sets information about both length laws. PREFER PREVIOUS METHOD WHICH INCLUDES ADVANCED LAW FEATURES.

Parameters:

FirstParamStart: Start first angle literal feature
FirstParamEnd: End first angle literal feature
eFirstType: First type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType.
SecondParamStart: Start second angle literal feature
SecondParamEnd: End second angle literal feature
eSecondType: Second type of law (from CATGSMBasicLawType enumeration except CATGSMBasicLawType_Advanced).

See also:

o SetLengthLaws

public virtual SetLengthLaws(	const	`FirstParamStart`,
	const	`FirstParamEnd`,
	const	`eFirstType`,
	const	`SecondParamStart`,
	const	`SecondParamEnd`,
	const	`eSecondType`)

Sets information about both length laws (including advanced law features).

Parameters:

FirstParamStart: Start first angle literal feature, or law feature if advanced
FirstParamEnd: End first angle literal feature, or NULL_var if advanced
eFirstType: First type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
SecondParamStart: Start second angle literal feature, or law feature if advanced
SecondParamEnd: End second angle literal feature, or NULL_var if advanced
eSecondType: Second type of law (from CATGSMBasicLawType enumeration).

See also:

o SetLongitudinalRelimiters

public virtual SetLongitudinalRelimiters(	const	`iElem1`,
	const	`biInv1`,
	const	`iElem2`,
	const	`biInv2`)

Sets the elements relimiting the spine (or the default spine).

Parameters:

iElem1: First relimiting feature (plane or point)
biInv1: Split direction for the first relimitation
FALSE means that the beginning of the spine (considering its orientation) is removed, TRUE means that the end of the spine is removed
iElem2: Second relimiting feature (plane or point)
biInv2: Split direction for the second relimitation

o SetMode

public virtual SetMode( const iElem)

Sets linear sweep case number.

Parameters:

iElem: Case number

See also:

o SetSecondLengthDefinitionType

public virtual SetSecondLengthDefinitionType(	const	`iType`,
	const	`iElem`	`= NULL_var`)

Sets second length definition for linear swept surfaces (for draft surfaces only, so far).

Parameters:

iElem: Length type

o SetSmoothActivity

public virtual SetSmoothActivity( const iSmooth)

Sets information whether sweeping operation is smoothed or not.

Parameters:

iSmooth: TRUE or FALSE.

o SetSmoothAngleThreshold

public virtual SetSmoothAngleThreshold( const iElem)

Sets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.

Parameters:

iElem: Numerical value.

o SetSmoothAngleThreshold

public virtual SetSmoothAngleThreshold( const iElem)

Sets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.

Parameters:

iElem: Angular literal feature.

o SetSolutionNo

public virtual SetSolutionNo( iSolNo)

Sets the current solution number of the four possible solutions.

Parameters:

iSolNo: is the solution number.

o SetSpine

public virtual SetSpine( const iElem)

Sets the spine.

Parameters:

iElem: Spine feature

o SetTrimOption

public virtual SetTrimOption( const iOption)

Sets trim option status for the first (or only) tangency surface.

Parameters:

iOption: Trim option value

See also:

o SetTrimOptions

public virtual SetTrimOptions(	const	`iOption1`,
	const	`iOption2`)

Sets trim option statuses for both tangency surfaces.

Parameters:

iOption1: Trim option value for the first tangency surface
iOption2: Trim option value for the second tangency surface

See also:

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