CAF_Study Class Reference

#include <CAF_Study.h>

Inheritance diagram for CAF_Study:


Signals
void	studyModified (SUIT_Study *)
Public Member Functions
	CAF_Study (SUIT_Application *theApp)
	CAF_Study (SUIT_Application *theApp, Handle(TDocStd_Document)&aStdDoc)
virtual	~CAF_Study ()
virtual void	createDocument ()
virtual void	closeDocument (bool=true)
virtual bool	openDocument (const QString &)
virtual bool	saveDocumentAs (const QString &)
bool	isSaved () const
bool	isModified () const
void	doModified (bool=true)
void	undoModified ()
void	clearModified ()
bool	undo ()
bool	redo ()
bool	canUndo () const
bool	canRedo () const
QStringList	undoNames () const
QStringList	redoNames () const
	Handle (TDocStd_Document) stdDoc() const
virtual int	id () const
SUIT_DataObject *	root () const
QString	studyName () const
SUIT_Application *	application () const
bool	saveDocument ()
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 Member Functions
	Handle (TDocStd_Application) stdApp() const
CAF_Application *	cafApplication () const
virtual bool	openTransaction ()
virtual bool	abortTransaction ()
virtual bool	hasTransaction () const
virtual bool	commitTransaction (const QString &=QString::null)
virtual void	setStdDoc (Handle(TDocStd_Document)&)
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.
Private Member Functions
	Handle (TDocStd_Document) myStdDoc
Private Attributes
int	myModifiedCnt
Friends
class	CAF_Operation

Detailed Description

Represents study for using in CAF, contains reference to OCAF std document and allows to use OCAF services. Provides necessary functionality for OCC transactions management.

Constructor & Destructor Documentation

CAF_Study::CAF_Study ( SUIT_Application * theApp )

Constructor

CAF_Study::CAF_Study ( SUIT_Application * theApp,

Handle(TDocStd_Document)& aStdDoc

)

Constructor

CAF_Study::~CAF_Study ( ) [virtual]

Destructor

Member Function Documentation

void CAF_Study::createDocument ( ) [virtual]

Custom document initialization
Reimplemented from SUIT_Study.

void CAF_Study::closeDocument ( bool permanent = true ) [virtual]

Close document
Reimplemented from SUIT_Study.

bool CAF_Study::openDocument ( const QString & fname ) [virtual]

Open document
Parameters:

fname - name of file

Reimplemented from SUIT_Study.

bool CAF_Study::saveDocumentAs ( const QString & fname ) [virtual]

Save document with other name
Parameters:

fname - name of file

Reimplemented from SUIT_Study.

bool CAF_Study::isSaved ( ) const [virtual]

Returns:
whether the document was saved in file. [ public ]

Reimplemented from SUIT_Study.

bool CAF_Study::isModified ( ) const [virtual]

Returns:
whether the document is modified. [ public ]

Reimplemented from SUIT_Study.

void CAF_Study::doModified ( bool undoable = true )

Increments modification count. If 'undoable' is 'true', this modification can be rolled back by 'undoModified' otherwise the document will be marked as 'modiifed' until saved. [ protected ]

void CAF_Study::undoModified ( )

Decrements modification count. [ protected ]

void CAF_Study::clearModified ( )

Clears modification count. [ public ]

bool CAF_Study::undo ( )

Undoes the last command. [ public ]

bool CAF_Study::redo ( )

Redoes the last undo. [ public ]

bool CAF_Study::canUndo ( ) const

Returns:
true if possible to perform 'undo' command. [ public ]

bool CAF_Study::canRedo ( ) const

Returns:
true if possible to perform 'redo' command. [ public ]

QStringList CAF_Study::undoNames ( ) const

Returns:
the list of names of 'undo' actions available. [ public ]

QStringList CAF_Study::redoNames ( ) const

Returns:
the list of names of 'redo' actions available. [ public ]

CAF_Study.Handle ( TDocStd_Document ) const

CAF_Study.Handle ( TDocStd_Application ) const [protected]

CAF_Application * CAF_Study::cafApplication ( ) const [protected]

Returns:
the application casted to type CAF_Application. [ protected ]

bool CAF_Study::openTransaction ( ) [protected, virtual]

Open OCAF transaction
Reimplemented from SUIT_Study.

bool CAF_Study::abortTransaction ( ) [protected, virtual]

Abort OCAF transaction
Reimplemented from SUIT_Study.

bool CAF_Study::hasTransaction ( ) const [protected, virtual]

Returns:
true, if there is opened OCAF transaction

Reimplemented from SUIT_Study.

bool CAF_Study::commitTransaction ( const QString & name = QString::null ) [protected, virtual]

Commit OCAF transaction
Reimplemented from SUIT_Study.

void CAF_Study::setStdDoc ( Handle(TDocStd_Document)& aStdDoc ) [protected, virtual]

Sets new OCAF document
Parameters:

aStdDoc - new OCAF document

CAF_Study.Handle ( TDocStd_Document ) [private]

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::saveDocument ( ) [inherited]

Return values:

TRUE - if document saved successful, else FALSE.

Reimplemented in 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]

Friends And Related Function Documentation

friend class CAF_Operation [friend]

Field Documentation

int CAF_Study.myModifiedCnt [private]

CAF_Study Class Reference

Signals

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation