All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowledgeInterfaces Class CATAttributeInfos

CATAttributeInfos
 

Usage: you must use this class as is. You should never derive it.


public class CATAttributeInfos

Class to be used to define attributes of CATIType .

See also:
CATIType
See also:
CATITypeDictionary.CreateType
See also:
CATIInstance


Constructor and Destructor Index


o CATAttributeInfos(CATAttributeInfos&)
copy constructor
o CATAttributeInfos(CATIType_var&,CATUnicodeString&,CATUnicodeString&,boolean,boolean,boolean,CATUnicodeString&)
Constructor.
o ~CATAttributeInfos()
destructor

Method Index


o GetAttributeAccess()
Do Not Use this method.
o IsComponent()
Returns the aggregability of the attribute.
o IsDynamic()
Returns the dynamicity of the attribute.
o IsVisible()
Returns the visibility of the attribute.
o IsWritable()
Returns the writability of the attribute.
o NLSName()
Returns the NLS name of the attribute.
o Name()
Returns the internal name of the attribute.
o SetDynamic()
Indicates if the attribute is dynamically added on an object.
o Type()
Returns the type the attribute belongs to.
o operator!=(CATAttributeInfos&)
Operator to compare difference.
o operator=(CATAttributeInfos&)
Operator to affect a value.
o operator==(CATAttributeInfos&)
Operator to compare equality.

Constructor and Destructor


o CATAttributeInfos
public CATAttributeInfos( const CATAttributeInfos& iInfos)
copy constructor
o CATAttributeInfos
public CATAttributeInfos( const CATIType_var& iType,
const CATUnicodeString& iName,
const CATUnicodeString& iNLSName,
const boolean isWriteable= 1,
const boolean isComponent= 0,
const boolean isVisible= 1,
const CATUnicodeString& iAttributeAccess= "")
Constructor.
Parameters:
iType
Type the attribute is added to.
iName
Internal name of the attribute.
iNLSName
NLS (user) name of the attribute.
isWriteable
TRUE if the attribute can be modified, else FALSE. Default is TRUE.
isComponent
TRUE if the attribute contains a component. If TRUE, the component's owner should be the owner of the attribute, and its name the attribute name. Default is FALSE.
isVisible
TRUE if the attribute is visible by the user, else FALSE. Default is TRUE.
iAttributeAccess
Only Use the Default Value = "".
(Name of the CATIAttributeAccess implementation class used to valuate the attribute. It is used by the default implementation of
CATIInstance.GetValue and CATIInstance.SetValue to actually get/set the attribute value. It is necessary when two CATIInstance implementations, whose types derive one from another, don't derive one from another.
Default is "".
o ~CATAttributeInfos
public ~CATAttributeInfos()
destructor

Methods


o GetAttributeAccess
public const CATUnicodeString& GetAttributeAccess()const
Do Not Use this method. Returns the name of the CATIAttributeAccess implementation.
Returns:
a string.
o IsComponent
public boolean IsComponent()const
Returns the aggregability of the attribute.
Returns:
TRUE if it an aggregation, else FALSE.
o IsDynamic
public boolean IsDynamic()const
Returns the dynamicity of the attribute. Default value is FALSE.
Returns:
TRUE if it is a dynamic attribute, FALSE instead
o IsVisible
public boolean IsVisible()const
Returns the visibility of the attribute.
Returns:
TRUE if visible, else FALSE.
o IsWritable
public boolean IsWritable()const
Returns the writability of the attribute.
Returns:
TRUE if writable, else FALSE.
o NLSName
public CATUnicodeString NLSName()const
Returns the NLS name of the attribute.
Returns:
a string.
o Name
public CATUnicodeString Name()const
Returns the internal name of the attribute.
Returns:
a string.
o SetDynamic
public void SetDynamic()
Indicates if the attribute is dynamically added on an object.
o Type
public CATIType_var Type()const
Returns the type the attribute belongs to.
Returns:
a type.
o operator!=
public boolean operator!=( const CATAttributeInfos& iInfos)const
Operator to compare difference.
o operator=
public CATAttributeInfos & operator=( const CATAttributeInfos& iInfos)
Operator to affect a value.
o operator==
public boolean operator==( const CATAttributeInfos& iInfos)const
Operator to compare equality.

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

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