All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GeometricObjects Class CATCGMJournalList

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

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


public class CATCGMJournalList

Class representing an aggregation of journal items and journal lists.

You have to manage the creation and deletion of a journal list. The journal items are created when you report new events inside the journal list (CATCGMJournalList.Report, CATCGMJournalList.ReportUnspecModify). 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 CATCGMJournalList()
o CATCGMJournalList(CATCGMJournalList*)
o CATCGMJournalList(CATSoftwareConfiguration*,CATCGMJournalList*)
Constructs a CGM journal list.
o ~CATCGMJournalList()

Method Index


o CastToReportList()
Casts this into a journal list.
o Duplicate(CATCGMJournalList*,int)
Duplicates this CATCGMJournalList.
o FindFirsts(CATGeometry*,CATLISTP(CATGeometry)&,CATCGMJournalRequest)
Retrieves the objects that lead to the definition of a given geometric object.
o FindLasts(CATGeometry*,CATLISTP(CATGeometry)&,CATCGMJournalRequest)
Retrieves the objects that are created and/or modified by a given geometric object.
o GetType()
Returns the type of this CATCGMJournalList.
o InsertJournal(CATCGMJournalList*)
Inserts an isolated journal list inside this.
o MakeAttributesFollow(CATCGMAttrId*)
DO NOT USE
Automatically reports the attributes pointed by the objects before the operation, on the objects after the operation.
o Next(CATCGMJournal*)
Skips to the next item or list of this journal list.
o Report(CATCGMJournal::Type,CATLISTP(CATGeometry)&,CATLISTP(CATGeometry)&,CATCGMJournalInfo*)
Creates an item inside this journal list.
o ReportCreation(CATLISTP(CATGeometry)&,CATGeometry*,CATCGMJournalInfo*)
Creates a creation item inside this journal list.
o ReportDeletion(CATLISTP(CATGeometry)&,CATCGMJournalInfo*)
Creates a deletion item inside this journal list.
o ReportKeeping(CATGeometry*)
Creates a keep item inside this journal list.
o ReportUnspecModify(CATLISTP(CATGeometry)&,CATLISTP(CATGeometry)&,CATCGMJournalInfo*)
Creates an item inside this journal list.
o SearchReportsAbout(CATGeometricType,CATLISTP(CATCGMJournal)&)
Retrieves the journals that reference objects of a given geometric type.
o SearchReportsAbout(CATGeometry*,CATLISTP(CATCGMJournal)&)
Retrieves the journals that reference a given geometric object.
o Tass()
Tasses the contained items.

Constructor and Destructor


o CATCGMJournalList
public CATCGMJournalList()
Deprecated:
V5R14 Use the signature with CATSoftwareConfiguration
o CATCGMJournalList
public CATCGMJournalList(CATCGMJournalList* ioList)
Deprecated:
V5R14 Use the signature with CATSoftwareConfiguration
o CATCGMJournalList
public CATCGMJournalList(CATSoftwareConfiguration* iConfig,
CATCGMJournalList* ioList)
Constructs a CGM journal list.
Parameters:
iConfig
The pointer to the configuration. Must not be NULL.
ioList
If not NULL, a pointer to a journal list, inside which this will be inserted after its creation.
o ~CATCGMJournalList
public virtual ~CATCGMJournalList()

Methods


