All Frameworks Class Hierarchy This Framework Indexes Previous Next

GeometricObjects Interface CATICGMObject

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

interface CATICGMObject

Interface representing the base class of all the objects of the Catia Geometrical Modeler that can be streamed.

These objects can be geometrical objects (CATGeometry) and other objects such as a CATLaw.

They are identified by a persistent tag.
They are implicit or explicit.
If they are frozen through a smart process, they cannot be modifiable
They can point attributes. Attributes allow an application programmer to put data on a CATICGMObject.Attributes can be streamed (CATCGMStreamAttribute) or not (CATCGMAttribute).
They can be cloned, (i.e. duplicated with or without the objects that are forward linked) by the use of a CATCloneManager.

Method Index

o Completed(CATBoolean,char[],CATTopData*): Declares that the CATICGMObject construction is achieved.
o GetAttribute(CATCGMAttrId*): Returns a pointer to an attribute, pointed by this CATICGMObject.
o GetContainer(CATBoolean,CATCGMMode): Returns a pointer to the CATGeoFactory of this CATICGMObject.
o GetListAttribute(CATLISTP(CATCGMAttribute)&,CATCGMAttrId*): Retrieves the attributes, pointed by this CATICGMObject.
o GetNextAttribute(CATCGMAttribute*,CATCGMAttribute*&): Retrieves the next attribute of this CATICGMObject.
o GetPersistentTag(): Returns the persistent tag of this CATICGMObject.
o GetUseCount(CATCGMUseCountType): Returns the number of links that arrives to this CATICGMObject.
o IsExplicit(): Tests whether this CATICGMObject is explicit.
o IsModifiable(): Tests whether this CATICGMObject is modifiable.
o PutAttribute(CATCGMAttribute*): Links an attribute to this CATIGGMObject.
o ReleaseAttribute(CATCGMAttribute*): Releases an attribute so that this CATICGMObject no longer points to the given attribute.
o SetMode(CATCGMMode): Modifies the implicit/explicit mode of this CATICGMObject.

Methods

o Completed

public virtual Completed(		`iIsNoMoreModifiable`	`= FALSE`,
	const	`iIdentityBuildOperator`	`= ""`,
	const	`iData`	`= NULL`)

Declares that the CATICGMObject construction is achieved.
This method also runs basic checks.

Parameters:

IsNoMoreModifiable

The status of the CATICGMObject after completion.
Legal values:

TRUE: To freeze the content of the CATICGMObject. Further modifications of this object will imply that all modified elements will be copied first, thus keeping the current object state unmodified.
FALSE: The CATICGMObject can be later modified.

IdentityBuildOperator

Internal use, to let at the default value.

iData

Internal use, to let at the default value.

o GetAttribute

public virtual GetAttribute( const iAttrId)

Returns a pointer to an attribute, pointed by this CATICGMObject.

Parameters:

iAttrId: The attribute identifier (given by the macro iAttrId=UIDName(MyAttributeClassName))

Returns:

A pointer to the attribute.

o GetContainer

public virtual GetContainer(		`iThrowOnNullFactory`	`= TRUE`,
		`iMode`	`= CatCGMExplicit`)

Returns a pointer to the CATGeoFactory of this CATICGMObject.

Parameters:

iThrowOnNullFactory: Specify if an error must be thrown in case of a NULL return CATGeoFactory pointer. Notice that this configuration remains unsual.
iMode: The mode of the required CATGeoFactory.

Returns:

The pointer to the CATGeoFactory.

o GetListAttribute

public virtual GetListAttribute(		`oListOfAttr`,
	const	`iAttrId`	`=NULL`)

Retrieves the attributes, pointed by this CATICGMObject.

Parameters:

oListOfAttr: The retrieving list. Notice that all the derived attributes are also retrieved.
iAttrId: The attribute identifier to take into account. If NULL, it retrieves all the attributes of this CATICGMObject.

o GetNextAttribute

public virtual GetNextAttribute(		`iPrevAttr`,
		`ioNextAttr`)

Retrieves the next attribute of this CATICGMObject.

Parameters:

iPrev: A pointer to the previous attribute. iPrevAttr=NULL for the first attribute.
ioNextAttr: A pointer to the next attribute.

o GetPersistentTag

public virtual GetPersistentTag(

)

Returns the persistent tag of this CATICGMObject.
WARNING: The returned tag is not necessarily incremented each time a new object is created.

Returns:: The tag.

o GetUseCount

public virtual GetUseCount( iUseType = CatCGMUseCountAllCATICGMObject)

Returns the number of links that arrives to this CATICGMObject.

Parameters:

iUseType: The kind of links that are taken into account.

Returns:

The number of links that refer to this.

o IsExplicit

public virtual IsExplicit(

)

Tests whether this CATICGMObject is explicit.

Returns:: The result of the test.
Legal values: 1 if this CATICGMObject is explicit, 0 otherwise.

o IsModifiable

public virtual IsModifiable(

)

Tests whether this CATICGMObject is modifiable.

Returns:: The result of the test.
Legal velues: 1 if this CATICGMObject is modifiable, 0 otherwise.
A CATICGMObject is not modifiable when it depends on another CATICGMObject that has been frozen. This is used in the topology by the smart mechanism.

o PutAttribute

public virtual PutAttribute( iNewAttr)

Links an attribute to this CATIGGMObject.

Parameters:

iNewAttr: A pointer to the attribute to be pointed by this CATICGMObject.

Returns:

The result of the association 1 if the attribute has been successfully pointed, 0 otherwise.

o ReleaseAttribute

public virtual ReleaseAttribute( iAttr)

Releases an attribute so that this CATICGMObject no longer points to the given attribute. The attribute is deleted if it is not pointed to by any other object.

Parameters:

iAttr: The pointer to the attribute

Returns:

1 if the attribute has been successfully released, 0 otherwise.

o SetMode

public virtual SetMode( iMode)

Modifies the implicit/explicit mode of this CATICGMObject.

Parameters:

iMode: The new mode of this CATICGMObject.

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