#include <SalomeApp_Study.h>

Inheritance diagram for SalomeApp_Study:

Data Structures
class	Observer_i
Public Types
typedef QList< CAM_DataModel * >	ModelList
Signals
void	saved (SUIT_Study *)
void	opened (SUIT_Study *)
void	closed (SUIT_Study *)
void	created (SUIT_Study *)
void	studyModified (SUIT_Study *)
Public Member Functions
	SalomeApp_Study (SUIT_Application *)
virtual	~SalomeApp_Study ()
virtual int	id () const
virtual QString	studyName () const
virtual bool	createDocument (const QString &)
virtual bool	openDocument (const QString &)
virtual bool	loadDocument (const QString &)
virtual bool	saveDocument ()
virtual bool	saveDocumentAs (const QString &)
virtual void	closeDocument (bool permanently=true)
virtual bool	isSaved () const
virtual bool	isModified () const
virtual void	Modified ()
virtual void	addComponent (const CAM_DataModel *dm)
	_PTR (Study) studyDS() const
virtual std::string	GetTmpDir (const char *theURL, const bool isMultiFile)
void	deleteReferencesTo (_PTR(SObject))
virtual QString	componentDataType (const QString &) const
virtual QString	referencedToEntry (const QString &) const
virtual bool	isComponent (const QString &) const
virtual void	children (const QString &, QStringList &) const
virtual void	components (QStringList &) const
virtual QString	centry (const QString &) const
std::vector< int >	getSavePoints ()
void	removeSavePoint (int savePoint)
QString	getNameOfSavePoint (int savePoint)
void	setNameOfSavePoint (int savePoint, const QString &nameOfSavePoint)
virtual void	restoreState (int savePoint)
	Restores the study state.
void	markAsSavedIn (QString theFileName)
virtual LightApp_DataObject *	findObjectByEntry (const QString &theEntry)
virtual QString	getVisualComponentName () const
virtual void	setObjectProperty (int theViewMgrId, QString theEntry, QString thePropName, QVariant theValue)
virtual QVariant	getObjectProperty (int theViewMgrId, QString theEntry, QString thePropName, QVariant theDefValue) const
virtual void	removeViewMgr (int theViewMgrId)
virtual void	setObjectPropMap (int theViewMgrId, QString theEntry, PropMap thePropMap)
virtual const PropMap &	getObjectPropMap (int theViewMgrId, QString theEntry)
virtual void	removeObjectFromAll (QString theEntry)
virtual const ObjMap &	getObjectMap (int theViewMgrId)
virtual const ViewMgrMap &	getViewMgrMap (int theViewMgrId)
virtual void	setVisibilityState (const QString &theEntry, Qtx::VisibilityState theState)
virtual Qtx::VisibilityState	visibilityState (const QString &theEntry) const
virtual void	setVisibilityStateForAll (Qtx::VisibilityState theState)
bool	appendDataModel (const CAM_DataModel *)
	Append data model to the study.
virtual bool	insertDataModel (const CAM_DataModel *, const int=-1)
	Insert data model dm with index idx.
bool	insertDataModel (const CAM_DataModel , const CAM_DataModel )
	Insert data model dm after data model other.
virtual bool	removeDataModel (const CAM_DataModel *)
	Remove data model from the study.
bool	containsDataModel (const CAM_DataModel *) const
	Check if data model is contained in the list.
void	dataModels (ModelList &) const
	Get all data models.
SUIT_DataObject *	root () const
SUIT_Application *	application () const
virtual void	update ()
virtual void	sendChangesNotification ()
SUIT_Operation *	activeOperation () const
virtual void	abortAllOperations ()
const QList< 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.
Protected Slots
virtual void	updateModelRoot (const CAM_DataModel *)
Protected Member Functions
virtual void	saveModuleData (QString theModuleName, QStringList theListOfFiles)
virtual void	openModuleData (QString theModuleName, QStringList &theListOfFiles)
virtual bool	saveStudyData (const QString &theFileName)
virtual bool	openStudyData (const QString &theFileName)
virtual std::vector< std::string >	GetListOfFiles (const char *theModuleName) const
virtual void	SetListOfFiles (const char *theModuleName, const std::vector< std::string > theListOfFiles)
virtual void	RemoveTemporaryFiles (const char *theModuleName, const bool isMultiFile) const
virtual void	dataModelInserted (const CAM_DataModel *)
virtual bool	openDataModel (const QString &, CAM_DataModel *)
void	setStudyDS (const _PTR(Study)&s)
virtual bool	saveDataModel (const QString &, CAM_DataModel *)
	Called when data model is saved.
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())
	Commits transaction and all performed data modifications.
