All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisInterfaces Interface CATISamAnalysisConnector
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISamAnalysisConnector
Interface to manage links with Design Data.
Role: Interface designed to manage Connector behavior.
This element allow to define and extract an associative link.
Note: This link is build with two information's:
- The Pointed Object (BrepAccess Object, Mechanicalfeature....)
- The Positioning Object is the CATIProduct in which the Linkable is defined.
The intent of this link is to identify the instance on the Pointed Object and to manage the change of
position that can occur in a product structure document.
To create a connector, use the CATISamAnalysisModelFactory.CreateConnector
Method Index
- o
GetAllObjects(CATILinkableObject*&,CATILinkableObject*&)
- Retrieves both Positionning and pointing object stored in the Connector.
- o
GetPointedObject(CATILinkableObject*&)
- Retrieves the Pointed objectstored in the Connector.
- o
GetPointedSupportId(SAM_SupportId&)
- Retrieves support identifier of the pointed Object.
- o
GetPositionningObject(CATILinkableObject*&)
- Retrieves the Positioning object stored in the Connector.
- o
GetPublicationConnector(CATILinkableObject*&)
- Retrieves if the connector is managed by publication.
- o
IsLoaded()
- Indicates if pointed object is loaded in session.
- o
IsSame(CATISamAnalysisConnector*)
- Method to compare a given connector to the current one.
- o
SetPointedObject(CATILinkableObject*)
- Associates a Pointed object with the Connector.
- o
SetPositionningObject(CATILinkableObject*)
- Associates a Positioning object with the Connector.
Methods
o GetAllObjects
| public virtual GetAllObjects( | | oPointedObject, |
| | oPositionningObject) |
-
Retrieves both Positionning and pointing object stored in the Connector.
- Parameters:
-
- oPointedObject
- [out , CATBaseUnknown#Release] CATILinkableObject stored in the link.
- oPositionningObject
- [out , CATBaseUnknown#Release] CATILinkableObject stored in the link.
o GetPointedObject
| public virtual GetPointedObject( | | oExternalObject) |
-
Retrieves the Pointed objectstored in the Connector.
- Parameters:
-
- oExternalObject
- [out , CATBaseUnknown#Release] CATILinkableObject stored in the link.
o GetPointedSupportId
| public virtual GetPointedSupportId( | | oType) |
-
Retrieves support identifier of the pointed Object.
- Parameters:
-
- oType
- SAM_SupportId of the pointed Object.
o GetPositionningObject
| public virtual GetPositionningObject( | | oExternalObject) |
-
Retrieves the Positioning object stored in the Connector.
- Parameters:
-
- oExternalObject
- [out , CATBaseUnknown#Release] CATILinkableObject stored in the link.
o GetPublicationConnector
| public virtual GetPublicationConnector( | | oPublication) |
-
Retrieves if the connector is managed by publication.
- Parameters:
-
- oPublication
- [out , CATBaseUnknown#Release] The ProductStructure Object that manage the Publication.
This object implements CATIPrdPublication.
- Returns:
- Informs if the connector is based on Publishing.
Legal values:
- 0 Not based on publishing, direct link on object is done.
- 1 Based on publishing.
o IsLoaded
| public virtual IsLoaded( | ) |
-
Indicates if pointed object is loaded in session.
- Returns:
- Informs if the connector is loaded
o IsSame
| public virtual IsSame( | | iConnectorToCompare) |
-
Method to compare a given connector to the current one.
- Parameters:
-
- iConnectorToCompare
- a Pointer on the connector to compare.
- Returns:
- HRESULT
- S_OK : connectors are identical.
- S_FALSE : connectors are different.
o SetPointedObject
| public virtual SetPointedObject( | | iExternalObject) |
-
Associates a Pointed object with the Connector.
- Parameters:
-
- iExternalObject
- CATILinkableObject to be stored in the link.
o SetPositionningObject
| public virtual SetPositionningObject( | | iExternalObject) |
-
Associates a Positioning object with the Connector.
- Parameters:
-
- iExternalObject
- CATILinkableObject to be stored in the link.
This object is included in the file: CATISamAnalysisConnector.h
If needed, your Imakefile.mk should include the module: CATAnalysisInterface