CATStrUseItf Interface CATIStrUseOpeningsMgr

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

interface CATIStrUseOpeningsMgr

Interface for managing openings.

Method Index

o GetAvailableStandardContours(CATListValCATUnicodeString&)

Gets the Standard Opening contour names available for creating a Standard Opening.

o GetAvailableStandardPositioningStrategies(CATListValCATUnicodeString&)

Gets the available positioning strategies for Parametric Feature Instances.

o GetAvailableStandardPositioningStrategiesForProfile(CATListValCATUnicodeString&)

Gets the available positioning strategies for Profile.

o GetStandardContourParms(CATUnicodeString&,CATListValCATBaseUnknown_var&)

Gets the parameters used for a Standard Opening contour.

o GetStandardPositioningStrategyParms(CATUnicodeString&,CATListValCATBaseUnknown_var&)

Gets the parameters for a Positioning Strategy.

o GetStandardPositioningStrategyParmsForProfile(CATUnicodeString&,CATListValCATBaseUnknown_var&)

Gets the available positioning strategy parameters for Profile.

Methods

Gets the Standard Opening contour names available for creating a Standard Opening.

Parameters:

oListStrategyNames

The list of internal names of the available Standard Opening contours.

Returns:

HRESULT Return code (use SUCCEEDED or FAILED).

Gets the available positioning strategies for Parametric Feature Instances.

Parameters:

oListStrategyNames

The list of internal names of the available positioning strategies.

Returns:

HRESULT Return code (use SUCCEEDED or FAILED).

Gets the available positioning strategies for Profile.

Parameters:

oListStrategyNames

The list of internal names of the available positioning strategies for profile.

Returns:

HRESULT Return code (use SUCCEEDED or FAILED).

Gets the parameters used for a Standard Opening contour. The parameters are represented by non-persistent objects that define the role and Cke parameter pointer. The roles returned are internal names, not the NLS names needed for the UI.

Parameters:

iContourName

The contour name.

oListStrParms

The list of parameter objects for this contour. Each object in this list is a volatile object, and represents the parameters of this contour. Use these volatile objects to set the parameters for the contour of a Standard Opening. Items in this list should not be explicitly deleted or released. The objects are deleted automatically when their smart pointers are deleted or cleared.

Returns:

HRESULT Return code (use SUCCEEDED or FAILED).

Gets the parameters for a Positioning Strategy. The parameters are described by a list of volatile objects. The number and types of objects in the list depend on the positioning strategy.

Each volatile object type is accessed by a specific interface.

Built-in Positioning Strategies

• Offset / Offset (iPosStrategyName = CATStrPosOffsetOffset)

  The opening position is defined by two offsets from two reference elements.

  Parameter groups (in no particular order):

  • ParmGrp: CATIStrUsePosSupportFace("SupportFace", FaceName)
  • FaceName - The name of the face in the opening base support on which to compute the U and V curves.
  • ParmGrp: CATIStrUsePosAxisAdjustment(Angle, DeltaU, DeltaV)
  • Angle - The angle applied to the positioning axis --> rotated positioning axis.
  • DeltaU, DeltaV - The (U,V) shift of the contour on the rotated positioning axis.
  • ParmGrp: CATIStrUseRefOffset("UCurve", RefPrdOcc, RefFeature, Offset, OffsetOrientation)
  • RefPrdOcc, RefFeature – The product occurrence and feature for the U curve reference element.
  • Offset – The offset distance for the U curve.
  • OffsetOrientation – The orientation giving the reference face and offset direction.
  • ParmGrp: CATIStrUseRefOffset("VCurve", RefPrdOcc, RefFeature, Offset, OffsetOrientation)
  • RefPrdOcc, RefFeature – The product occurrence and feature for the V curve reference element.
  • Offset – The offset distance for the V curve.
  • OffsetOrientation – The orientation giving the reference face and offset direction.
• Half Height / Offset (iPosStrategyName = CATStrPosHalfHeightOffset)

  The opening position is defined by one offset from a reference element, and the midpoint on that offset from the face edges.

  Parameter groups (in no particular order):

  • ParmGrp: CATIStrUsePosSupportFace("SupportFace", FaceName)
  • FaceName - The name of the face in the opening base support on which to compute the U and V curves.
  • ParmGrp: CATIStrUsePosAxisAdjustment(Angle, DeltaU, DeltaV)
  • Angle - The angle applied to the positioning axis --> rotated positioning axis.
  • DeltaU, DeltaV - The (U,V) shift of the contour on the rotated positioning axis.
  • ParmGrp: CATIStrUseRefOffset("UCurve", RefPrdOcc, RefFeature, Offset, OffsetOrientation)
  • RefPrdOcc, RefFeature – The product occurrence and feature for the U curve reference element.
  • Offset – The offset distance for the U curve.
  • OffsetOrientation – The orientation giving the reference face and offset direction.
