GeometricObjects class CATCGMStreamAttribute

Usage: you can derive this class.

public class CATCGMStreamAttribute

Class representing the persistent attribute that can be pointed to by one or several CATICGMObject.
Role: This class allows you to stream the attribute with the objects that are pointed them. If you want to create your own class, you overload the methods that are written as mandatory. If you want that your attribute points objects, use CATCGMAttribute.AddLink . These objects will be automatically streamed. To put an attribute on a object, use CATICGMObject#PutAttribute . RuleWhen implementing by overloading this class, expected mandatory material in software delivery is the logical domain declaration MyDomainId adhesion, such as : 

 #include "TIE_CATICGMDomainBinder.h"
 AppDef(MyDomainId);
Do not forget to update of your associated ObjectModeler dictionnary.

Constructor and Destructor Index


o CATCGMStreamAttribute()
Default constructor.
o ~CATCGMStreamAttribute()

Method Index


o AddLink(CATICGMObject*)
Attaches CATICGMObjects to this CATCGMStreamAttribute.
o GetLinks(CATLISTP(CATICGMObject)&)
Retrieves all the links from this CATCGMStreamAttribute to a CATICGMObjects.
o RemoveLink(CATICGMObject*)
Removes the link from this CATCGMStreamAttribute to a CATICGMObjects.
o SetLinks(CATLISTP(CATICGMObject)&)
Replaces all the links from this CATCGMStreamAttribute to a CATICGMObjects.
o Stream(CATCGMStream&)
Translates this CATCGMStreamAttribute into a byte sequence that can be later saved.
o UnStream(CATCGMStream&)
Copies into this CATCGMStreamAttribute, the translation of a byte sequence that has been previoulsy streamed for an CATCGMStreamAttribute.

Constructor and Destructor


o CATCGMStreamAttribute
public CATCGMStreamAttribute()
Default constructor.
o ~CATCGMStreamAttribute
public virtual ~CATCGMStreamAttribute()

Methods


o AddLink
public void AddLink(CATICGMObject* iObject)
Attaches CATICGMObjects to this CATCGMStreamAttribute.
Parameters:
iObject
A pointer to the CATICGMObject that will be pointed to.
o GetLinks
public void GetLinks(CATLISTP(CATICGMObject)& ioLinkedObjects)
Retrieves all the links from this CATCGMStreamAttribute to a CATICGMObjects.
Parameters:
ioLinkedObjects
A list of pointers to the linked CATICGMObjects.
o RemoveLink
public void RemoveLink(CATICGMObject* iObject)
Removes the link from this CATCGMStreamAttribute to a CATICGMObjects.
Parameters:
iObject
A pointer to the CATICGMObject that will be not pointed to anymore.
o SetLinks
public void SetLinks( const CATLISTP(CATICGMObject)& iObjects)
Replaces all the links from this CATCGMStreamAttribute to a CATICGMObjects.
Parameters:
iObjects
A list of pointers to the CATICGMObjects that will be pointed to. The already existing links are removed.
o Stream
public virtual void Stream(CATCGMStream& ioStream) const=0
Translates this CATCGMStreamAttribute into a byte sequence that can be later saved.
Mandatory method.
Parameters:
ioStream
The stream.
o UnStream
public virtual void UnStream(CATCGMStream& ioStr)= 0
Copies into this CATCGMStreamAttribute, the translation of a byte sequence that has been previoulsy streamed for an CATCGMStreamAttribute.
Mandatory method.
Parameters:
ioStream
The stream.
This object is included in the file: CATCGMStreamAttribute.h
If needed, your Imakefile.mk should include the module: CATGeometricObjects

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.