All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPlantShipInterfaces Interface CATIPspKweUserAttr

System.IUnknown
  |
  +---CATIPspKweUserAttr
 

Usage: you can reimplement this interface by deriving the supplied CATPspKweUserAttrAdapter adapter class.


interface CATIPspKweUserAttr

Interface to allow User defined computed attributes.
Role: To allow user to define computed attributes on exposed types for the in the plant ship applications. Implementations of this interface should derive from CATPspKweUserAttrAdapter. In order to define user computed attributes this interface should be implemented on the late type corresponding to Knowledgeware package name like PipingLayout, HVACLayout etc.

See also:
CATPspKweUserAttrAdapter


Method Index


o DefineKweUserAttr(CATString&,CATListValCATAttributeInfos&)
Defines a list of computed attributes for the input exposed type isTypeName.
o GetValue(CATIInstance*,CATUnicodeString&)
Returns the computed value of the iKey attribute on specified iObject.

Methods


o DefineKweUserAttr
public virtual HRESULT DefineKweUserAttr( const CATString& isTypeName,
CATListValCATAttributeInfos& olAttrInfos) = 0
Defines a list of computed attributes for the input exposed type isTypeName.
Parameters:
isTypeName
Exposed type
olAttrInfos
List of CATAttributeInfos
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetValue
public virtual CATIValue* GetValue(CATIInstance* ipiObject,
const CATUnicodeString& iKey) = 0
Returns the computed value of the iKey attribute on specified iObject.
Parameters:
ipiObject
Input object.
iKey
Computed attribute name.
Returns:
An CATIValue value. @see CATIValue

This object is included in the file: CATIPspKweUserAttr.h

Copyright © 2003, Dassault Systèmes. All rights reserved.