CAM_Study Class Reference

#include <CAM_Study.h>

Inheritance diagram for CAM_Study:


Public Types
typedef QPtrList< CAM_DataModel >	ModelList
typedef QPtrListIterator< CAM_DataModel >	ModelListIterator
Signals
void	studyModified (SUIT_Study *)
Public Member Functions
	CAM_Study (SUIT_Application *)
virtual	~CAM_Study ()
virtual void	closeDocument (bool permanently=true)
virtual bool	removeDataModel (const CAM_DataModel *)
bool	containsDataModel (const CAM_DataModel *) const
void	dataModels (ModelList &) const
virtual int	id () const
SUIT_DataObject *	root () const
QString	studyName () const
SUIT_Application *	application () const
virtual bool	isSaved () const
virtual bool	isModified () const
virtual void	createDocument ()
virtual bool	openDocument (const QString &)
bool	saveDocument ()
virtual bool	saveDocumentAs (const QString &)
virtual void	update ()
virtual void	sendChangesNotification ()
SUIT_Operation *	activeOperation () const
virtual void	abortAllOperations ()
const QPtrList< SUIT_Operation > &	operations () const
	Get all started operations.
virtual SUIT_Operation *	blockingOperation (SUIT_Operation *) const
	Verifies whether operation can be activated above already started ones.
bool	start (SUIT_Operation *, const bool check=true)
	Starts operation.
bool	abort (SUIT_Operation *)
	Aborts operation.
bool	commit (SUIT_Operation *)
	Commits operation.
bool	suspend (SUIT_Operation *)
	Commits operation.
bool	resume (SUIT_Operation *)
	Resumes operation.
virtual int	storeState ()
	Stores the study state.
virtual void	restoreState (int savePoint)
	Restores the study state.
Protected Slots
virtual void	updateModelRoot (const CAM_DataModel *)
Protected Member Functions
virtual void	dataModelInserted (const CAM_DataModel *)
virtual bool	openDataModel (const QString &, CAM_DataModel *)
virtual bool	saveDataModel (const QString &, CAM_DataModel *)
virtual void	setIsSaved (const bool)
virtual void	setIsModified (const bool)
virtual void	setRoot (SUIT_DataObject *)
virtual void	setStudyName (const QString &)
virtual void	operationStarted (SUIT_Operation *)
	Perform some actions when operation starting.
virtual void	operationAborted (SUIT_Operation *)
	Perform some actions when operation aborted.
virtual void	operationStopped (SUIT_Operation *)
	Perform some actions when operation stopped.
virtual void	operationCommited (SUIT_Operation *)
	Perform some actions when operation commited.
virtual bool	openTransaction ()
	Opens transaction for data modifications.
virtual bool	abortTransaction ()
	Aborts transaction and all performed data modifications.
virtual bool	hasTransaction () const
	Returns TRUE if transaction is opened.
virtual bool	commitTransaction (const QString &=QString::null)
	Commits transaction and all performed data modifications.
Private Attributes
ModelList	myDataModels
	Data model list.

Detailed Description

Represents study for using in CAM, contains list of data model references from all modules. Provides necessary functionality for data models management.

Member Typedef Documentation

typedef QPtrList<CAM_DataModel> CAM_Study.ModelList

typedef QPtrListIterator<CAM_DataModel> CAM_Study.ModelListIterator

Constructor & Destructor Documentation

CAM_Study::CAM_Study ( SUIT_Application * app )

Constructor.

CAM_Study::~CAM_Study ( ) [virtual]

Destructor

Member Function Documentation

void CAM_Study::closeDocument ( bool permanently = true ) [virtual]

Closing all data models and close document permanently(if permanently = true.)
Parameters:

permanently - flag

Reimplemented from SUIT_Study.
Reimplemented in LightApp_Study, and SalomeApp_Study.

bool CAM_Study::appendDataModel ( const CAM_DataModel * dm )

Append data model to list.
Parameters:

dm - data model for adding

bool CAM_Study::insertDataModel ( const CAM_DataModel * dm,

const int = -1

) [virtual]

Insert data model with index idx.

Parameters:

dm - data model

idx - index for inserting(must be no less zero)

Return values:

true - if model added successful, else false.

bool CAM_Study::insertDataModel ( const CAM_DataModel * dm,

const CAM_DataModel * other

)

Insert data model dm after other
Parameters:

dm - data model for adding

other - previus data model for dm

bool CAM_Study::removeDataModel ( const CAM_DataModel * dm ) [virtual]

Remove data model from list
Parameters:

dm data model

Return values:

true - if all ok, else false.

bool CAM_Study::containsDataModel ( const CAM_DataModel * dm ) const

Check data model contains in list.
Parameters:

dm - data model

Return values:

true - if data model in list, else false.

void CAM_Study::dataModels ( ModelList & lst ) const

Gets list of all data models.
Parameters:

lst - output data model list.

void CAM_Study::dataModelInserted ( const CAM_DataModel * dModel ) [protected, virtual]

Open data model dModel, if it saved
Reimplemented in SalomeApp_Study.

bool CAM_Study::openDataModel ( const QString & ,

CAM_DataModel *

) [protected, virtual]

Return values:

false

Reimplemented in LightApp_Study, and SalomeApp_Study.

bool CAM_Study::saveDataModel ( const QString & ,

CAM_DataModel *

) [protected, virtual]

Return values:

false

void CAM_Study::updateModelRoot ( const CAM_DataModel * dm ) [protected, virtual, slot]

Public slot. Update model root.
Reimplemented in SalomeApp_Study.

int SUIT_Study::id ( ) const [virtual, inherited]

Return values:

study id.

