All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

PartInterfaces Interface CATIPrtProfile

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIPrtProfile
 

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


interface CATIPrtProfile

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(CATISpecObject_var&)
Adds a new element to the specifications list.
o CheckNumDomainsInProfile()
* @deprecated V5R15 Do not use
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,CATISpecObject_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(CATISpecObject_var&)
Gets the specification plane which defines the profile support.
o RemoveAllElements()
Empties the specification list.
o RemoveElement(CATISpecObject_var&)
Removes an element from the specification list.
o RemoveElement(int)
Removes an element from the specification list.

Methods


o AddElement
public virtual void AddElement( const CATISpecObject_var& ihElt) = 0
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 CheckNumDomainsInProfile
public virtual int CheckNumDomainsInProfile()= 0
* @deprecated V5R15 Do not use
o GetBody
public virtual void GetBody(int iFlags,
CATBody_var& ohBody) const = 0
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 void GetBoundingBox(CATMathBox& oBox) const = 0
Gets the bounding box of the whole profile.
Parameters:
oBox
The bounding box.
o GetCenter
public virtual void GetCenter(CATMathPoint& oPt) const = 0
Gets the mathematical center of the profile bounding box.
Parameters:
oPt
The center point.
o GetContourCount
public virtual int GetContourCount()const = 0
Gets the number of contour defined by the specification list.
Returns:
The number of contour.
o GetElement
public virtual void GetElement(int iNb,
CATISpecObject_var& ohElt) const = 0
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 int GetElementCount()const = 0
Gets the number of specification elements used to define the profile.
Returns:
The number of elements.
o GetGeomPlane
public virtual void GetGeomPlane(CATPlane_var& ohPln) const = 0
Gets the geometrical plane associated to the profile support.
Parameters:
ohPln
The plane.
o GetPlane
public virtual HRESULT GetPlane(CATMathPlane& oPln) const = 0
Gets the mathematical plane corresponding to the support of the profile geometry.
Parameters:
oPln
The plane.
o GetSpecPlane
public virtual void GetSpecPlane(CATISpecObject_var& ohPln) const = 0
Gets the specification plane which defines the profile support.
Parameters:
ohPln
The plane.
o RemoveAllElements
public virtual void RemoveAllElements()= 0
Empties the specification list.
o RemoveElement
public virtual void RemoveElement(CATISpecObject_var& ihElt) = 0
Removes an element from the specification list.
Parameters:
ihElt
The element to be removed.
o RemoveElement
public virtual void RemoveElement(int iNb) = 0
Removes an element from the specification list.
Parameters:
iNb
The index of the element to be removed. Index 1 is for the first element.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.