KnowledgeInterfaces Interface CATICkeObject
Usage: you can reimplement this interface by deriving the supplied CATKweObjectAdapter adapter class.
interface CATICkeObject
Interface representing an object that can be manipulated in the Knowledge language.
Role: The objective of this interface is to be used to pass Knowledge objects as arguments of methods.
Components that implement CATICkeObject are PLM objects, but also objects in representations (features).
To read and write attributes of a PLM object, please refer to the following services:
,
BOA information: this interface CANNOT be implemented
using the BOA (Basic Object Adapter).
To know more about the BOA, refer to the CAA Encyclopedia home page.
Click Middleware at the bottom left, then click the Object Modeler tab page.
Several articles deal with the BOA.
Method Index
- o
GetLogicalName(CATUnicodeString&)
- Returns the Logical name of the object.
- o
IsPublic()
- Indicates if this object provides access to its simple attributes through generic methods CATCkeObjectAttrReadServices and CATCkeObjectAttrWriteServices.
- o
SetLogicalName(CATUnicodeString&)
- Sets the Logical name of the object.
Methods
o GetLogicalName
| public virtual GetLogicalName( | | oLogicalName) |
-
Returns the Logical name of the object. The logical name is a name that the end-user can give (modify) and that has no constraint of unicity.
Usually the logical name corresponds to CATIAlias::GetAlias method.
For objects in representation, it is usually sufficient. For PLM objects CATIAlias has been used to provide a computed name. That's why it cannot be used for logical name implementation.
- Parameters:
-
- oLogicalName
- Logical name in output
- Returns:
-
- E_ACCESSDENIED if the logical name cannot be read.
- E_FAIL if the logical name cannot be read.
- S_OK if the logical name has been read successfully.
o IsPublic
| public virtual IsPublic( | ) |
-
Indicates if this object provides access to its simple attributes through generic methods CATCkeObjectAttrReadServices and CATCkeObjectAttrWriteServices.
- Returns:
- TRUE if this object provides access to its simple attributes through generic methods.
o SetLogicalName
| public virtual SetLogicalName( | const | iLogicalName) |
-
Sets the Logical name of the object. The logical name is a name that the end-user can give (modify) and that has no constraint of unicity.
Usually the logical name corresponds to CATIAlias::SetAlias method.
For objects in representation, it is usually sufficient. For PLM objects CATIAlias has been used to provide a computed name. That's why it cannot be used for logical name implementation.
- Parameters:
-
- iLogicalName
- Logical name in input
- Returns:
-
- E_ACCESSDENIED if the valuation has failed (read only attribute, object not editable).
- E_FAIL if the logical name cannot be set.
- S_OK if the logical name has been set successfully.
This object is included in the file: CATICkeObject.h
If needed, your Imakefile.mk should include the module: KnowledgeItf
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.