Reimplemented in SalomeApp_Study.

SUIT_DataObject * SUIT_Study::root ( ) const [inherited]

Return values:

root data object.

QString SUIT_Study::studyName ( ) const [inherited]

Return values:

study name

SUIT_Application * SUIT_Study::application ( ) const [inherited]

Return values:

Application.

bool SUIT_Study::isSaved ( ) const [virtual, inherited]

Return values:

TRUE - if study saved, else FALSE.

Reimplemented in CAF_Study, LightApp_Study, and SalomeApp_Study.

bool SUIT_Study::isModified ( ) const [virtual, inherited]

Return values:

TRUE - if study modified, else FALSE.

Reimplemented in CAF_Study, LightApp_Study, and SalomeApp_Study.

void SUIT_Study::createDocument ( ) [virtual, inherited]

Custom document initialization to be performed
within onNewDoc() handler can be put here
Reimplemented in CAF_Study, LightApp_Study, and SalomeApp_Study.

bool SUIT_Study::openDocument ( const QString & fileName ) [virtual, inherited]

Open document. Sets file name. return true.
Reimplemented in CAF_Study, LightApp_Study, and SalomeApp_Study.

bool SUIT_Study::saveDocument ( ) [inherited]

Return values:

TRUE - if document saved successful, else FALSE.

Reimplemented in LightApp_Study, and SalomeApp_Study.

bool SUIT_Study::saveDocumentAs ( const QString & fileName ) [virtual, inherited]

Save document as fileName. Set file name.
Reimplemented in CAF_Study, LightApp_Study, and SalomeApp_Study.

void SUIT_Study::update ( ) [virtual, inherited]

Update study. NOT IMPLEMENTED HERE.

void SUIT_Study::sendChangesNotification ( ) [virtual, inherited]

Emit study modified.

SUIT_Operation * SUIT_Study::activeOperation ( ) const [inherited]

Return values:

active operation.

void SUIT_Study::abortAllOperations ( ) [virtual, inherited]

Abort all operations.

const QPtrList< SUIT_Operation > & SUIT_Study::operations ( ) const [inherited]

Returns:
List of all started operations

SUIT_Operation * SUIT_Study::blockingOperation ( SUIT_Operation * theOp ) const [virtual, inherited]

Parameters:

theOp - operation to be checked

Returns:
NULL if operation can be activated, pointer to operation which denies starting tested operation
Verifies whether operation can be activated above already started ones. This method is called from SUIT_Study.start() and SUIT_Study.resume() methods.

bool SUIT_Study::start ( SUIT_Operation * theOp,

const bool toCheck = true

) [inherited]

Parameters:

theOp - operation to be started

toCheck - if parameters is equal TRUE then checking performed whether all already started operations allow to start this operation above them (default value is TRUE

Returns:
TRUE if operation is started, FALSE otherwise
Verifies whether theOp operation can be started above already started ones (if toCheck parameter is equal TRUE) and starts it

bool SUIT_Study::abort ( SUIT_Operation * theOp ) [inherited]

Parameters:

theOp - operation to be aborted

Returns:
TRUE if operation is aborted successfully
Verifies whether operation already started and aborts it in this case (sets execution status to Rejected and stops operation)

bool SUIT_Study::commit ( SUIT_Operation * theOp ) [inherited]

Parameters:

theOp - operation to be committed

Returns:
TRUE if operation is committed successfully
Verifies whether operation already started and commits it in this case (sets execution status to Accepted and stops operation)

bool SUIT_Study::suspend ( SUIT_Operation * theOp ) [inherited]

Parameters:

theOp - operation to be committed

Returns:
TRUE if operation is suspended successfully
Verifies whether operation already started and suspends it in this case. Operations ususlly are suspended to start other one above them.

bool SUIT_Study::resume ( SUIT_Operation * theOp ) [inherited]

Parameters:

theOp - operation to be resumed

Returns:
TRUE if operation is aborted successfully
Verifies whether operation already started but suspended and resumesit in this case.

int SUIT_Study::storeState ( ) [virtual, inherited]

void SUIT_Study::restoreState ( int savePoint ) [virtual, inherited]

void SUIT_Study.studyModified ( SUIT_Study * ) [signal, inherited]

void SUIT_Study::setIsSaved ( const bool ) [protected, virtual, inherited]

Set study saved to on.

void SUIT_Study::setIsModified ( const bool ) [protected, virtual, inherited]

Set study modified to on.

void SUIT_Study::setRoot ( SUIT_DataObject * obj ) [protected, virtual, inherited]

Set root object.

void SUIT_Study::setStudyName ( const QString & name ) [protected, virtual, inherited]

Set study name.

void SUIT_Study::operationStarted ( SUIT_Operation * ) [protected, virtual, inherited]

void SUIT_Study::operationAborted ( SUIT_Operation * ) [protected, virtual, inherited]

void SUIT_Study::operationStopped ( SUIT_Operation * ) [protected, virtual, inherited]

void SUIT_Study::operationCommited ( SUIT_Operation * ) [protected, virtual, inherited]

bool SUIT_Study::openTransaction ( ) [protected, virtual, inherited]

Reimplemented in CAF_Study.

bool SUIT_Study::abortTransaction ( ) [protected, virtual, inherited]

Reimplemented in CAF_Study.

bool SUIT_Study::hasTransaction ( ) const [protected, virtual, inherited]

Reimplemented in CAF_Study.

bool SUIT_Study::commitTransaction ( const QString & = QString::null ) [protected, virtual, inherited]

Reimplemented in CAF_Study.

Field Documentation

ModelList CAM_Study.myDataModels [private]

CAM_Study Class Reference

Public Types

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation