CATPLMIntegrationUse CATAdpPLMComponentUniqueKey
Usage: you must use this class as is. You should never derive it.
public class CATAdpPLMComponentUniqueKey
Class defining the Unique Key of a Component.
Role: Provides a Unique Key enabling to identify a Component in the Database.
Constructor and Destructor Index
- o
CATAdpPLMComponentUniqueKey()
-
- o
CATAdpPLMComponentUniqueKey(CATAdpPLMComponentUniqueKey&)
-
- o
~CATAdpPLMComponentUniqueKey()
-
Method Index
- o
BuildFromStream(CATUnicodeString&)
- Build a Unique Key from a String stream.
- o
Display(CATUnicodeString&)
- Get a displayable value of the complete Unique Key.
- o
GetUniqueKeyId(CATUnicodeString&)
- Get the Unique Key identification.
- o
MoreInformation(CATAdpPLMComponentInfos&)
- Get an exteded access to the Unique Key content.
- o
Stream(CATUnicodeString&)
- Get the Unique Key as a String stream.
- o
UnicityGuarantee()
- Determines if the Unique Key guarantees the Unicity of the associated Component or not.
- o
operator=(CATAdpPLMComponentUniqueKey&)
-
Constructor and Destructor
o CATAdpPLMComponentUniqueKey
| public CATAdpPLMComponentUniqueKey( | ) |
-
o CATAdpPLMComponentUniqueKey
| public CATAdpPLMComponentUniqueKey( | const | iKey) |
-
o ~CATAdpPLMComponentUniqueKey
| public virtual ~CATAdpPLMComponentUniqueKey( | ) |
-
Methods
o BuildFromStream
| public BuildFromStream( | const | iSerialized) |
-
Build a Unique Key from a String stream.
Role: This method enables to create a Unique Key given a
stream.
- Parameters:
-
- iSerialized
- [in] The String stream which should be used to build the Unique Key.
E_INVALIDARG is returned if an invalid string is provided.
- Returns:
-
S_OK if the Unique Key was successfully built
E_FAIL if an error occured.
o Display
| public Display( | | oDisplayed) |
-
Get a displayable value of the complete Unique Key.
Role: This method enables to obtain a displayable
for the Unique Key.
- It is strongly recomended not to extract infos from this value since the dump format can be modified at any moment.
- Parameters:
-
- oDisplayed
- [out] The displayable Unique Key.
- Returns:
-
S_OK if the Unique Key was successfully computed for display.
E_FAIL if an error occured.
o GetUniqueKeyId
| public GetUniqueKeyId( | | oUKId) |
-
Get the Unique Key identification.
Role: This method gives the Unique Key Id on which the Unique Key is built.
- Parameters:
-
- oUKId
- [out] The Unique Key Id.
- Returns:
-
S_OK if the Unique Key Id is returned.
E_FAIL if an error occured.
o MoreInformation
| public MoreInformation( | | oComponentInfos) |
-
Get an exteded access to the Unique Key content.
Role: This method enables to obtain a
access to the content of the Unique Key.
- Parameters:
-
- oComponentInfos
- [out] The Unique Key content.
- Returns:
-
S_OK if the Unique Key was successfully introspected.
E_FAIL if an error occured.
o Stream
| public Stream( | | oSerialized) |
-
Get the Unique Key as a String stream.
Role: This method enables to serialize the Unique Key to a
.
- The structure of the
is internally defined.
- No interpretation of the content of the
should be made. It can change at any time.
- Parameters:
-
- oSerialized
- [out] The serialized Unique Key.
- Returns:
-
S_OK if the Unique Key was successfully serialized.
E_FAIL if an error occured.
o UnicityGuarantee
| public UnicityGuarantee( | ) |
-
Determines if the Unique Key guarantees the Unicity of the associated Component or not.
Role: This method enables to know if the built Unique Key guarantees the unicity of the result when looking for a component in the database.
- Returns:
-
S_OK if the Unique Key guarantees the Unicity of the solution
S_FALSE if the Unique Key does not completely guarantee the Unicity of the solution
E_FAIL if an error occured.
o operator=
| public operator=( | const | iKey) |
-
This object is included in the file: CATAdpPLMComponentUniqueKey.h
If needed, your Imakefile.mk should include the module: CATPLMIntegrationUse
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.