All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GeometricObjects Class CATCGMJournalItem

Mathematics.CATCGMVirtual
  |
  +---GeometricObjects.CATCGMJournal
    |
    +---CATCGMJournalItem
 

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


public class CATCGMJournalItem

Class defining a single line in the journal.

The journal items are created when you report new events inside the journal list (CATCGMJournalList.Report, CATCGMJournalList.ReportUnspecModify). Do not directly use the item journal constructor. The journal items are deleted with the journal list in which they are imbedded, except if you have directly created an item, without inserting it inside a journal list. The journal information is also deleted with the journal it informs.


Constructor and Destructor Index


o CATCGMJournalItem(CATCGMJournalList*,CATCGMJournal::Type,CATGeometry*,CATCGMJournalInfo*)
Constructs a Keep or Deletion journal item .
o CATCGMJournalItem(CATCGMJournalList*,CATCGMJournal::Type,CATLISTP(CATGeometry)&,CATLISTP(CATGeometry)&,CATCGMJournalInfo*)
Constructs a journal item.
o ~CATCGMJournalItem()

Method Index


o CastToReportItem()
Casts this into a journal item.
o ForgetObjects(CATLISTP(CATGeometry)&)
Discards a list of objects from the topological journal.
o GetAssociatedInfo()
Returns the associated information with this journal item.
o GetConstructedObject()
Retrieves a pointer to the created object for a creation item.
o GetConstructionObjects()
Retrieves the list of construction objects for a creation item.
o GetCopiedIntoObject()
Returns the resulting object (for a copy/nocopy item).
o GetCopiedObject()
Returns the copied object (for a copy/nocopy item).
o GetDeletedObjects()
Returns the deleted objects (Deletion item).
o GetFirstObjs(CATLISTP(CATGeometry)&)
Returns the initial objects (all item types).
o GetKeptObject()
Returns the kept object (Keep item).
o GetLastObjs(CATLISTP(CATGeometry)&)
Returns the resulting objects (all item types).
o GetNewObjects()
Returns the list of objects after a modification or an absorption.
o GetOldObjects()
Returns the list of objects before a modification or an absorption.
o GetType()
Returns the type of this journal item.
o MakeAttributesFollow(CATCGMAttrId*)
Automatically reports the attributes pointed by the objects before the operation on the objects after the operation.
o SetAssociatedInfo(CATCGMJournalInfo*)
Replaces the information associated with this journal item.

Constructor and Destructor


o CATCGMJournalItem
public CATCGMJournalItem(CATCGMJournalList* iList,
CATCGMJournal::Type iType,
CATGeometry* iObject,
CATCGMJournalInfo* info= NULL)
Constructs a Keep or Deletion journal item .
Do not directly construct an item by this constructor, use the CATCGMJournalList.Report methods to create an item inside a list.
o CATCGMJournalItem
public CATCGMJournalItem(CATCGMJournalList* iList,
CATCGMJournal::Type iType,
const CATLISTP(CATGeometry)& iBefore,
const CATLISTP(CATGeometry)& iAfter,
CATCGMJournalInfo* iInfo= NULL)
Constructs a journal item.
Do not directly construct an item by this constructor, use the CATCGMJournalList.Report methods to create an item inside a list.
o ~CATCGMJournalItem
public virtual ~CATCGMJournalItem()

Methods


o CastToReportItem
public virtual CATCGMJournalItem * CastToReportItem()
Casts this into a journal item.
Returns:
The casted pointer.
o ForgetObjects
public int ForgetObjects( const CATLISTP(CATGeometry)& iObjects)
Discards a list of objects from the topological journal. This method is to be used with caution. Only objects which are not required by the backtracking mechanism can be discarded. If not used properly, this method can lead to an invalid journal.
Parameters:
iToSimplify
The list of objects to be discarded from the journal.
Returns:
0 if the objects can be removed - otherwise 1
o GetAssociatedInfo
public const CATCGMJournalInfo * GetAssociatedInfo()const
Returns the associated information with this journal item.
Returns:
A pointer to the associated information.
o GetConstructedObject
public CATGeometry * GetConstructedObject()const
Retrieves a pointer to the created object for a creation item.
Returns:
A pointer to the created object.
o GetConstructionObjects
public const CATLISTP(CATGeometry) * GetConstructionObjects()const
Retrieves the list of construction objects for a creation item.
Returns:
A pointer to the list of objects that lead to the creation of another one.
o GetCopiedIntoObject
public CATGeometry * GetCopiedIntoObject()const
Returns the resulting object (for a copy/nocopy item).
Returns:
A pointer to the resulting object.
o GetCopiedObject
public CATGeometry * GetCopiedObject()const
Returns the copied object (for a copy/nocopy item).
Returns:
A pointer to the copied object.
o GetDeletedObjects
public const CATLISTP(CATGeometry) * GetDeletedObjects()const
Returns the deleted objects (Deletion item).
Returns:
A pointer to the list of deleted objects.
o GetFirstObjs
public void GetFirstObjs(CATLISTP(CATGeometry)& ioBefore) const
Returns the initial objects (all item types).
Parameters:
ioBefore
The list of the objects before the operation described by this item.
o GetKeptObject
public CATGeometry * GetKeptObject()const
Returns the kept object (Keep item).
Returns:
A pointer to the kept object.
o GetLastObjs
public void GetLastObjs(CATLISTP(CATGeometry)& ioAfter) const
Returns the resulting objects (all item types).
Parameters:
ioAfter
The list of the objects after the operation described by this item.
o GetNewObjects
public const CATLISTP(CATGeometry) * GetNewObjects()const
Returns the list of objects after a modification or an absorption.
Returns:
A pointer to the list of objects after a modification or an absorption.
o GetOldObjects
public const CATLISTP(CATGeometry) * GetOldObjects()const
Returns the list of objects before a modification or an absorption.
Returns:
A pointer to the list of objects before a modification or an absorption.
o GetType
public virtual CATCGMJournal::Type GetType()const
Returns the type of this journal item.
Returns:
The type of the item.
o MakeAttributesFollow
public void MakeAttributesFollow( const CATCGMAttrId* iAttribute)
Automatically reports the attributes pointed by the objects before the operation on the objects after the operation.
Not available for a creation item.
Parameters:
iAttr
The type of attribute to report. If the objects before the operation point an attribute of this type, the attribute will also be shared by the objects after modification.
o SetAssociatedInfo
public void SetAssociatedInfo( const CATCGMJournalInfo* iNewInfo)
Replaces the information associated with this journal item.
Parameters:
iNewInfo
A pointer to the new information.

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

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