#include <SUIT_Study.h>

Inheritance diagram for SUIT_Study:

Signals
void	studyModified (SUIT_Study *)

Public Member Functions
	SUIT_Study (SUIT_Application *)

virtual	~SUIT_Study ()

virtual int	id () const

SUIT_DataObject *	root () const

virtual QString	studyName () const

SUIT_Application *	application () const

virtual bool	isSaved () const

virtual bool	isModified () const

virtual void	Modified ()

virtual void	closeDocument (bool=true)

virtual bool	openDocument (const QString &)

virtual bool	createDocument (const QString &)

bool	saveDocument ()

virtual bool	saveDocumentAs (const QString &, bool isBackup=false)

virtual void	update ()

virtual void	sendChangesNotification ()

SUIT_Operation *	activeOperation () const

virtual void	abortAllOperations ()

const QList< SUIT_Operation * > &	operations () const
	Get all started operations. More...

virtual SUIT_Operation *	blockingOperation (SUIT_Operation *) const
	Verifies whether operation can be activated above already started ones. More...

bool	start (SUIT_Operation *, const bool check=true)
	Starts operation. More...

bool	abort (SUIT_Operation *)
	Aborts operation. More...

bool	commit (SUIT_Operation *)
	Commits operation. More...

bool	suspend (SUIT_Operation *)
	Commits operation. More...

bool	resume (SUIT_Operation *)
	Resumes operation. More...

virtual void	restoreState (int savePoint)
	Restores the study state. More...

Protected Member Functions
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. More...

virtual void	operationAborted (SUIT_Operation *)
	Perform some actions when operation aborted. More...

virtual void	operationStopped (SUIT_Operation *)
	Perform some actions when operation stopped. More...

virtual void	operationCommited (SUIT_Operation *)
	Perform some actions when operation commited. More...

virtual bool	openTransaction ()
	Opens transaction for data modifications. More...

virtual bool	abortTransaction ()
	Aborts transaction and all performed data modifications. More...

virtual bool	hasTransaction () const
	Returns `true` if transaction is opened. More...

virtual bool	commitTransaction (const QString &=QString())
	Commits transaction and all performed data modifications. More...

Private Types
typedef QList< SUIT_Operation * >	Operations

Private Member Functions
void	stop (SUIT_Operation *)
	Stops operation. More...

Private Attributes
int	myId

SUIT_Application *	myApp

SUIT_DataObject *	myRoot

QString	myName

bool	myIsSaved

bool	myIsModified

Operations	myOperations

bool	myBlockChangeState

Friends
class	SUIT_Operation

Detailed Description

Support study management. Object management. Operation management.

Member Typedef Documentation

◆ Operations

typedef QList<SUIT_Operation*> SUIT_Study::Operations

private

Constructor & Destructor Documentation

◆ SUIT_Study()

SUIT_Study::SUIT_Study ( SUIT_Application * app )

Constructor.

References myId, and myRoot.

◆ ~SUIT_Study()

SUIT_Study::~SUIT_Study ( )

virtual

Destructor.

References myRoot.

Member Function Documentation

◆ abort()

bool SUIT_Study::abort ( SUIT_Operation * theOp )

Aborts operation.

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)

References SUIT_Operation::aborted(), SUIT_Operation::abortOperation(), myOperations, operationAborted(), SUIT_Operation::Rejected, SUIT_Operation::setExecStatus(), and stop().

◆ abortAllOperations()

void SUIT_Study::abortAllOperations ( )

virtual

Abort all operations.

References myBlockChangeState, and myOperations.

◆ abortTransaction()

bool SUIT_Study::abortTransaction ( )

protectedvirtual

Aborts transaction and all performed data modifications.

Reimplemented in CAF_Study.

◆ activeOperation()

SUIT_Operation * SUIT_Study::activeOperation ( ) const

Return values

active operation.

References myOperations.

◆ application()

SUIT_Application * SUIT_Study::application ( ) const

Return values

Application.

References myApp.

◆ blockingOperation()

SUIT_Operation * SUIT_Study::blockingOperation ( SUIT_Operation * theOp ) const

virtual

Verifies whether operation can be activated above already started ones.

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.

References SUIT_Operation::isGranted(), SUIT_Operation::isValid(), and myOperations.

◆ closeDocument()

void SUIT_Study::closeDocument ( bool = true )

virtual

Close document. NOT IMPLEMENTED.