o CastToReportList
public virtual CATCGMJournalList * CastToReportList()
Casts this into a journal list.
Returns:
The casted pointer.
o Duplicate
public virtual CATCGMJournal * Duplicate(CATCGMJournalList* ioInReport,
int iCopyNext= 1) const
Duplicates this CATCGMJournalList.
Parameters:
iInReport
The pointer to another journal list inside which the duplication is inserted. If NULL, no insertion.
Returns:
A pointer to the duplicated journal.
o FindFirsts
public void FindFirsts(CATGeometry* ioAnObject,
CATLISTP(CATGeometry)& ioOriginObjects,
CATCGMJournalRequest iRequest= ThroughModify)
Retrieves the objects that lead to the definition of a given geometric object.
Parameters:
iAnObject
A pointer to the object.
ioOriginObjects
The list of geometrical objects that lead to the definition of iAnObject.
iRequest
The type of search.
o FindLasts
public void FindLasts(CATGeometry* ioAnObject,
CATLISTP(CATGeometry)& ioNewObjects,
CATCGMJournalRequest iRequest= ThroughModify)
Retrieves the objects that are created and/or modified by a given geometric object.
Parameters:
iAnObject
A pointer to the object.
ioNewObjects
The list of geometrical objects that are defined by iAnObject.
iRequest
The type of search.
o GetType
public virtual CATCGMJournal::Type GetType()const
Returns the type of this CATCGMJournalList.
Returns:
CATCGMJournal::List.
o InsertJournal
public void InsertJournal(CATCGMJournalList* ioJournalToInsert)
Inserts an isolated journal list inside this.
Parameters:
iJournalToInsert
The journal list to insert. It must be isolated (never referenced by another journal).
o MakeAttributesFollow
public void MakeAttributesFollow( const CATCGMAttrId* iAttributeID)
DO NOT USE
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 Next
public CATCGMJournal * Next(CATCGMJournal* ioPtr= NULL)
Skips to the next item or list of this journal list.
Parameters:
iPtr
The pointer to the journal from which the search is initialized.
Returns:
A pointer to the next journal of this journal list.
o Report
public void Report(CATCGMJournal::Type iType,
const CATLISTP(CATGeometry)& iBeforeObjects,
const CATLISTP(CATGeometry)& iAfterObjects,
CATCGMJournalInfo* ioOptionalInfo= NULL)
Creates an item inside this journal list.
Parameters:
iType
The type of the item.
iBeforeObjects
The list of the objects before the operation.
iAfterObjects
The list of the objects after the operation.
iOptionalInfo
A pointer to an optional information. If NULL, no information is added.
o ReportCreation
public void ReportCreation( const CATLISTP(CATGeometry)& iOperands,
CATGeometry* ioCreatedObject,
CATCGMJournalInfo* ioOptionalInfo= NULL)
Creates a creation item inside this journal list.
Parameters:
iOperands
The list of pointers to the geometric objects from which ioCreatedObject are created.
iCreatedObjects
The list of the objects to create.
iOptionalInfo
A pointer to an optional information. If NULL, no information is added.
o ReportDeletion
public void ReportDeletion( const CATLISTP(CATGeometry)& iDeletedObjects,
CATCGMJournalInfo* ioOptionalInfo= NULL)
Creates a deletion item inside this journal list.
Parameters:
iDeletedObjects
The list of the objects to delete.
iOptionalInfo
A pointer to an optional information. If NULL, no information is added.
o ReportKeeping
public void ReportKeeping(CATGeometry* ioToKeep)
Creates a keep item inside this journal list.
Parameters:
iToKeep
The pointer to the object to keep.
o ReportUnspecModify
public void ReportUnspecModify( const CATLISTP(CATGeometry)& iBefore,
const CATLISTP(CATGeometry)& iAfter,
CATCGMJournalInfo* ioOptionalInfo= NULL)
Creates an item inside this journal list.
Automatically finds the type of the item, according to the number of objects in iBefore and the number of objects in iAfter.
Parameters:
iBefore
The list of the objects before the operation.
iAfter
The list of the objects after the operation.
iOptionalInfo
A pointer to an optional information. If NULL, no information is added.
o SearchReportsAbout
public void SearchReportsAbout(CATGeometricType iGeoType,
CATLISTP(CATCGMJournal)& ioFoundReports)
Retrieves the journals that reference objects of a given geometric type.
Parameters:
iGeoType
A geometric object type.
ioFoundReports
A list of journals that reference objects of type iGeoType.
o SearchReportsAbout
public void SearchReportsAbout(CATGeometry* ioAnObject,
CATLISTP(CATCGMJournal)& ioFoundReports)
Retrieves the journals that reference a given geometric object.
Parameters:
iAnObject
A pointer to the object.
ioFoundReports
A list of journals that reference iAnObject.
o Tass
public void Tass()
Tasses the contained items.
Please refer to the encyclopedia articles to learn about the rules for the tass.

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

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