All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GeometricObjects Class CATCGMAttribute

Mathematics.CATCGMVirtual
  |
  +---CATCGMAttribute
 

Usage: you can derive this class.


public class CATCGMAttribute

Class representing the attribute that can be pointed to by one or several CATICGMObject.

The attribute are characterized by

The identifier is defined by the use of the macro UIDName(MyAttributeClassName).
For streamable attribute, use CATCGMStreamAttribute.
For declaration and implementation of your own attributes, use macros CATCGMDeclareAttribute and CATCGMImplAttribute.


Constructor and Destructor Index


o ~CATCGMAttribute()

Method Index


o AddAttrRef()
Adds 1 to the count of CATICGMObjects pointing to this CATCGMAttribute.
o Compare(CATCGMAttribute&)
Checks whether two attributes of the same identifier are equal.
o CreateAttribute(CATCGMAttrId*)
Creates an attribute of a given identifier.
o GetCGMAttrId()
Returns the identifier of this CATCGMAttribute.
o GetNbAttrRef()
Returns the number of CATICGMObjects pointing to this CATCGMAttribute.
o IsATypeOf(CATCGMAttrId*)
Tests whether this CATCGMAttribute is of a given type (or a derived type).
o IsPersistent()
Tests whether this CATCGMAttribute is persistent.
o ReleaseAttrRef()
Removes 1 to the count of CATICGMObjects pointing to this CATCGMAttribute.
o operator!=(CATCGMAttribute&)
Inequality operator.
o operator==(CATCGMAttribute&)
Equality operator.

Constructor and Destructor


o ~CATCGMAttribute
public virtual ~CATCGMAttribute()

Methods


o AddAttrRef
public CATULONG32 AddAttrRef()
Adds 1 to the count of CATICGMObjects pointing to this CATCGMAttribute.
Returns:
The number of CATICGMObjects pointing to this CATCGMAttribute.
o Compare
protected virtual CATLONG32 Compare( const CATCGMAttribute& iToCompare)
Checks whether two attributes of the same identifier are equal.
Called in the == and =! operators.
Returns:
1 if they are, 0 otherwise.
o CreateAttribute
public static CATCGMAttribute * CreateAttribute( const CATCGMAttrId* iId)
Creates an attribute of a given identifier.
Parameters:
iId
The attribute identifier
Returns:
The created attribute
o GetCGMAttrId
public virtual const CATCGMAttrId * GetCGMAttrId()const =0
Returns the identifier of this CATCGMAttribute.
Returns:
The identifier.
Do not overload this method. Use macros CATCGMDeclareAttribute and CATCGMImplAttribute.
o GetNbAttrRef
public INLINE CATULONG32 GetNbAttrRef()const
Returns the number of CATICGMObjects pointing to this CATCGMAttribute.
Returns:
The number of CATICGMObjects.
o IsATypeOf
public int IsATypeOf( const CATCGMAttrId* iId)
Tests whether this CATCGMAttribute is of a given type (or a derived type).
Returns:
The result of the test.
Legal values: 1 if the attribute identifier is iId, 0 otherwise.
o IsPersistent
public virtual int IsPersistent()
Tests whether this CATCGMAttribute is persistent.
Returns:
The result of the test.
Legal values: 1 if the attribute can be streamed (i.e. persistent), 0 otherwise.
o ReleaseAttrRef
public CATULONG32 ReleaseAttrRef()
Removes 1 to the count of CATICGMObjects pointing to this CATCGMAttribute.
Returns:
The number of CATICGMObjects still pointing to this CATCGMAttribute.
o operator!=
public CATLONG32 operator!=( const CATCGMAttribute& iToCompare)
Inequality operator.
Returns:
1 if they are different, 0 otherwise.
o operator==
public CATLONG32 operator==( const CATCGMAttribute& iToCompare)
Equality operator.
Returns:
The result of the test. 1 if true, 0 otherwise.

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

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