All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamAnalysisConnector

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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:

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 HRESULT GetAllObjects(CATILinkableObject*& oPointedObject,
CATILinkableObject*& oPositionningObject) const = 0
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 HRESULT GetPointedObject(CATILinkableObject*& oExternalObject) const = 0
Retrieves the Pointed objectstored in the Connector.
Parameters:
oExternalObject
[out , CATBaseUnknown#Release] CATILinkableObject stored in the link.
o GetPointedSupportId
public virtual HRESULT GetPointedSupportId(SAM_SupportId& oType) const = 0
Retrieves support identifier of the pointed Object.
Parameters:
oType
SAM_SupportId of the pointed Object.
o GetPositionningObject
public virtual HRESULT GetPositionningObject(CATILinkableObject*& oExternalObject) const = 0
Retrieves the Positioning object stored in the Connector.
Parameters:
oExternalObject
[out , CATBaseUnknown#Release] CATILinkableObject stored in the link.
o GetPublicationConnector
public virtual int GetPublicationConnector(CATILinkableObject*& oPublication) = 0
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 CATBoolean IsLoaded()= 0
Indicates if pointed object is loaded in session.
Returns:
Informs if the connector is loaded
o IsSame
public virtual HRESULT IsSame(CATISamAnalysisConnector* iConnectorToCompare) = 0
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 HRESULT SetPointedObject(CATILinkableObject* iExternalObject) = 0
Associates a Pointed object with the Connector.
Parameters:
iExternalObject
CATILinkableObject to be stored in the link.
o SetPositionningObject
public virtual HRESULT SetPositionningObject(CATILinkableObject* iExternalObject) = 0
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

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