All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATStrUseItf Interface CATIStrUseOpeningStandard

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

interface CATIStrUseOpeningStandard

Interface representing a Standard Opening.
Role: The CATIStrUseOpeningStandard interface is conditionally implemented for the Opening object, depending on whether the Opening has the Standard Opening CreationMode. This interface provides functions specific to Standard Openings. This interface allows access to the Standard Opening catalog to be encapsulated within the modeler, and combines the list of Standard Opening catalog contours with the built-in and locally defined (in the design model) Standard Opening contours. This also combines the list of positioning strategies in the Standard Opening catalog with built-in and locally defined positioning strategies.

Method Index

o GetAxisSystem(CATIMmiMechanicalFeature_var&): Gets the Axis System of this Opening.
o GetContour(CATIMmiMechanicalFeature_var&): Gets the standard contour used by this Opening.
o GetContour(CATUnicodeString&,CATListValCATBaseUnknown_var&)
o GetContour(CATUnicodeString&,CATUnicodeString&,CATListValCATBaseUnknown_var&): Gets the contour name and parameters of this Standard Opening.
o GetDirection(CATIMmiMechanicalFeature_var&): Gets the direction of extrusion of this Opening.
o GetDirectionForOpeningOnProfile(CATBoolean&): Gets the Direction for Opening on Profile.
o GetLimitMode(CATStrOpeningLimitsMode&): Define the way an opening extrude the negative volume.
o GetPositioningStrategy(CATUnicodeString&,CATListValCATBaseUnknown_var&): Gets the positioning strategy type and parameters of this opening.
o GetStandardModeType(CATStrOpeningSTDMode&): Gets the Standard mode of this Opening.
o SetAxisSystem(CATIMmiMechanicalFeature_var&): Sets the Axis System of this Opening.
o SetContourAndPosStrategy(CATUnicodeString&,CATListValCATBaseUnknown_var&,CATUnicodeString&,CATListValCATBaseUnknown_var&)
o SetContourAndPosStrategy(CATUnicodeString&,CATUnicodeString&,CATListValCATBaseUnknown_var&,CATUnicodeString&,CATListValCATBaseUnknown_var&): Sets the contour and positioning strategy names and parameters of this Standard Opening.
o SetContourAndPosStrategyForProfile(CATUnicodeString&,CATListValCATBaseUnknown_var&,CATUnicodeString&,CATListValCATBaseUnknown_var&): Sets the contour and positioning strategy names and parameters of this Standard Opening on Profile.
o SetDirection(CATIMmiMechanicalFeature_var&): Sets the direction of extrusion of this Opening.
o SetDirectionForOpeningOnProfile(CATBoolean): Sets the Direction for Opening on Profile.
o SetLimitMode(CATStrOpeningLimitsMode): Define the way an opening extrude the negative volume.
o SetMidDistOffsetPosStratParms(CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Sets the parameters for mid dist offset position strategy.
o SetOffsetOffsetPosStratParms(CATIMmiMechanicalFeature_var&,CATIMmiMechanicalFeature_var&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Sets the parameters for offset offset position strategy.
o SetSpacingOffsetPosStratParms(CATIMmiMechanicalFeature_var&,CATBoolean,CATUnicodeString&,CATBoolean,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Sets the parameters for spacing offset position strategy.
o SetStandardModeType(CATStrOpeningSTDMode): Sets the Standard mode of this Opening.

Methods

o GetAxisSystem

public virtual GetAxisSystem( ospAxisSystem)

Gets the Axis System of this Opening.

Parameters:

ospAxisSystem: It is CATIMf3DAxisSystem.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o GetContour

public virtual GetContour( ospContour)

Gets the standard contour used by this Opening.

Parameters:

ospContour: Contour.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o GetContour

public virtual GetContour(		`oContourName`,
		`oListContourParams`)

Deprecated:: V6R2013 use GetContour(CATUnicodeString &oContourType,CATUnicodeString &oContourName,CATListValCATBaseUnknown_var &oListContourParams)

o GetContour

public virtual GetContour(		`oContourType`,
		`oContourName`,
		`oListContourParams`)

Gets the contour name and parameters of this Standard Opening.

Parameters:

oContourName: The name of the Standard Opening contour for this opening.
oListContourParams: A list of volatile objects (accessed through CATIStrUseParameter) specifying Cke parameters controlling the size of this contour. The Cke parameters and their roles are retrieved using the CATIStrUseParameter interface. These Cke parameters are normally persistent parameter objects in the model (if they have been stored), but in some cases, these may be volatile parameters. The parameters are locked if they cannot be modified. Do not release the smart pointers in this list - it is done automatically.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o GetDirection

public virtual GetDirection( ospDirection)

Gets the direction of extrusion of this Opening.

Parameters:

ospDirection: It can be a line or a plane.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o GetDirectionForOpeningOnProfile

public virtual GetDirectionForOpeningOnProfile( oDirection)

Gets the Direction for Opening on Profile.

Parameters:

oDirection: It is either CATTrue or CATFalse. CATTrue if opening is on web and CATFalse if it is on flange of profile.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o GetLimitMode

public virtual GetLimitMode( oType)

Define the way an opening extrude the negative volume.

Parameters:

oType: It can be UpToLast or Dimensions.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o GetPositioningStrategy

public virtual GetPositioningStrategy(		`oPosStrategyName`,
		`oListPosParams`)

Gets the positioning strategy type and parameters of this opening.

Parameters:

oPosStrategyName: The name of the positioning strategy.
oListPosParams: A list of the parameter group objects defining the Positioning Specification. The number and types of objects in this list depend on the Positioning Strategy name.

See also:

, ,

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o GetStandardModeType

public virtual GetStandardModeType( oSTDOpeningCreationMode)

Gets the Standard mode of this Opening.

Parameters:

oSTDOpeningCreationMode: It is type of standard opening as Str_Round/Str_Rect/Str_Oblong/Catalog.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o SetAxisSystem

public virtual SetAxisSystem( const ispAxisSystem)

Sets the Axis System of this Opening.

Parameters:

ispAxisSystem: It is CATIMf3DAxisSystem.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o SetContourAndPosStrategy

public virtual SetContourAndPosStrategy(	const	`iContourName`,
	const	`iListContourParams`,
	const	`iPosStrategyName`,
	const	`iListPosParams`)

Deprecated:: V6R2013 use SetContourAndPosStrategy(const CATUnicodeString &iContourType,const CATUnicodeString &iContourName,const CATListValCATBaseUnknown_var &iListContourParams,const CATUnicodeString &iPosStrategyName,const CATListValCATBaseUnknown_var &iListPosParams)

o SetContourAndPosStrategy

public virtual SetContourAndPosStrategy(	const	`iContourType`,
	const	`iContourName`,
	const	`iListContourParams`,
	const	`iPosStrategyName`,
	const	`iListPosParams`)

Sets the contour and positioning strategy names and parameters of this Standard Opening.

Parameters:

iContourType: The Type of the Standard Opening contour for this opening. Ex. Str_Round\Str_Rect\Str_Oblong\Catalog.
iContourName: The name of the Standard Opening contour for this opening. Ex. for Round type: "Round D1600".
iListContourParams: A list of volatile objects (accessed through CATICkeParameter) specifying Cke parameters controlling the size of this contour. These volatile objects are created using the GetContour method here or CATIStrUseOpeningsMgr::GetStandardContourParms. The Cke parameters specified by the volatile objects in this list may be persistent or volatile Cke parameters. The values (and formulas) of these Cke parameters will be copied to the Cke parameters in the model (if the model parameter is not locked), using the parameter role to correlate these parameters with the model parameters.
iPosStrategyName: The internal name of the positioning strategy.
iListPosParams: A list of volatile parameter group objects defining the Positioning Specification. The number and types of objects in this list depend on the Positioning Strategy name.

See also:

, , ,

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o SetContourAndPosStrategyForProfile

public virtual SetContourAndPosStrategyForProfile(	const	`iContourName`,
		`iListContourParams`,
	const	`iPosStrategyName`,
		`iListPosParams`)

Sets the contour and positioning strategy names and parameters of this Standard Opening on Profile.

Parameters:

iContourName: The name of the Standard Opening contour for this opening. Ex. for Round type: "Round D1600".
iListContourParams: A list of volatile objects (accessed through CATICkeParameter) specifying Cke parameters controlling the size of this contour. These volatile objects are created using the GetContour method here or CATIStrUseOpeningsMgr::GetStandardContourParms. The Cke parameters specified by the volatile objects in this list may be persistent or volatile Cke parameters. The values (and formulas) of these Cke parameters will be copied to the Cke parameters in the model (if the model parameter is not locked), using the parameter role to correlate these parameters with the model parameters.
iPosStrategyName: The internal name of the positioning strategy. Get the list of internal names of the available positioning strategies.

See also:

iListPosParams

A list of volatile parameter group objects defining the Positioning Specification. The number and types of objects in this list depend on the Positioning Strategy name.

See also:

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o SetDirection

public virtual SetDirection( const ispDirection)

Sets the direction of extrusion of this Opening.

Parameters:

ispDirection: It can be a line or a plane.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o SetDirectionForOpeningOnProfile

public virtual SetDirectionForOpeningOnProfile( iDirection)

Sets the Direction for Opening on Profile.

Parameters:

iDirection: It is either CATTrue or CATFalse. CATTrue if opening is to be on web and CATFalse if it is to be on flange of a profile.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o SetLimitMode

public virtual SetLimitMode( const iType)

Define the way an opening extrude the negative volume.

Parameters:

iType: It can be UpToLast or Dimensions.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o SetMidDistOffsetPosStratParms

public virtual SetMidDistOffsetPosStratParms(	const	`iRefProfile`,
	const	`iRefElement_1`,
	const	`iRefElement_2`,
	const	`iVOffsetCkeParm`,
	const	`iAnchorPointName`,
	const	`iCkeParmAngle`)

Sets the parameters for mid dist offset position strategy. There are in all 6 parameters to be set.

Parameters:

iRefProfile: The reference of the profile.
iRefElement_1: The first reference element used.
iRefElement_2: The second reference element used.
iVOffsetCkeParm: The vertical offset distance from anchor point.
iAnchorPointName: The anchor point type.
iCkeParmAngle: The axis angle.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o SetOffsetOffsetPosStratParms

public virtual SetOffsetOffsetPosStratParms(	const	`iRefProfile`,
	const	`iRefElement`,
	const	`iRefOffsetCkeParm`,
	const	`iVOffsetCkeParm`,
	const	`iAnchorPointName`,
	const	`iCkeParmAngle`)

Sets the parameters for offset offset position strategy. There are in all 6 parameters to be set.

Parameters:

iRefProfile: The reference of the profile.
iRefElement: The reference element used.
iRefOffsetCkeParm: The horizontal offset distance from reference element.
iVOffsetCkeParm: The vertical offset distance from anchor point.
iAnchorPointName: The anchor point type.
iCkeParmAngle: The axis angle.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o SetSpacingOffsetPosStratParms

public virtual SetSpacingOffsetPosStratParms(	const	`iRefProfile`,
		`iOrientation`,
	const	`iHOffsetCkeParm`,
		`iRepetitionMode`,
	const	`iVOffsetCkeParm`,
	const	`iAnchorPointName`,
	const	`iCkeParmAngle`)

Sets the parameters for spacing offset position strategy. There are in all 7 parameters to be set.

Parameters:

iRefProfile: The reference of the profile.
iOrientation: Whether reference point is from start or end. CATTrue for Start and CATFalse for End.
iHOffsetCkeParm: The horizontal offset distance.
iRepetitionMode: Whether mode is absolute or relative. CATTrue for Absolute and CATFalse for Relative.
iVOffsetCkeParm: The vertical offset distance from anchor point.
iAnchorPointName: The anchor point type.
iCkeParmAngle: The axis angle.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o SetStandardModeType

public virtual SetStandardModeType( iSTDOpeningCreationMode)

Sets the Standard mode of this Opening.

Parameters:

iSTDOpeningCreationMode: It is type of standard opening as Str_Round/Str_Rect/Str_Oblong/Catalog.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

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