PLMLibraryNavUseItf Interface PLMICLGItem
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface PLMICLGItem
Interface representing Item which is a component classified in a Library.
Role: A Library is a tree structure of class in which components
are classified.
The interface enables to get the properties of a classified component.
Method Index
- o
GetFinalObject(CATBaseUnknown*&)
- Returns the classified object pointed by the Item.
- o
GetFinalObject(CATIAdpPLMIdentificator*&)
- Returns the classified PLMComponent pointed by the Item.
- o
GetItemType(PLMICLGItem::ItemType&)
- Return the type of pointed item.
- o
GetKeywordValue(CATUnicodeString&,CATUnicodeString&)
- Retrieves the value of a keyword of the current Item (string).
- o
GetName(CATUnicodeString&)
- Get the name of Item.
Enumerated Type Index
- o
ItemType
- Type of classified components.
Methods
o GetFinalObject
| public virtual GetFinalObject( | | oObj) |
-
Returns the classified object pointed by the Item.
RoleThis method also work for non PLM objects like features.
It is useful for application to get the object to use : some applications are classifying proxies.
It resolves the proxy and gives the proxified object.
If there is no proxy, it returns the classified object itself.
- Parameters:
-
- oObj
- The linked object.
- Returns:
-
- S_OK if the classified object was successfully retrieved.
- E_FAIL otherwise.
o GetFinalObject
| public virtual GetFinalObject( | | oComponent) |
-
Returns the classified PLMComponent pointed by the Item.
RoleThis method will only work for PLM objects.
It is useful for application to get the object to use : some applications are classifying proxies.
It resolves the proxy and gives the proxified object.
If there is no proxy, it returns the classified object itself.
- Parameters:
-
- oComponent
- The linked object.
- Returns:
-
- S_OK if the classified object was successfully retrieved.
- E_FAIL otherwise.
o GetItemType
| public virtual GetItemType( | | oType) |
-
Return the type of pointed item.
- Parameters:
-
- oType
- The type of pointed item
- Returns:
-
- S_OK if the type of pointed item was successfully retrieved.
- E_FAIL otherwise.
o GetKeywordValue
| public virtual GetKeywordValue( | const | iName, |
| | oValue) |
-
Retrieves the value of a keyword of the current Item (string).
- Parameters:
-
- iName
- The name of the Keyword to retrieve.
- oValue
- The Value of the Keyword as a String.
- Returns:
-
- S_OK if the value of Keyword was successfully retrieved.
- E_FAIL otherwise.
o GetName
| public virtual GetName( | | oName) |
-
Get the name of Item.
- Parameters:
-
- oName
- The name of Item.
- Returns:
-
- S_OK if the name of Item was successfully retrieved.
- E_FAIL otherwise.
Enumerated Types
o ItemType
-
enum ItemType {
Unset,
Feature,
Document,
ComponentFamily,
Reference,
Representation,
Others
}
Type of classified components.
- Parameters:
-
- Unset
- Item is not set.
- Feature
- Feature object
- Document
- Document object
- ComponentFamily
- Component family
- Reference
- Reference
- Representation
- Representation
- Others
- All other types excepting the following enum types
This object is included in the file: PLMICLGItem.h
If needed, your Imakefile.mk should include the module: PLMLibraryNavUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.