ObjectModelerBase PLMPublicLinkFacade
Usage: you must use this class as is. You should never derive it.
public class PLMPublicLinkFacade
Class representing a Link.
Role: This class is a Facade object providing access to a Link.
It gathers in a single place all operations and information gathering that can proceeded on a Link.
Constructor and Destructor Index
- o
PLMPublicLinkFacade()
- Constructs an empty PLMPublicLinkAccess.
- o
PLMPublicLinkFacade(PLMPublicLinkFacade&)
- Copy constructor.
- o
~PLMPublicLinkFacade()
- Destructor.
Method Index
- o
GetPointedComponentIdentifiers(CATListPtrCATIAdpPLMIdentificator&)
- Retrieves the identifiers of the PLM Components referenced by the Link.
- o
GetPointedObjectInContext(CATOmbObjectInContext_var&)
- Retrieves the pointed CATOmbObjectInContext instance value.
- o
IsSynchronized()
- Retrieves the Synchronization status of the Link.
- o
Synchronize()
- Synchronize the link (See IsSynchronized).
- o
operator =(PLMPublicLinkFacade&)
- Assignment operator.
Constructor and Destructor
o PLMPublicLinkFacade
| public PLMPublicLinkFacade( | ) |
-
Constructs an empty PLMPublicLinkAccess.
o PLMPublicLinkFacade
| public PLMPublicLinkFacade( | const | iLinkFacade) |
-
Copy constructor.
Role: This method creates an exact copy of a Link Facade.
- Parameters:
-
- iLinkFacade
- [in] The Facade to copy.
o ~PLMPublicLinkFacade
| public virtual ~PLMPublicLinkFacade( | ) |
-
Destructor.
Methods
o GetPointedComponentIdentifiers
| public GetPointedComponentIdentifiers( | | oIdentifiers) |
-
Retrieves the identifiers of the PLM Components referenced by the Link.
See
.
- Parameters:
-
- oIdentifiers
- [out] A list that contains the identifiers. Use
to load it if necessary.
Don't forget to call
on each returned identifiers when useless.
In case of failure, list will be empty.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The exhaustive non empty list of identifiers has been retrieved.
- E_PLMLINK_INVALIDFACADE
- The Facade is not valid.
- E_PLMLINK_INTRACOMPONENTLINK
- The Link is internal to the pointing PLM Component.
- E_UNEXPECTED
- The query failed for any other reason.
o GetPointedObjectInContext
| public GetPointedObjectInContext( | | oObjectInContext) |
-
Retrieves the pointed CATOmbObjectInContext instance value.
See
.
- Parameters:
-
- oObjectInContext
- [out] A smart pointer to the object in context retrieved.
In case of failure, NULL will be assigned to it.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- A non NULL object in context has been retrieved.
- E_PLMLINK_INVALIDFACADE
- The Facade is not valid.
- Other
- Other hresults can occur if the set pointed PLM component could not be loaded or does not exist any more.
- In these cases, more information on the cause can be obtained with
.
o IsSynchronized
-
Retrieves the Synchronization status of the Link.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The link is synchronized.
- S_FALSE
- The link is not synchronized.
- E_PLMLINK_NOSYNCHRONIZATIONBEHAVIOR
- No Synchronization behavior is defined on the Link.
- E_PLMLINK_INVALIDFACADE
- The Facade is not valid.
- E_UNEXPECTED
- The query failed for any other reason.
o Synchronize
-
Synchronize the link (See IsSynchronized).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The link synchronization succeeded.
- S_FALSE
- The link is already synchronized.
- E_PLMLINK_NOSYNCHRONIZATIONBEHAVIOR
- No Synchronization behavior is defined on the Link.
- E_PLMLINK_INVALIDFACADE
- The Facade is not valid.
- E_UNEXPECTED
- The query failed for any other reason.
o operator =
| public operator =( | const | iLinkFacade) |
-
Assignment operator.
Role: This method transforms this Facade to an exact copy of another Feature Facade.
- Parameters:
-
- iLinkFacade
- [in] The Facade to copy.
- Returns:
- This Facade.
This object is included in the file: PLMPublicLinkFacade.h
If needed, your Imakefile.mk should include the module: CATObjectModelerBase
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.