Reimplemented in CAF_Study, SalomeApp_Study, LightApp_Study, and CAM_Study.

◆ commit()

bool SUIT_Study::commit ( SUIT_Operation * theOp )

Commits operation.

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)

References SUIT_Operation::Accepted, SUIT_Operation::commitOperation(), SUIT_Operation::committed(), myOperations, operationCommited(), SUIT_Operation::setExecStatus(), stop(), and studyModified().

◆ commitTransaction()

bool SUIT_Study::commitTransaction ( const QString & = QString() )

protectedvirtual

Commits transaction and all performed data modifications.

Reimplemented in CAF_Study.

◆ createDocument()

bool SUIT_Study::createDocument ( const QString & )

virtual

Custom document initialization to be performed
within onNewDoc() handler can be put here

Reimplemented in SalomeApp_Study, LightApp_Study, and CAF_Study.

◆ hasTransaction()

bool SUIT_Study::hasTransaction ( ) const

protectedvirtual

Returns true if transaction is opened.

Reimplemented in CAF_Study.

◆ id()

int SUIT_Study::id ( ) const

virtual

Return values

study id.

References myId.

◆ isModified()

bool SUIT_Study::isModified ( ) const

virtual

Return values

Reimplemented in SalomeApp_Study, LightApp_Study, and CAF_Study.

References myIsModified.

◆ isSaved()

bool SUIT_Study::isSaved ( ) const

virtual

Return values

Reimplemented in SalomeApp_Study, LightApp_Study, and CAF_Study.

References myIsSaved.

◆ Modified()

void SUIT_Study::Modified ( )

virtual

Set study modified to on.

Reimplemented in SalomeApp_Study.

References sendChangesNotification(), and setIsModified().

◆ openDocument()

bool SUIT_Study::openDocument ( const QString & fileName )

virtual

Open document. Sets file name. return true.

Reimplemented in SalomeApp_Study, LightApp_Study, and CAF_Study.

References myIsModified, myIsSaved, and myName.

◆ openTransaction()

bool SUIT_Study::openTransaction ( )

protectedvirtual

Opens transaction for data modifications.

Reimplemented in CAF_Study.

◆ operationAborted()

void SUIT_Study::operationAborted ( SUIT_Operation * op )

protectedvirtual

Perform some actions when operation aborted.

References SUIT_Operation::abortTransaction(), SUIT_Operation::testFlags(), and SUIT_Operation::Transaction.

◆ operationCommited()

void SUIT_Study::operationCommited ( SUIT_Operation * op )

protectedvirtual

Perform some actions when operation commited.

References SUIT_Operation::commitTransaction(), SUIT_Operation::operationName(), SUIT_Operation::testFlags(), and SUIT_Operation::Transaction.

◆ operations()

const QList< SUIT_Operation * > & SUIT_Study::operations ( ) const

Get all started operations.

Returns: List of all started operations

References myOperations.

◆ operationStarted()

void SUIT_Study::operationStarted ( SUIT_Operation * op )

protectedvirtual

Perform some actions when operation starting.

References SUIT_Operation::openTransaction(), SUIT_Operation::testFlags(), and SUIT_Operation::Transaction.

◆ operationStopped()

void SUIT_Study::operationStopped ( SUIT_Operation * )

protectedvirtual

Perform some actions when operation stopped.

◆ restoreState()

void SUIT_Study::restoreState ( int savePoint )

virtual

Restores the study state.

Reimplemented in SalomeApp_Study.

◆ resume()

bool SUIT_Study::resume ( SUIT_Operation * theOp )

Resumes operation.

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.

References blockingOperation(), myOperations, SUIT_Operation::resumed(), SUIT_Operation::resumeOperation(), SUIT_Operation::Running, SUIT_Operation::setState(), SUIT_Operation::state(), and suspend().

◆ root()

SUIT_DataObject * SUIT_Study::root ( ) const

Return values

root	data object.

References myRoot.

◆ saveDocument()

bool SUIT_Study::saveDocument ( )

Return values

References myName, and saveDocumentAs().

◆ saveDocumentAs()

bool SUIT_Study::saveDocumentAs	(	const QString &	fileName,
		bool	isBackup = `false`
	)

virtual

Save document as fileName. Set file name.

Reimplemented in SalomeApp_Study, and LightApp_Study.

References myIsModified, myIsSaved, and myName.

◆ sendChangesNotification()

void SUIT_Study::sendChangesNotification ( )

virtual

Emit study modified.

References studyModified().

