All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GeometricObjects Class CATCloneManager

Mathematics.CATCGMVirtual
  |
  +---GeometricObjects.CATCGMOperator
    |
    +---CATCloneManager
 

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


public class CATCloneManager

Class representing the process of duplication of a CATICGMObject.

code sample :
 CATCloneManager MyManager(MyGeoFactory);
 MyManager.Add(MyCGMObject);
 MyManager.Run();
 CATICGMObject* ClonedObject=MyManager.ReadImage(MyCGMObject);
 MyManager.WriteReport(MyJournal, CATCGMJournal::Modification);
 


Constructor and Destructor Index


o CATCloneManager(CATGeoFactory*,CATCloneManagerType,CATSoftwareConfiguration*)
Constructs a CATCloneManager.
o ~CATCloneManager()

Method Index


o Add(CATICGMObject*,CATICGMObject*)
Adds a CATICGMObject to clone with this CATCloneManager.
o ReadImage(CATICGMObject*)
Returns a pointer to the CATICGMObject (called "image") corresponding to the clone by this of a given iObject.
o Run()
Runs the CATCloneManager process.
o WriteReport(CATCGMJournalList*&,CATCGMJournal::Type,CATBoolean)
Writes the topological journal associated with this CATCloneManager process.
o WriteReport(CATICGMObject*,CATCGMJournalList*&,CATCGMJournal::Type,CATBoolean)
Writes the topological journal for one object.

Constructor and Destructor


o CATCloneManager
public CATCloneManager(CATGeoFactory* iFactory,
CATCloneManagerType iType= CatCGMSingleDuplicate,
CATSoftwareConfiguration* iConfig= NULL)
Constructs a CATCloneManager.
Parameters:
iFactory
The pointer to the factory of the resulting objects.
iType
The type of duplication.
iConfig
The pointer to the configuration.Should not be NULL in case of topological objects.
o ~CATCloneManager
public virtual ~CATCloneManager()

Methods


o Add
public virtual void Add(CATICGMObject* iObjectToClone,
CATICGMObject* iWhereToPaste= 0)
Adds a CATICGMObject to clone with this CATCloneManager.
All the added objects must belong to the same factory.
Parameters:
iObjectToClone
The pointer to the object to add to the CATCloneManager.
iWhereToPaste
If not NULL, it forces the duplication of iObjectToClone to be the object iWhereToPaste. This can be used to copy and paste objects from one container to another one. Notice that there is no transformation here.
o ReadImage
public virtual CATICGMObject* ReadImage(CATICGMObject* iObject)
Returns a pointer to the CATICGMObject (called "image") corresponding to the clone by this of a given iObject.
Parameters:
iObject
The pointer to the object which the image is asked for.
Returns:
The pointer to the image if it exists. 0 otherwise.
o Run
public virtual int Run()
Runs the CATCloneManager process. This method should be called only once.
o WriteReport
public virtual void WriteReport(CATCGMJournalList*& ioJournal,
CATCGMJournal::Type iType,
CATBoolean iAddInfo= CATBoolean(1)) const
Writes the topological journal associated with this CATCloneManager process.
The journal follows the modifications of the topological objects.
Parameters:
ioJournal
The pointer to the journal to fill
iType
The type of modification to be written. The attribute to put to the face that have just been cloned.
CATCGMJournal::Creation
All the duplicated faces are written as created into the journal
CATCGMJournal::Modification
All the duplicated faces are written as modified into the journal
iAddInfo
The activation of the journal info .
Legal values: TRUE for the activation, FALSE otherwise.
o WriteReport
public virtual void WriteReport(CATICGMObject* iObject,
CATCGMJournalList*& ioJournal,
CATCGMJournal::Type iType,
CATBoolean iAddInfo= CATBoolean(1)) const
Writes the topological journal for one object.
Parameters:
iObject
The pointer to the object to follow.
ioJournal
The pointer to the journal to fill
iType
The type of modification to be written. The attribute to put to the face that have just been cloned.
CATCGMJournal::Creation
All the duplicated faces are written as created into the journal
CATCGMJournal::Modification
All the duplicated faces are written as modified into the journal
iAddInfo
The activation of the journal info .
Legal values: TRUE for the activation, FALSE otherwise.

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

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