GMModelInterfaces CATTopData

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


public class CATTopData

Class defining inputs of the topological operators.

See also:
,


Constructor and Destructor Index


o CATTopData()
Constructs a CATTopData.
o CATTopData(CATTopData&)
Copy constructor.
o CATTopData(CATSoftwareConfiguration*,CATCGMJournalList*)
Constructs a CATTopData.
o ~CATTopData()
Destructor.

Method Index


o CATCreateTopData(CATSoftwareConfiguration*)
Constructs a CATTopData with a Software Configuration and a NULL Journal.
o GetJournal()
Returns the pointer to the topological journal associated with this CATTopData.
o GetSoftwareConfiguration()
Returns the software configuration to be taken into acccount by this data.
o SetJournal(CATCGMJournalList*)
Defines the topological journal to be taken into acccount by this data.
o SetSoftwareConfiguration(CATSoftwareConfiguration*)
Defines the software configuration to be taken into acccount by this data.
o operator =(CATTopData&)
Assignment operator.

Constructor and Destructor


o CATTopData
public CATTopData()
Constructs a CATTopData.
You must call the SetSoftwareConfiguration method afterwards, because a CATSoftwareConfiguration is mandatory for use.
o CATTopData
public CATTopData( const iToCopy)
Copy constructor.
o CATTopData
public CATTopData( iConfig,
iJournal=NULL)
Constructs a CATTopData.
Parameters:
iConfig
The pointer to the configuration. Must not be NULL.
iJournal
The pointer to the journal. If NULL, the journal is not filled by the operator.
o ~CATTopData
public virtual ~CATTopData()
Destructor.

Methods


o CATCreateTopData
public static CATCreateTopData( iConfig)
Constructs a CATTopData with a Software Configuration and a NULL Journal.
Parameters:
iConfig
The pointer to the configuration. Must not be NULL. USE WITH CAUTION ----------------- This static creation method allows creation of specific TopData. It positions the flag _JournalMustBeCreatedByTopOperator to TRUE. The Topological Operator that recieves this TopData as input arg. will create a journal and manage its life cycle with AddRef and Release mechanism
o GetJournal
public GetJournal()
Returns the pointer to the topological journal associated with this CATTopData.
Only available if a journal was given at the data creation.
Returns:
The pointer to the journal of the operation.
o GetSoftwareConfiguration
public GetSoftwareConfiguration()
Returns the software configuration to be taken into acccount by this data.
Returns:
The software configuration.
o SetJournal
public SetJournal( iJournal)
Defines the topological journal to be taken into acccount by this data.
Parameters:
iJournal
The topological journal.
o SetSoftwareConfiguration
public SetSoftwareConfiguration( iConfig)
Defines the software configuration to be taken into acccount by this data.
Parameters:
iConfig
The software configuration.
o operator =
public operator =( const iToAssign)
Assignment operator.

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

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