All Frameworks Class Hierarchy This Framework Indexes
MecModInterfaces Interface CATIPartRequest
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPartRequest
Interface to retrieve the geometrical features sets of the Part document.
Role:With this interface and the CATIPrtPart interface, you have all the methods to manage the Part feature.
This interface enables you to retrieve the geometrical features sets aggregated directely or indirectly
by the Part feature.
These geometrical features sets can be:
- Surfacic features sets:
- Geometrical Set (or GS) (startup: GSMTool)
- Ordered Geometrical Set (or OGS) (startup: GSMTool)
Bodies:
- Solid features set (user name: Body) (startup: MechanicalTool)
- Solid and Surfacic features sets (user name: Body) (startup: HybridBody)
Refer to
CATIMechanicalRootFactory interface for explanation about geometrical features sets creation rules.
- Retrieving the Surfacic features sets (OGS or GS)
Refer to
CATIMechanicalRootFactory for description of aggregation rules of Surfacic features sets.
With
GetSurfBodies you retrieve all the Surfacic features sets of the Part document except sub-OGS (OGS aggregated by antoher geometrical features set). It means that for OGS,
you retrieve only the root-OGS (OGS aggregated at the Part level)
- Retrieving the Bodies (startup: MechanicalTool or HybridBody)
Refer to
CATIMechanicalRootFactory for description of aggregation rules of Bodies.
However, in the specification tree, a Body can appear under another Body but this is through a boolean operation.
In that case, the Body is said as being operated by the boolean operation.
An operated body is the second operand of a boolean operation between two Bodies.
Refer to the CATIPrtBooleanFactory or CATIPrtTrimFactory interfaces
of the PartInterfaces framework to have more details about the boolean operations.
The
GetSolidBodies method allows you to retrieve all the Bodies that you see at the Part level (or root Bodies).
You don't retrieve operated Bodies and Bodies aggregated in an OGS with this method.
All the methods of this interface need a context (It is a difference between
the
CATIDescendants interface). The context is the means to have for the same design several representations. There is a default context represented by
the MfDefault3DView string value.
This interface is implemented on the Part feature that you retrieve by using the
CATIPrtContainer.GetPart method on the specification container (see
CATIContainerOfDocument )
- See also:
- CATIBodyRequest, CATIMechanicalRootFactory
Method Index
- o
GetAllBodies(CATUnicodeString&,CATListValCATBaseUnknown_var&)
- Retrieves all root Bodies, all GS and all root OGS.
- o
GetDirectBodiesChangeEvent()
- Retrieves the event that is dispatched when the list of root geometrical feature sets change.
- o
GetDirectBodies(CATUnicodeString&,CATListValCATBaseUnknown_var&)
- Retrieves all root geometrical feature sets (all root Bodies,all root OGS and all root GS).
- o
GetMainBody(CATUnicodeString&,CATBaseUnknown_var&)
- Retrieves the main Body.
- o
GetSolidBodies(CATUnicodeString&,CATListValCATBaseUnknown_var&)
- Retrieves all root Bodies.
- o
GetSurfBodies(CATUnicodeString&,CATListValCATBaseUnknown_var&)
- Retrieves all GS and all root OGS.
Methods
o GetAllBodies
| public virtual GetAllBodies( | const | iViewContext, |
| | oBodies) |
-
Retrieves all root Bodies, all GS and all root OGS.
- Parameters:
-
- iViewContext
- The context of view:
Legal values:
- "MfUnfoldedView" or "Unfolded": for an unfolded
view in Sheet Metal applications,
- "MfDefault3DView": for the default 3D view,
- otherwise: the default 3D view.
- oBodies
- The list = list of
GetSurfBodies + list of
GetSolidBodies
o GetDirectBodiesChangeEvent
| public virtual GetDirectBodiesChangeEvent( | ) |
-
Retrieves the event that is dispatched when the list of root geometrical feature sets change.
Example:Here is an example of subscription the DirectBodiesChange event. pPartRequestonPart is a
CATIPartRequest interface pointer on the Part feature and "this" is the object that wants to subscribe to the event.
CATBaseUnknown* pBUOnPart = NULL;
pPartRequestOnPart->QueryInterface(IID_CATBaseUnknown,(void**)&pBUOnPart);
...
::AddCallback(this,pBUOnPart,pPartRequestOnPart->GetDirectBodiesChangeEvent(),(CATSubscriberMethod)&MfClass::MyMethodCB)
...
Don't forget to unsubscribe.
o GetDirectBodies
| public virtual GetDirectBodies( | const | iViewContext, |
| | oBodies) |
-
Retrieves all root geometrical feature sets (all root Bodies,all root OGS and all root GS).
- Parameters:
-
- iViewContext
- The context of view:
Legal values:
- "MfUnfoldedView" or "Unfolded": for an unfolded
view in Sheet Metal applications,
- "MfDefault3DView": for the default 3D view,
- otherwise: the default 3D view.
- oBodies
- A list containing the root geometrical feature sets.
o GetMainBody
| public virtual GetMainBody( | const | iViewContext, |
| | oPartBody) |
-
Retrieves the main Body. The main Body is unique in a Part document.
The default created Body after creation of a Part document is the main Body.
It can be changed afterwards thanks to the "Change Part Body" command.
- Parameters:
-
- iViewContext
- The context of view:
Legal values:
- "MfUnfoldedView" or "Unfolded": for an unfolded
view in Sheet Metal applications,
- "MfDefault3DView": for the default 3D view,
- otherwise: the default 3D view.
- oPartBody
- The Body which is the main Body.
o GetSolidBodies
| public virtual GetSolidBodies( | const | iViewContext, |
| | oBodies) |
-
Retrieves all root Bodies.
- Parameters:
-
- iViewContext
- The context of view:
Legal values:
- "MfUnfoldedView" or "Unfolded": for an unfolded
view in Sheet Metal applications,
- "MfDefault3DView": for the default 3D view,
- otherwise: the default 3D view.
- oBodies
- The list of root Bodies.
o GetSurfBodies
| public virtual GetSurfBodies( | const | iViewContext, |
| | oBodies) |
-
Retrieves all GS and all root OGS.
- Parameters:
-
- iViewContext
- The context of view:
Legal values:
- "MfUnfoldedView" or "Unfolded": for an unfolded
view in Sheet Metal applications,
- "MfDefault3DView": for the default 3D view,
- otherwise: the default 3D view.
- oBodies
- The list of all all GS and all root OGS features contained in the Part document.
This object is included in the file: CATIPartRequest.h
If needed, your Imakefile.mk should include the module: CATMecModInterfaces