CATPLMIdentificationAccess Interface CATIAdpPLMIdentificator
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIAdpPLMIdentificator
Interface representing identificator of PLM components.
Role Components that implement this interface are
session objects carrying information to uniquely identify PLM Components in the database.
Method Index
- o
ComputeHashKey()
- ComputeHashKey.
- o
GetAdpType(CATIAdpType*&)
- Returns the PLM Class type.
- o
IsEqual(CATIAdpPLMIdentificator*,CATBoolean&)
- PLM Component comparison operator.
- o
IsValidForRemoteUsage(CATBoolean&)
- Returns the PLM Component identificator validity.
Methods
o ComputeHashKey
| public virtual ComputeHashKey( | ) |
-
ComputeHashKey.
Role: Get Distribution Key.
- Parameters:
-
- oDistributionKey
- [out] Distribution Key result.
- Returns:
-
S_OK if DistributionKey could be provided.
E_FAIL if the test could not be performed.
o GetAdpType
| public virtual GetAdpType( | | oAdpType) |
-
Returns the PLM Class type.
- Parameters:
-
- oAdpType
- [out, CATBaseUnknown#Release] The returned type (to be released)
- Returns:
-
-
S_OK - Success
-
E_FAIL - Failure
o IsEqual
| public virtual IsEqual( | | iToCompare, |
| | oIsEqual) |
-
PLM Component comparison operator.
Role: Checks equality between two Identificators.
- Parameters:
-
- iToCompare
- [in] The identificator to compare.
- oIsEqual
- [out] Equality result.
- Returns:
-
S_OK if the test could be performed.
E_FAIL if the test could not be performed.
o IsValidForRemoteUsage
| public virtual IsValidForRemoteUsage( | | oValidForRemoteUsage) |
-
Returns the PLM Component identificator validity.
Role:
A PLM Component identificator is always valid to make PLM Component comparison (
) or to retrieve an hash table key (
). But if the PLM Component has never been saved in database (repository), remote (short transactions) operations like Query/Open/Expand/versioning
are not possible.
Once the PLM Component is saved, you must retrieve a new PLM Component identificator pointer
(using
or using Query services) to handle a new and valid interface pointer.
- Parameters:
-
- oValidForRemoteUsage
- The validity flag.
- TRUE if Identificator is complete and valid in repository
meaning : it has been handle after a Query/Open/Expand/Save
-
- FALSE if Identificator is partially defined and not valid in repository
meaning : it has been handle from a newly created object not yet saved once
-
- Returns:
-
-
S_OK - Success
-
E_FAIL - Failure
This object is included in the file: CATIAdpPLMIdentificator.h
If needed, your Imakefile.mk should include the module: CATPLMIdentificationAccess
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.