◆ setIsModified()

void SUIT_Study::setIsModified ( const bool on )

protectedvirtual

Set study modified to on.

References myIsModified.

◆ setIsSaved()

void SUIT_Study::setIsSaved ( const bool on )

protectedvirtual

Set study saved to on.

References myIsSaved.

◆ setRoot()

void SUIT_Study::setRoot ( SUIT_DataObject * obj )

protectedvirtual

Set root object.

References myRoot, and SUIT_DataObject::reparentChildren().

◆ setStudyName()

void SUIT_Study::setStudyName ( const QString & name )

protectedvirtual

Set study name.

References myName.

◆ start()

bool SUIT_Study::start	(	SUIT_Operation *	theOp,
		const bool	toCheck = `true`
	)

Starts operation.

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

References activeOperation(), application(), blockingOperation(), SUIT_Operation::isReadyToStart(), myOperations, operationStarted(), SUIT_MessageBox::question(), SUIT_Operation::Rejected, SUIT_Operation::Running, SUIT_Operation::setExecStatus(), SUIT_Operation::setState(), SUIT_Operation::setStudy(), SUIT_Operation::started(), SUIT_Operation::startOperation(), SUIT_Operation::Suspended, and SUIT_Operation::suspendOperation().

◆ stop()

void SUIT_Study::stop ( SUIT_Operation * theOp )

private

Stops operation.

Parameters

theOp - operation to be stopped

Stops operation. This private method is called from abort() and commit() ones to perform common actions when operation is stopped

References blockingOperation(), myOperations, operationStopped(), resume(), SUIT_Operation::setState(), SUIT_Operation::stopOperation(), SUIT_Operation::stopped(), and SUIT_Operation::Waiting.

◆ studyModified

void SUIT_Study::studyModified ( SUIT_Study * )

signal

◆ studyName()

QString SUIT_Study::studyName ( ) const

virtual

Return values

study name

Reimplemented in SalomeApp_Study.

References myName.

◆ suspend()

bool SUIT_Study::suspend ( SUIT_Operation * theOp )

Commits operation.

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.

References myOperations, SUIT_Operation::setState(), SUIT_Operation::state(), SUIT_Operation::Suspended, SUIT_Operation::suspended(), and SUIT_Operation::suspendOperation().

◆ update()

void SUIT_Study::update ( )

virtual

Update study. NOT IMPLEMENTED HERE.

Friends And Related Function Documentation

◆ SUIT_Operation

friend class SUIT_Operation

friend

Member Data Documentation

◆ myApp

SUIT_Application* SUIT_Study::myApp

private

◆ myBlockChangeState

bool SUIT_Study::myBlockChangeState

private

◆ myId

int SUIT_Study::myId

private

◆ myIsModified

bool SUIT_Study::myIsModified

private

◆ myIsSaved

bool SUIT_Study::myIsSaved

private

◆ myName

QString SUIT_Study::myName

private

◆ myOperations

Operations SUIT_Study::myOperations

private

◆ myRoot

SUIT_DataObject* SUIT_Study::myRoot

private

The documentation for this class was generated from the following files:

src/SUIT/SUIT_Study.h
src/SUIT/SUIT_Study.cxx

Signals

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Operations

Constructor & Destructor Documentation

◆ SUIT_Study()

◆ ~SUIT_Study()

Member Function Documentation

◆ abort()

◆ abortAllOperations()

◆ abortTransaction()

◆ activeOperation()

◆ application()

◆ blockingOperation()

◆ closeDocument()

◆ commit()

◆ commitTransaction()

◆ createDocument()

◆ hasTransaction()

◆ id()

◆ isModified()

◆ isSaved()

◆ Modified()

◆ openDocument()

◆ openTransaction()

◆ operationAborted()

◆ operationCommited()

◆ operations()

◆ operationStarted()

◆ operationStopped()

◆ restoreState()

◆ resume()

◆ root()

◆ saveDocument()

◆ saveDocumentAs()

◆ sendChangesNotification()

◆ setIsModified()

◆ setIsSaved()

◆ setRoot()

◆ setStudyName()

◆ start()

◆ stop()

◆ studyModified

◆ studyName()

◆ suspend()

◆ update()

Friends And Related Function Documentation

◆ SUIT_Operation

Member Data Documentation

◆ myApp

◆ myBlockChangeState

◆ myId

◆ myIsModified

◆ myIsSaved

◆ myName

◆ myOperations

◆ myRoot