All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATStrUseItf Interface CATIStrUsePanelLimitMngt

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

interface CATIStrUsePanelLimitMngt

Interface to manage Panel's limits.
Role: Interface to manage limits for Panel. A limit can be: - curve / surface - Panel: if the Panel is planar, it is the CanonicMoldedSurface, if not it is the delimited one. - Profile: if it is Straight, it is the CanonicTrace, if not the delimited one. Why do we use the canonic support? it is for realizing reciprocal limits without having an update lifecycle: for instance, Panel P1 is limites by Panel P2 and P2 is limited by P1. Why do we use sometimes delimited support? because in case the Panel is a complex surface, we prefer to use the delimited support because it is smaller in size and the reciprocal limits is not really a valid use case as well. Feature implementing this interface: SFD/SDD Panel/Plate.

Method Index

o GetLimitType(CATStrPlateLimitType&,int): Get the Limit Orientation for a limit at the position iIndexLimit on the Panel.
o GetLimitingObject(CATIMmiMechanicalFeature_var&,int): Get the Limiting Object on the Panel
o GetLimitingObjects(CATLISTV(CATIMmiMechanicalFeature_var)&,CATListOfInt&,CATLISTV(CATIMmiMechanicalFeature_var)&,CATListOfInt&): Get the list of Limiting Objects, the limit orientations and the limit offsets on the Panel
o GetOffset(CATICkeParm_var&,int): Get the Limit Orientation for a limit at the position iIndexLimit on the Panel.
o GetOrientation(CATStrOrientation&,int): Get the Limit Orientation for a limit at the position iIndexLimit on the Panel.
o InvertLimit(int): Invert the Limit Orientation for a limit at the position iIndexLimit on the Panel.
o RemoveLimit(int): Remove the limit at the position iIndexLimit.
o SetLimitType(CATStrPlateLimitType&,int): Set the Limit Type for a limit at the position iIndexLimit on the Panel.
o SetLimitingObject(CATIMmiMechanicalFeature_var&,int,CATStrOrientation&,CATStrPlateLimitType,CATUnicodeString&): Set the Limiting Object on the Panel.

Methods

o GetLimitType

public virtual GetLimitType(		`oLimitType`,
	const	`iIndexLimit`	`= -1` )

Get the Limit Orientation for a limit at the position iIndexLimit on the Panel.

Parameters:

oLimitType: Limit type.
iIndexLimit: Position of the offset's limit. If iIndexLimit == -1 (default value): the last limit orientation is retrieved. If iIndexLimit > 0 : the index of the limit the user wish to retrieve.

o GetLimitingObject

public virtual GetLimitingObject(		`oLimitingObject`,
	const	`iIndexLimit`	`= -1`)

Get the Limiting Object on the Panel

Parameters:

oLimitingObject: Limit Feature to be retrieved. Can be a geometric curves, surfaces or a SFD Profile, or a SFD Panel. The exported feature is retrieved if possible, otherwise the import.
iIndexLimit: Position of the limit to be retrieved.

o GetLimitingObjects

public virtual GetLimitingObjects(		`oLimitingObjects`,
		`oListOfOrientations`,
		`oListOfOffset`,
		`oListOfLimitTypes`)

Get the list of Limiting Objects, the limit orientations and the limit offsets on the Panel

Parameters:

oLimitingObjects: Can be a geometric curves, surfaces or a SFD Profile, or a SFD Panel. The exported feature is retrieved if possible, otherwise the import.
oListOfOrientations: List of the Limit Orientations.
oListOfOffset: List of the Limit offsets .list of knowledge parameters. see CATICkeParm.
oListOfLimitTypes: List of the Limit types.

o GetOffset

public virtual GetOffset(		`ospOffset`,
	const	`iIndexLimit`	`= -1` )

Get the Limit Orientation for a limit at the position iIndexLimit on the Panel.

Parameters:

ospOffset: Limit offset to be retrieved.
iIndexLimit: Position of the offset's limit. If iIndexLimit == -1 (default value): the last limit orientation is retrieved. If iIndexLimit > 0 : the index of the limit the user wish to retrieve.

o GetOrientation

public virtual GetOrientation(		`oOrientation`,
	const	`iIndexLimit`	`= -1` )

Get the Limit Orientation for a limit at the position iIndexLimit on the Panel.

Parameters:

oOrientation: Limit Orientation to be retrieved. The Orientation is computed when using SetLimitingObject. The value will depends on the molded convention if set.
iIndexLimit: Position of the orientation's limit. If iIndexLimit == -1 (default value): the last limit orientation is retrieved. If iIndexLimit > 0 : the index of the limit the user wish to retrieve.

o InvertLimit

public virtual InvertLimit( const iIndexLimit = -1 )

Invert the Limit Orientation for a limit at the position iIndexLimit on the Panel.

Parameters:

iIndexLimit: Position of the limit. If iIndexLimit == -1 (default value): the last limit orientation is inverted If iIndexLimit > 0 : the index of the limit orientation the user wish to invert.

o RemoveLimit

public virtual RemoveLimit( const iIndexLimit = -1)

Remove the limit at the position iIndexLimit.

Parameters:

iIndexLimit: Position of the Limit. if iIndexLimit = -1, the last Limit is removed if iIndexLimit = -99, all the limits are removed

o SetLimitType

public virtual SetLimitType(		`iLimitType`,
	const	`iIndexLimit`	`= -1` )

Set the Limit Type for a limit at the position iIndexLimit on the Panel.

Parameters:

iLimitType: Limit type.
iIndexLimit: Position of the offset's limit. If iIndexLimit == -1 (default value): the last limit orientation is retrieved. If iIndexLimit > 0 : the index of the limit the user wish to retrieve.

o SetLimitingObject

public virtual SetLimitingObject(	const	`iLimitingObject`,
	const	`iIndexLimit`	`= -1`,
	const	`iOrientation`	`= StrUnknownOrientation`,
	const	`iLimitType`	`= catStrPlateLimitWeld`,
	const	`iucLimitKey`	`= ""`)

Set the Limiting Object on the Panel. The orientation is automatically computed.

Parameters:

iLimitingObject: Limit Feature to be set on the panel Can be a geometric curves, surfaces or a SFD Profile, or a SFD Panel. The import is managed by the implementation.
iIndexLimit: If iIndexLimit == -1 (default value): the new limit is added at the end of the list of limits. If iIndexLimit > 0 : the new limit is set at the position iIndexLimit.
iOrientation: Current orientation of the plate limit. Default Value: SfmUnknownOrientation. if iOrientation == SfmUnknownOrientation, the value of the Orientation is automatically computed, depending on the value Set in the PRM ressources. We advised to use the default value, so that the automatic computation is performed.
iLimitType: Default cutting strategy is set to Weld.
iucLimitKey: Key of the face of the feature. Default Values: 2 - Plate (Corresponds to one face of the Plate.) 22 - Stiffener (Corresponds to top face of flange of the Stiffener.)

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