Private Member Functions
QString	newStudyName () const
	_PTR (Study) myStudyDS
Private Attributes
Observer_i *	myObserver

Member Typedef Documentation

typedef QList<CAM_DataModel*> CAM_Study.ModelList [inherited]

Constructor & Destructor Documentation

SalomeApp_Study::SalomeApp_Study ( SUIT_Application * app )

Constructor.

SalomeApp_Study::~SalomeApp_Study ( ) [virtual]

Destructor.

Member Function Documentation

int SalomeApp_Study::id ( ) const [virtual]

Gets study id.

Reimplemented from SUIT_Study.

QString SalomeApp_Study::studyName ( ) const [virtual]

Get study name.

Reimplemented from SUIT_Study.

References SUIT_Study.application(), SUIT_Study.setStudyName(), and SUIT_Study.studyName().

bool SalomeApp_Study::createDocument ( const QString & theStr ) [virtual]

Create document.

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i._PTR(), test_big_table.aName, LightApp_Study.created(), myObserver, newStudyName(), SalomeApp_Study.Observer_i.Observer_i(), SUIT_Study.setRoot(), setStudyDS(), SUIT_Study.setStudyName(), SalomeApp_RootObject.setToSynchronize(), and SalomeApp_Application.studyMgr().

bool SalomeApp_Study::openDocument ( const QString & theFileName ) [virtual]

Opens document

Parameters:

theFileName - name of file

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i._PTR(), SUIT_Study.application(), QtxResourceMgr.booleanValue(), CAM_Study.dataModels(), getSavePoints(), myObserver, SalomeApp_Study.Observer_i.Observer_i(), openDataModel(), LightApp_Study.opened(), SUIT_Application.resourceMgr(), restoreState(), SUIT_Study.root(), SUIT_Study.setRoot(), setStudyDS(), SalomeApp_Application.studyMgr(), and studyName().

bool SalomeApp_Study::loadDocument ( const QString & theStudyName ) [virtual]

Connects GUI study to SALOMEDS one already loaded into StudyManager

Parameters:

theStudyName - name of study

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i._PTR(), SUIT_Study.application(), QtxResourceMgr.booleanValue(), CAM_Study.dataModels(), getSavePoints(), myObserver, SalomeApp_Study.Observer_i.Observer_i(), openDataModel(), openDocument(), LightApp_Study.opened(), SUIT_Application.resourceMgr(), restoreState(), SUIT_Study.root(), SUIT_Study.setRoot(), setStudyDS(), SalomeApp_Application.studyMgr(), and studyName().

bool SalomeApp_Study::saveDocument ( ) [virtual]

Saves previously opened document

Reimplemented from LightApp_Study.

References SUIT_Study.application(), QtxResourceMgr.booleanValue(), CAM_Study.dataModels(), SUIT_Application.resourceMgr(), LightApp_Study.saved(), SUIT_Study.saveDocument(), saveModuleData(), saveStudyData(), SalomeApp_VisualState.storeState(), SalomeApp_Application.studyMgr(), and studyName().

bool SalomeApp_Study::saveDocumentAs ( const QString & theFileName ) [virtual]

Saves document

Parameters:

theFileName - name of file

Reimplemented from LightApp_Study.

References SUIT_Study.application(), QtxResourceMgr.booleanValue(), CAM_Study.dataModels(), SUIT_Application.resourceMgr(), LightApp_Study.saved(), saveModuleData(), saveStudyData(), SalomeApp_VisualState.storeState(), and SalomeApp_Application.studyMgr().

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

Closes document

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i._PTR(), setStudyDS(), and SalomeApp_Application.studyMgr().

bool SalomeApp_Study::isSaved ( ) const [virtual]

Returns:: if data model is saved

Reimplemented from LightApp_Study.

bool SalomeApp_Study::isModified ( ) const [virtual]

Returns:: true, if study is modified in comparison with last open/save

Reimplemented from LightApp_Study.

void SalomeApp_Study::Modified ( ) [virtual]

Set study modified to on.

Reimplemented from SUIT_Study.

References SalomeApp_Study.Observer_i._PTR().

void SalomeApp_Study::addComponent ( const CAM_DataModel * dm ) [virtual]

Create SComponent for module, using default engine (CORBAless)

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i._PTR(), SalomeApp_Application.defaultEngineIOR(), CAM_Module.iconName(), CAM_DataModel.module(), CAM_Module.moduleName(), CAM_Module.name(), and synchronize().

SalomeApp_Study._PTR ( Study ) const

