CATTTRSUseItf Interface CATITTRS
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATITTRS
Interface representing TTRS ( Technologically and Topologically Related Surfaces ).
Role: TTRS add technological and topological pieces of information to surface associations.
Method Index
- o
AddComponent(CATBaseUnknown_var&)
- Adds a component to a TTRS.
- o
AddComponentAndReturnExistingTTRS(CATBaseUnknown_var&,CATITTRS_var&)
- Adds a component to a TTRS.
- o
GetComponents(CATLISTV(CATBaseUnknown_var)&)
- Gets the list of the 2 to n components of the TTRS.
- o
GetMRGE(CATMathRGE*&)
- Gets the MRGE ( Minimum Representation Geometrical Element ) of the TTRS.
- o
GetNature()
- Returns the nature of the TTRS.
- o
GetRepresentedTTRS(CATITTRS**)
- Retrieves the represented TTRS.
- o
GetRepresentedTTRSLink(CATMmrTTRSRepresented*)
- Retrieves the nature of the link with the represented TTRS.
- o
GetTTRSClass(CATMmrTTRSClass&)
- Gets the class of the TTRS.
- o
GetValidityState()
- Returns the state of validity of the TTRS.
- o
RemoveComponent(CATBaseUnknown_var&)
- Removes a component from a TTRS.
- o
RemoveComponentAndReturnExistingTTRS(CATBaseUnknown_var&,CATITTRS_var&)
- Removes a component from a TTRS.
- o
SetRepresentedTTRS(CATITTRS*)
- Sets the represented TTRS.
- o
SetRepresentedTTRSLink(CATMmrTTRSRepresented)
- Sets the nature fo teh link with the represented TTRS.
Methods
o AddComponent
| public virtual AddComponent( | | iNewComponent) |
-
Adds a component to a TTRS.
- Parameters:
-
- iNewComponent
-
- either a RGE (Support TTRS )
- or a TTRS ( Node TTRS )
- Returns:
- S_OK: if the Component has been added
S_FALSE: if the resulting TTRS already exists in the model, in this case use the method AddComponentAndReturnExistingTTRS which returns the existing TTRS
E_FAIL: otherwise
o AddComponentAndReturnExistingTTRS
| public virtual AddComponentAndReturnExistingTTRS( | | ispNewComponent, |
| | ospExistingTTRS) |
-
Adds a component to a TTRS.
- Parameters:
-
- ispNewComponent
-
- either a RGE (Support TTRS )
- or a TTRS ( Node TTRS )
- ospExistingTTRS
- Existing TTRS
- Returns:
- S_OK: if the Component has been added
S_FALSE: if the resulting TTRS already exists in the model, the component isn’t added and the existing TTRS is returned using the argument ospExistingTTRS
E_FAIL: otherwise
o GetComponents
| public virtual GetComponents( | | oListe) |
-
Gets the list of the 2 to n components of the TTRS.
- Parameters:
-
- oListe
- The list of components.
- either 1 to n RGEs ( Support TTRS )
- or 2 to n TTRS ( Node TTRS )
o GetMRGE
| public virtual GetMRGE( | | oMrge) |
-
Gets the MRGE ( Minimum Representation Geometrical Element ) of the TTRS.
- Parameters:
-
- oMrge
- The MRGE of the TTRS.
o GetNature
| public virtual GetNature( | ) |
-
Returns the nature of the TTRS.
Legal values:
Support if it directly represents geometry.
Node if it represents higher level TTRS.
o GetRepresentedTTRS
| public virtual GetRepresentedTTRS( | | opiTTRS) |
-
Retrieves the represented TTRS.
The represented TTRS is a TTRS which is represented by this.
- Parameters:
-
- opiTTRS
- The TTRS which is represented by this.
o GetRepresentedTTRSLink
| public virtual GetRepresentedTTRSLink( | | oLinkNature) |
-
Retrieves the nature of the link with the represented TTRS.
- Parameters:
-
- oLinkNature
- Nature of the link.
o GetTTRSClass
| public virtual GetTTRSClass( | | oTTRSClass) |
-
Gets the class of the TTRS.
- Parameters:
-
- oTTRSClass
- The class of the TTRS.
Legal values: Spherical, Planar, Cylindrical, Revolute, Prismatic, Complex.
o GetValidityState
| public virtual GetValidityState( | ) |
-
Returns the state of validity of the TTRS.
- Returns:
- The call status.
Legal values: CATMmrTTRSValidity_OK, CATMmrTTRSValidity_DestroyedComp,
CATMmrTTRSValidity_ModifClass, CATMmrTTRSValidity_ModifAssocCase,
CATMmrTTRSValidity_ModifFoS, CATMmrTTRSValidity_InvalidComp, CATMmrTTRSValidity_Unresolved.
o RemoveComponent
| public virtual RemoveComponent( | | iComponent) |
-
Removes a component from a TTRS.
- Parameters:
-
- iComponent
- The component to be removed.
- Returns:
- S_OK: if the Component has been removed
S_FALSE: if the resulting TTRS already exists in the model, in this case use the method RemoveComponentAndReturnExistingTTRS which returns the existing TTRS
E_FAIL: otherwise
o RemoveComponentAndReturnExistingTTRS
| public virtual RemoveComponentAndReturnExistingTTRS( | | ispComponent, |
| | ospExistingTTRS) |
-
Removes a component from a TTRS.
- Parameters:
-
- ispComponent
- The component to be removed.
- ospExistingTTRS
- Existing TTRS
- Returns:
- S_OK: if the Component has been removed
S_FALSE: if the resulting TTRS already exists in the model, the component isn’t removed and the existing TTRS is returned using the argument ospExistingTTRS
E_FAIL: otherwise
o SetRepresentedTTRS
| public virtual SetRepresentedTTRS( | const | ipiTTRS) |
-
Sets the represented TTRS.
- Parameters:
-
- ipiTTRS
- The TTRS which is represented by this.
o SetRepresentedTTRSLink
| public virtual SetRepresentedTTRSLink( | const | iLinkNature) |
-
Sets the nature fo teh link with the represented TTRS.
- Parameters:
-
- iLinkNature
- Nature of the link.
This object is included in the file: CATITTRS.h
If needed, your Imakefile.mk should include the module: CATTTRSUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.