All Frameworks Class Hierarchy This Framework Indexes Previous Next

KnowledgeInterfaces Interface 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 Knowledge type (most of the cases) or eventually on an object.

Role: You can consult this interface to know the list of attributes on a Knowledge type (or an object implementing this interface).
This interface is used in KnowledgeExpert to provide the list of attributes on a type and an object.
This interface is multi-implemented.

See also:: , , ,

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 Knowledge type.

Methods

o FindByNLSName

public virtual FindByNLSName(	const	`iNLSName`,
		`oAttributeInfos`)

Returns information about the attribute whose NLS-name is specified as argument.

Parameters:

iNLSName: : the name of the attribute for which informations are required
oAttributeInfos: : the output informations about the attribute

Returns:

classic HRESULT

o FindByName

public virtual FindByName(	const	`iName`,
		`oAttributeInfos`)

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

Returns:

classic HRESULT

o List

public virtual List(		`oListOfAttributeInfos`,
		`recursively`	`= 1` )

Returns the list of informations on attributes held by the Knowledge type.

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

Returns:

classic HRESULT

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