std::string SalomeApp_Study::GetTmpDir	(	const char *	theURL,
		const bool	isMultiFile
	)		`[virtual]`

Returns:: temporary directory for saving files of modules

Reimplemented from LightApp_Study.

void SalomeApp_Study::deleteReferencesTo ( _PTR(SObject) obj )

Deletes all references to object

Parameters:

obj - object

References SalomeApp_Study.Observer_i._PTR().

QString SalomeApp_Study::componentDataType ( const QString & entry ) const [virtual]

Returns:: component data type for entry

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i._PTR(), and PyInterp.obj.

QString SalomeApp_Study::referencedToEntry ( const QString & entry ) const [virtual]

Returns:: real entry by entry of reference

Parameters:

entry - entry of reference object

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i._PTR(), and PyInterp.obj.

bool SalomeApp_Study::isComponent ( const QString & entry ) const [virtual]

Returns:: true if entry corresponds to component

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i._PTR(), and PyInterp.obj.

void SalomeApp_Study::children	(	const QString &	entry,
		QStringList &	child_entries
	)		const `[virtual]`

Returns:: entries of object children

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i._PTR().

void SalomeApp_Study::components ( QStringList & comps ) const [virtual]

Fills list with components names

Parameters:

comp	- list to be filled

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i._PTR(), and LightApp_Study.getVisualComponentName().

QString SalomeApp_Study::centry ( const QString & comp ) const [virtual]

Get the entry for the given module

Parameters:

comp	- list to be filled

Returns:: module root's entry

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i._PTR().

std::vector< int > SalomeApp_Study::getSavePoints ( )

Returns:: a list of saved points' IDs

References SalomeApp_Study.Observer_i._PTR(), and LightApp_Study.getVisualComponentName().

void SalomeApp_Study::removeSavePoint ( int savePoint )

Removes a given save point

References SalomeApp_Study.Observer_i._PTR(), and LightApp_Study.getVisualComponentName().

QString SalomeApp_Study::getNameOfSavePoint ( int savePoint )

Returns:: a name of save point

References SalomeApp_Study.Observer_i._PTR(), and LightApp_Study.getVisualComponentName().

void SalomeApp_Study::setNameOfSavePoint	(	int	savePoint,
		const QString &	nameOfSavePoint
	)

Sets a name of save point

References SalomeApp_Study.Observer_i._PTR(), and LightApp_Study.getVisualComponentName().

void SalomeApp_Study::restoreState ( int savePoint ) [virtual]

Reimplemented from SUIT_Study.

References SUIT_Study.application(), and SalomeApp_VisualState.restoreState().

void SalomeApp_Study::markAsSavedIn ( QString theFileName )

Mark the study as saved in the file

Parameters:

theFileName - the name of file

References SUIT_Study.setIsSaved(), and SUIT_Study.setStudyName().

LightApp_DataObject * SalomeApp_Study::findObjectByEntry ( const QString & theEntry ) [virtual]

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i.findObject(), and myObserver.

void SalomeApp_Study::saveModuleData	(	QString	theModuleName,
		QStringList	theListOfFiles
	)		`[protected, virtual]`

Saves data of module

Parameters:

theModuleName	- name of module
theListOfFiles	- list of files to be saved

Reimplemented from LightApp_Study.

References SetListOfFiles().

void SalomeApp_Study::openModuleData	(	QString	theModuleName,
		QStringList &	theListOfFiles
	)		`[protected, virtual]`

Loads data of module

Parameters:

theModuleName	- name of module
theListOfFiles	- list of files to be loaded

Reimplemented from LightApp_Study.

References GetListOfFiles().

bool SalomeApp_Study::saveStudyData ( const QString & theFileName ) [protected, virtual]

Saves data from study

Reimplemented from LightApp_Study.

References CAM_Study.dataModels(), and SetListOfFiles().

bool SalomeApp_Study::openStudyData ( const QString & theFileName ) [protected, virtual]

Loads data for study

Reimplemented from LightApp_Study.

std::vector< std::string > SalomeApp_Study::GetListOfFiles ( const char * theModuleName ) const [protected, virtual]

Returns:: list of files used by module: to be used by CORBAless modules

Parameters:

theModuleName - name of module

Reimplemented from LightApp_Study.

References SalomeApp_Engine_i.GetInstance(), and SalomeApp_Engine_i.GetListOfFiles().

void SalomeApp_Study::SetListOfFiles	(	const char *	theModuleName,
		const std::vector< std::string >	theListOfFiles
	)		`[protected, virtual]`

Sets list of files used by module: to be used by CORBAless modules

Parameters:

