All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowledgeInterfaces Interface CATIAttributesDescription

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIAttributesDescription
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIAttributesDescription

Interface to describe the attributes on a type or an object.
Role: You can consult this interface to know the list of attributes on a type or an object implementing this interface.
You must implement this interface if you want to support this behaviour. You must implement it on types that have attributes. types implement CATIType.
If your object implements CATIDynamicAttributes, it has to implement this interface to return the list of dynamic attributes also. This interface is used in KnowledgeExpert to provide the list of attributes on a type and an object; In LiteralFeatures framework, you can find CATCkeInstanceAdapter which is an adapter of those interfaces on feature objects (see also CATCkeBasicAdapter which is the light ancestor (no attribute data) of CATCkeInstanceAdapter).

See also:
CATIInstance
See also:
CATIType
See also:
CATIValue
See also:
CATIInstance
See also:
CATIDynamicAttributes


Method Index


o FindByNLSName(CATUnicodeString&,CATAttributeInfos*&)
Returns information about the attribute whose NLS-name is specified as argument.
o FindByName(CATUnicodeString&,CATAttributeInfos*&)
Returns information about the attribute whose name is specified as argument.
o List(CATListValCATAttributeInfos*,boolean)
Returns the list of informations on attributes held by the instance.

Methods


o FindByNLSName
public virtual HRESULT FindByNLSName( const CATUnicodeString& iNLSName,
CATAttributeInfos*& oAttributeInfos)const = 0
Returns information about the attribute whose NLS-name is specified as argument.
Parameters:
iName
: the name of the attribute for which informations are required
oAttributeInfos
: the output informations about the attribute
o FindByName
public virtual HRESULT FindByName( const CATUnicodeString& iName,
CATAttributeInfos*& oAttributeInfos)const = 0
Returns information about the attribute whose name is specified as argument.
Parameters:
iName
: the name of the attribute for which informations are required
oAttributeInfos
: the output informations about the attribute. This object is allocated
o List
public virtual HRESULT List(CATListValCATAttributeInfos* oListOfAttributeInfos,
boolean recursively= 1 )const = 0
Returns the list of informations on attributes held by the instance.
Parameters:
oListOfAttributeInfos
: the list of informations on attributes
recursively
: if true, the output list will also contain the attributes given by the inheritance mechanism provided by CATIType

This object is included in the file: CATIAttributesDescription.h
If needed, your Imakefile.mk should include the module: KnowledgeItf

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