All Frameworks Class Hierarchy This Framework Indexes
GeometricObjects Class 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
- A class name
- An application name: the logical name of the physical load module containing the
class
- A version number
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
IsClonableAttribute()
- Tests whether this CATCGMAttribute is manageable by Clone managements.
- 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
-
Adds 1 to the count of CATICGMObjects pointing to this CATCGMAttribute.
- Returns:
- The number of CATICGMObjects pointing to this CATCGMAttribute.
o Compare
| protected virtual Compare( | const | 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 CreateAttribute( | const | iId) |
-
Creates an attribute of a given identifier.
- Parameters:
-
- iId
- The attribute identifier
- Returns:
- The created attribute
o GetCGMAttrId
| public virtual GetCGMAttrId( | ) |
-
Returns the identifier of this CATCGMAttribute.
- Returns:
- The identifier.
Do not overload this method.
Use macros CATCGMDeclareAttribute and CATCGMImplAttribute.
o GetNbAttrRef
-
Returns the number of CATICGMObjects pointing to this CATCGMAttribute.
- Returns:
- The number of CATICGMObjects.
o IsATypeOf
| public IsATypeOf( | const | 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 IsClonableAttribute
| public virtual IsClonableAttribute( | ) |
-
Tests whether this CATCGMAttribute is manageable by Clone managements.
- Returns:
- The result of the test.
Legal values:
1 if the attribute can be managed (i.e. implements ReportClonableAttributes), 0 otherwise.
o IsPersistent
| public virtual 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
-
Removes 1 to the count of CATICGMObjects pointing to this CATCGMAttribute.
- Returns:
- The number of CATICGMObjects still pointing to this CATCGMAttribute.
o operator!=
| public operator!=( | const | iToCompare) |
-
Inequality operator.
- Returns:
- 1 if they are different, 0 otherwise.
o operator==
| public operator==( | const | 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