theModuleName	- name of module
theListOfFiles	- list of files

Reimplemented from LightApp_Study.

References SalomeApp_Engine_i.GetInstance(), and SalomeApp_Engine_i.SetListOfFiles().

void SalomeApp_Study::RemoveTemporaryFiles	(	const char *	theModuleName,
		const bool	isMultiFile
	)		const `[protected, virtual]`

Removes temporary files

Reimplemented from LightApp_Study.

References GetListOfFiles().

void SalomeApp_Study::dataModelInserted ( const CAM_DataModel * dm ) [protected, virtual]

Insert data model.

Reimplemented from CAM_Study.

References CAM_DataModel.module(), and CAM_Module.name().

bool SalomeApp_Study::openDataModel	(	const QString &	studyName,
		CAM_DataModel *	dm
	)		`[protected, virtual]`

Open data model

Reimplemented from LightApp_Study.

References SalomeApp_Study.Observer_i._PTR(), SalomeApp_Application.defaultEngineIOR(), SalomeApp_Module.engineIOR(), SalomeApp_DataModel.getModule(), SalomeApp_DataModel.getRootEntry(), CAM_DataModel.module(), CAM_Module.name(), CAM_DataModel.open(), openModuleData(), RemoveTemporaryFiles(), and LightApp_DataModel.update().

void SalomeApp_Study::setStudyDS ( const _PTR(Study)& s ) [protected]

Set studyDS.

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

Slot: called on change of a root of a data model. Redefined from CAM_Study

Reimplemented from CAM_Study.

References SUIT_Study.application().

QString SalomeApp_Study::newStudyName ( ) const [private]

Create new study name.

References SalomeApp_Application.studyMgr().

SalomeApp_Study._PTR ( Study ) [private]

QString LightApp_Study::getVisualComponentName ( ) const [virtual, inherited]

Returns:: a name of the component where visual parameters are stored

void LightApp_Study::setObjectProperty	(	int	theViewId,
		QString	theEntry,
		QString	thePropName,
		QVariant	theValue
	)		`[virtual, inherited]`

Set a visual property of the object

Parameters:

theViewId	- Id of the viewer namager
theEntry	- Entry of the object
thePropName	- the name of the visual property
theValue	- the value of the visual property

References LightApp_Study.myViewMgrMap.

QVariant LightApp_Study::getObjectProperty	(	int	theViewMgrId,
		QString	theEntry,
		QString	thePropName,
		QVariant	theDefValue
	)		const `[virtual, inherited]`

Get a visual property of the object identified by theViewMgrId, theEntry and thePropName.

Parameters:

theViewMgrId	- Id of the viewer manager.
theEntry	- Entry of the object.
thePropName	- the name of the visual property.
theDefValue	- the default value of the visual property.

Returns:: value of the visual propetry. If value is't found then return theDefValue.

References LightApp_Study.myViewMgrMap.

void LightApp_Study::removeViewMgr ( int theViewMgrId ) [virtual, inherited]

Remove view manager with all objects.

Parameters:

theViewMgrId - Id of the viewer manager.

References LightApp_Study.myViewMgrMap.

void LightApp_Study::setObjectPropMap	(	int	theViewMgrId,
		QString	theEntry,
		PropMap	thePropMap
	)		`[virtual, inherited]`

Set a map of the properties of the object identified by theViewMgrId and theEntry.

Parameters:

theViewMgrId	- Id of the viewer manager.
theEntry	- Entry of the object.

References LightApp_Study.myViewMgrMap.

const PropMap & LightApp_Study::getObjectPropMap	(	int	theViewMgrId,
		QString	theEntry
	)		`[virtual, inherited]`

Get a map of the properties of the object identified by theViewMgrId and theEntry.

Parameters:

theViewMgrId	- Id of the viewer manager.
theEntry	- Entry of the object.

Returns:: a map of the properties of the object.

References LightApp_Study.myViewMgrMap.

void LightApp_Study::removeObjectFromAll ( QString theEntry ) [virtual, inherited]

Remove object's properties from all view managers.

Parameters:

theEntry - Entry of the object.

References LightApp_Study.myViewMgrMap.

const ObjMap & LightApp_Study::getObjectMap ( int theViewMgrId ) [virtual, inherited]

Get all objects and it's properties from view manager identified by theViewMgrId.

Parameters:

theEntry - Entry of the object.

References LightApp_Study.myViewMgrMap.

virtual const ViewMgrMap& LightApp_Study.getViewMgrMap ( int theViewMgrId ) [virtual, inherited]