• Mid-Dist / Offset (iPosStrategyName = CATStrPosMidDistOffset)

  The opening position is defined by one offset from a reference element, and midpoint between two reference elements.

  Parameter groups (in no particular order):

  • ParmGrp: CATIStrUsePosSupportFace("SupportFace", FaceName)
  • FaceName - The name of the face in the opening base support on which to compute the U and V curves.
  • ParmGrp: CATIStrUsePosAxisAdjustment(Angle, DeltaU, DeltaV)
  • Angle - The angle applied to the positioning axis --> rotated positioning axis.
  • DeltaU, DeltaV - The (U,V) shift of the contour on the rotated positioning axis.
  • ParmGrp: CATIStrUsePosDualRef("UCurve", Ref1PrdOcc, Ref1Feature, Ref2PrdOcc, Ref2Feature) -
  • The two reference elements for U midpoint.
  • ParmGrp: CATIStrUseRefOffset("VCurve", RefPrdOcc, RefFeature, Offset, OffsetOrientation)
  • RefPrdOcc, RefFeature – The product occurrence and feature for the V curve reference element.
  • Offset – The offset distance for the V curve.
  • OffsetOrientation – The orientation giving the reference face and offset direction.
• Mid-Dist / Mid-Dist (iPosStrategyName = CATStrPosMidDistMidDist)

  The opening position is defined as the midpoint along X between two reference elements, and the midpoint along Y of two other reference elements.

  Parameter groups (in no particular order):

  • ParmGrp: CATIStrUsePosSupportFace("SupportFace", FaceName)
  • FaceName - The name of the face in the opening base support on which to compute the U and V curves.
  • ParmGrp: CATIStrUsePosAxisAdjustment(Angle, DeltaU, DeltaV)
  • Angle - The angle applied to the positioning axis --> rotated positioning axis.
  • DeltaU, DeltaV - The (U,V) shift of the contour on the rotated positioning axis.
  • ParmGrp: CATIStrUsePosDualRef("UCurve", Ref1PrdOcc, Ref1Feature, Ref2PrdOcc, Ref2Feature) -
  • The two reference elements for U midpoint.
  • ParmGrp: CATIStrUsePosDualRef("VCurve", Ref1PrdOcc, Ref1Feature, Ref2PrdOcc, Ref2Feature) –
  • The two reference elements for V midpoint.
• Half-Height / Mid-Dist (iPosStrategyName = CATStrPosHalfHeightMidDist)

  The opening position is defined as the midpoint along X between two reference elements, and the midpoint along Y from the face edges.

  Parameter groups (in no particular order):

  • ParmGrp: CATIStrUsePosSupportFace("SupportFace", FaceName)
  • FaceName - The name of the face in the opening base support on which to compute the U and V curves.
  • ParmGrp: CATIStrUsePosAxisAdjustment(Angle, DeltaU, DeltaV)
  • Angle - The angle applied to the positioning axis --> rotated positioning axis.
  • DeltaU, DeltaV - The (U,V) shift of the contour on the rotated positioning axis.
  • ParmGrp: CATIStrUsePosDualRef("UCurve", Ref1PrdOcc, Ref1Feature, Ref2PrdOcc, Ref2Feature) -
  • The two reference elements for U midpoint.
• Custom Positioning Strategy (iPosStrategyName = any other name)

  The opening position is defined by a UDF (created by the customer, and usually stored in the Standard Openings catalog).
  The UDF takes parameters and reference elements as inputs, and outputs a 3D axis.
  The contour is positioned as the axis location and orientation.

  Parameters:

  • The UDF parameters are each passed in the CATStrPosCke group.
  • The UDF inputs are each passed in the CATStrPosRef group.

Parameters:

iPosStrategyName

The internal name of the positioning strategy.

oListPosParams

A list of volatile objects, each representing a generic group of specification data for the positioning strategies. Each volatile object knows its role for the positioning strategy and a set of related parameters. There are several types of these volatile objects, each supporting one of the following interfaces.

• CATIStrUsePosSupportFace – Accesses the specification of the face where the position axis is calculated.
• CATIStrUseParameter - Accesses general parameters (as defined by the role).
• CATIStrUsePosAxisAdjustment - Accesses parameters controlling the contour axis adjustments.
• CATIStrUsePosAxisAdjustment - Accesses a reference element with an offset and an offset orientation
• CATIStrUsePosDualRef - Accesses a pair of reference elements which must be specified together

Returns:

HRESULT Return code (use SUCCEEDED or FAILED).

See , , ,

Gets the available positioning strategy parameters for Profile.

Parameters:

iPosStrategyName

The internal name of the positioning strategy.

oListPosParams

A list of volatile objects, each representing a generic group of specification data for the positioning strategies. Each volatile object knows its role for the positioning strategy and a set of related parameters.

Returns:

HRESULT Return code (use SUCCEEDED or FAILED).

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