All Frameworks  Class Hierarchy  This Framework  Indexes   

MecModInterfaces Interface CATIMmiMechanicalImportApplicative

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


interface CATIMmiMechanicalImportApplicative

Interface to manage an applicative mechanical import (or external reference).
Role: This interface is implemented on external references. It is used to retrieve link information on a mechanical import (which is obtained by copy with link between two parts).
An authentication process is required prior to retrieving link information.
Before calling any method of this interface, you have to init the authentication mechanism in either of two ways :


Method Index


o BreakLink(GUID&)
Breaks a link associated to an applicative mechanical import.
o GetPointedElement(CATBaseUnknown_var&)
Retrieves the pointed element.
o GetSourceProduct(CATBaseUnknown_var&)
Retrieves the product instance which aggregates an instance of the representation of the pointed element.
o IsPointedElementLoaded(CATBoolean&)
Retrieves the loading status of the pointed document.
o LoadPointedElement()
Loads the pointed document containing the pointed element.
o SetApplicativeId(GUID&)
Sets the applicative identifier.
o SetPointedElementClientId(CATUnicodeString&)
Sets the client identifier of the pointed element.

Methods


o BreakLink
public virtual BreakLink( const iApplicativeId)
Breaks a link associated to an applicative mechanical import.
Role: Removes the link between the external reference and its reference.
Parameters:
iApplicativeId
the applicative identifier that is associated to the mechanical import
Returns:
S_OK
The link has been successfully removed.
E_FAIL
The applicative identifier isn't valid or the method has unexpectedly failed.
o GetPointedElement
public virtual GetPointedElement( oPointedElement)
Retrieves the pointed element.
Parameters:
oPointedElement
A pointer to the pointed element. It may be a subelement or a feature.
Returns:
S_OK if pointed element is returned
E_FAIL
o GetSourceProduct
public virtual GetSourceProduct( oSourceProduct)
Retrieves the product instance which aggregates an instance of the representation of the pointed element.
Parameters:
oSourceProduct
a pointer to the source product instance
Returns:
S_OK if the source product is found
E_FAIL
o IsPointedElementLoaded
public virtual IsPointedElementLoaded( oLoaded)
Retrieves the loading status of the pointed document.
Role: This method is used to retrieve the loading status of the pointed document when SetApplicativeId is called before.
It always fails if SetPointedElementClientId is used instead of SetApplicativeId.
Parameters:
oLoaded
TRUE if the pointed document is loaded otherwise FALSE
Returns:
S_OK if the information is correctly retrieved.
E_FAIL if SetApplicativeId was not previously successfully called. For SetPointedElementClientId, irrespective of its success or failure.
o LoadPointedElement
public virtual LoadPointedElement()
Loads the pointed document containing the pointed element.
Role: This method is used to load the document that contains the pointed element when SetApplicativeId is called before.
It always fails if SetPointedElementClientId is used instead of SetApplicativeId.
Returns:
S_OK if the document is effectively loaded.
S_FALSE if the document is already loaded.
E_FAIL if SetApplicativeId was not previously successfully called. For SetPointedElementClientId, irrespective of its success or failure.
o SetApplicativeId
public virtual SetApplicativeId( const iApplicativeId)
Sets the applicative identifier.
Role: Inits the authentication mechanism allowing to retrieve informations on the mechanical import. You have to give here the identifier of the mechanical import. If you don't give the correct identifier, all methods of this interface will fail.
Parameters:
iApplicativeId
a unique identifier : the applicative identifier
Returns:
S_OK if the applicative identifier matches the identifier of the mechanical import
E_FAIL otherwise
o SetPointedElementClientId
public virtual SetPointedElementClientId( const iClientId)
Sets the client identifier of the pointed element.
Role: Inits the authentication mechanism allowing to retrieve informations on the mechanical import. You have to give here the client id of the catalog of the pointed element. If you don't give the correct identifier, all methods of this interface will fail.
The pointed element must be loaded before calling this method. In order to load it, you have to know the pointed component and open it (you cannot use LoadPointedElement to load it).
Parameters:
iClientId
the client id of the catalog corresponding to the pointed element.
Returns:
S_OK if the client id matches the identifier of the StartUp Catalog of the pointed element
E_FAIL if it does not or if the pointed element is not loaded

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

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