void LightApp_Study::setVisibilityState	(	const QString &	theEntry,
		Qtx::VisibilityState	theState
	)		`[virtual, inherited]`

Set 'visibility state' property of the object.

Parameters:

theEntry	- Entry of the object.
theState	- visibility status

References SUIT_Study.application(), OB_Browser.model(), LightApp_Application.objectBrowser(), and SUIT_AbstractModel.setVisibilityState().

Qtx::VisibilityState LightApp_Study::visibilityState ( const QString & theEntry ) const [virtual, inherited]

Get 'visibility state' property of the object.

Parameters:

theEntry - Entry of the object.

Returns:: 'visibility state' property of the object.

References SUIT_Study.application(), OB_Browser.model(), LightApp_Application.objectBrowser(), Qtx.UnpresentableState, and SUIT_AbstractModel.visibilityState().

void LightApp_Study::setVisibilityStateForAll ( Qtx::VisibilityState theState ) [virtual, inherited]

Set 'visibility state' property for all object.

Parameters:

theEntry - Entry of the object.

References SUIT_Study.application(), OB_Browser.model(), LightApp_Application.objectBrowser(), and SUIT_AbstractModel.setVisibilityStateForAll().

void LightApp_Study.saved ( SUIT_Study * ) [signal, inherited]

void LightApp_Study.opened ( SUIT_Study * ) [signal, inherited]

void LightApp_Study.closed ( SUIT_Study * ) [signal, inherited]

void LightApp_Study.created ( SUIT_Study * ) [signal, inherited]

bool CAM_Study::appendDataModel ( const CAM_DataModel * dm ) [inherited]

Parameters:

dm	data model being added

Returns:: true on success and false on error

References CAM_Study.insertDataModel(), and CAM_Study.myDataModels.

bool CAM_Study::insertDataModel	(	const CAM_DataModel *	dm,
		const int	idx = `-1`
	)		`[virtual, inherited]`

Parameters:

dm	data model being added
idx	data model required index

Returns:: true on success and false on error

References CAM_Study.dataModelInserted(), CAM_Study.myDataModels, and CAM_Study.updateModelRoot().

bool CAM_Study::insertDataModel	(	const CAM_DataModel *	dm,
		const CAM_DataModel *	other
	)		`[inherited]`

If other is 0, the data model is added to the end of list.

Parameters:

dm	data model being added
other	data model to be previous in the list

Returns:: true on success and false on error

References CAM_Study.insertDataModel(), and CAM_Study.myDataModels.

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

Parameters:

dm	data model being removed

Returns:: true on success and false on error

References CAM_Study.myDataModels, CAM_DataModel.root(), and CAM_ModuleObject.setDataModel().

bool CAM_Study::containsDataModel ( const CAM_DataModel * dm ) const [inherited]

Parameters:

dm	data model

Returns:: true if data model is in the list and false otherwise.

References CAM_Study.myDataModels.

void CAM_Study::dataModels ( ModelList & lst ) const [inherited]

Parameters:

lst	returning list of data model.

References CAM_Study.myDataModels.

bool CAM_Study::saveDataModel	(	const QString &	,
		CAM_DataModel *
	)		`[protected, virtual, inherited]`

Base implementation does nothing and returns false.

Returns:: true on success and false on error

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

Return values:

root	data object.

References SUIT_Study.myRoot.

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

Return values:

Application.

References SUIT_Study.myApp.

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

Update study. NOT IMPLEMENTED HERE.

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

Emit study modified.

References SUIT_Study.studyModified().

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

Return values:

active operation.

References SUIT_Study.myOperations.

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

Abort all operations.

References SUIT_Study.myBlockChangeState, and SUIT_Study.myOperations.

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

Returns:: List of all started operations

References SUIT_Study.myOperations.

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.

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

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

References SUIT_Study.activeOperation(), SUIT_Study.application(), SUIT_Study.blockingOperation(), SUIT_Operation.isReadyToStart(), SUIT_Study.myOperations, SUIT_Study.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().

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)

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

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)

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

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.

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

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.

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

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

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

Set study saved to on.

References SUIT_Study.myIsSaved.

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

Set study modified to on.

References SUIT_Study.myIsModified.

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

Set root object.

References SUIT_Study.myRoot, PyInterp.obj, and SUIT_DataObject.reparentChildren().

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

Set study name.

References SUIT_Study.myName.

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

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

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

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

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

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

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

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() ) [protected, virtual, inherited]

Reimplemented in CAF_Study.

Field Documentation

Observer_i* SalomeApp_Study.myObserver [private]

SalomeApp_Study Class Reference

Data Structures

Public Types

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Private Member Functions

Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation