All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPartUseItf Interface CATIPdgUsePrtProfile

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

interface CATIPdgUsePrtProfile

Interface which provides a profile management behavior to a feature profile.
Role: Some features contain a profile component which allows users to define and use a profile. The profile internal feature is managed through this interface.

Method Index

o AddElement(CATBaseUnknown_var&): Adds a new element to the specifications list.
o GetBody(int,CATBody_var&): Gets the topological body corresponding to the profile.
o GetBoundingBox(CATMathBox&): Gets the bounding box of the whole profile.
o GetCenter(CATMathPoint&): Gets the mathematical center of the profile bounding box.
o GetContourCount(): Gets the number of contour defined by the specification list.
o GetElement(int,CATIMmiMechanicalFeature_var&): Gets an element of the specification list.
o GetElementCount(): Gets the number of specification elements used to define the profile.
o GetGeomPlane(CATPlane_var&): Gets the geometrical plane associated to the profile support.
o GetPlane(CATMathPlane&): Gets the mathematical plane corresponding to the support of the profile geometry.
o GetSpecPlane(CATIMmiMechanicalFeature_var&): Gets the specification plane which defines the profile support.
o RemoveAllElements(): Empties the specification list.
o RemoveElement(int): Removes an element from the specification list.
o RemoveElement(CATBaseUnknown_var&): Removes an element from the specification list.

Methods

o AddElement

public virtual AddElement( const ihElt_input)

Adds a new element to the specifications list.
Role: As yet the list handles only one element and this element should be a CATISketch.

Parameters:

ihElt: The added element.

o GetBody

public virtual GetBody(		`iFlags`,
		`ohBody`)

Gets the topological body corresponding to the profile.

Parameters:

iFlags: To specify computing options.
Legal values: If the profile contains a closed wire, 1 will create a face bounded by the wire in the returned body.
0 will disable this option.
ohBody: The returned body.

o GetBoundingBox

public virtual GetBoundingBox( oBox)

Gets the bounding box of the whole profile.

Parameters:

oBox: The bounding box.

o GetCenter

public virtual GetCenter( oPt)

Gets the mathematical center of the profile bounding box.

Parameters:

oPt: The center point.

o GetContourCount

public virtual GetContourCount(

)

Gets the number of contour defined by the specification list.

Returns:: The number of contour.

o GetElement

public virtual GetElement(		`iNb`,
		`ohElt_output`)

Gets an element of the specification list.

Parameters:

iNb: The index of the required element. Index 1 is for the first element.
ohElt: The required element.

o GetElementCount

public virtual GetElementCount(

)

Gets the number of specification elements used to define the profile.

Returns:: The number of elements.

o GetGeomPlane

public virtual GetGeomPlane( ohPln)

Gets the geometrical plane associated to the profile support.

Parameters:

ohPln: The plane.

o GetPlane

public virtual GetPlane( oPln)

Gets the mathematical plane corresponding to the support of the profile geometry.

Parameters:

oPln: The plane.

o GetSpecPlane

public virtual GetSpecPlane( ohPln_output)

Gets the specification plane which defines the profile support.

Parameters:

ohPln: The plane.

o RemoveAllElements

public virtual RemoveAllElements(

)

Empties the specification list.

o RemoveElement

public virtual RemoveElement( iNb)

Removes an element from the specification list.

Parameters:

iNb: The index of the element to be removed. Index 1 is for the first element.

o RemoveElement

public virtual RemoveElement( const ihElt_input)

Removes an element from the specification list.

Parameters:

ihElt: The element to be removed.

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