Version: 8.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
CAF_Operation Class Reference

Base operation class for all operations used in CAF package. More...

#include <CAF_Operation.h>

Inheritance diagram for CAF_Operation:
Inheritance graph

Public Member Functions

 CAF_Operation (SUIT_Application *)
 Constructor. More...
 
virtual ~CAF_Operation ()
 Destructor. More...
 
- Public Member Functions inherited from SUIT_Operation
 SUIT_Operation (SUIT_Application *)
 Constructor. More...
 
virtual ~SUIT_Operation ()
 Destructor. More...
 
OperationState state () const
 Gets state of operation. More...
 
bool isActive () const
 Verifies whether operation is an active for study. More...
 
bool isRunning () const
 Verifies whether operation is an runned one (state()==Running) More...
 
SUIT_Studystudy () const
 Returns operation study. More...
 
virtual void setStudy (SUIT_Study *theStudy)
 Sets operation study. More...
 
SUIT_Applicationapplication () const
 Gets application. More...
 
virtual void setApplication (SUIT_Application *theApp)
 Sets application. More...
 
virtual bool isValid (SUIT_Operation *theOtherOp) const
 Verifies whether given operator is valid for this one. More...
 
virtual bool isGranted () const
 Verifies whether this operator can be always started above any already runnig one. More...
 
bool setSlot (const QObject *theReceiver, const char *theSlot)
 Sets slot which is called when operation is started. More...
 
void setFlags (const int)
 Sets the flags of operation. More...
 
void clearFlags (const int)
 Clears the flags of operation. More...
 
bool testFlags (const int) const
 Test the flags of operation. More...
 
virtual QString operationName () const
 Name of the operation. More...
 
int execStatus () const
 Gets execution status. More...
 

Protected Member Functions

 Handle (TDocStd_Document) stdDoc() const
 
- Protected Member Functions inherited from SUIT_Operation
virtual bool isReadyToStart () const
 Verifies whether operator is ready to start. More...
 
virtual void stopOperation ()
 Virtual method called when operation is started. More...
 
virtual void startOperation ()
 Virtual method called when operation is started. More...
 
virtual void abortOperation ()
 Virtual method called when operation aborted. More...
 
virtual void commitOperation ()
 Virtual method called when operation committed. More...
 
virtual void resumeOperation ()
 Virtual method called when operation resumed. More...
 
virtual void suspendOperation ()
 Virtual method called when operation suspended. 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...
 
void setExecStatus (const int)
 Sets execution status. More...
 
void setState (const OperationState)
 Sets state of operation. More...
 
void start (SUIT_Operation *, const bool=false)
 Starts operator above this one. More...
 

Additional Inherited Members

- Public Types inherited from SUIT_Operation
enum  OperationState { Waiting, Running, Suspended }
 
enum  ExecStatus { Rejected, Accepted }
 
enum  Flags { None = 0x00, Transaction = 0x01 }
 
- Public Slots inherited from SUIT_Operation
void start ()
 Starts operation. More...
 
void abort ()
 Aborts operation. More...
 
void commit ()
 Commits operation. More...
 
void resume ()
 Resumes operation. More...
 
void suspend ()
 Suspend operation. More...
 
- Signals inherited from SUIT_Operation
void started (SUIT_Operation *)
 
void aborted (SUIT_Operation *)
 
void committed (SUIT_Operation *)
 
void stopped (SUIT_Operation *)
 
void resumed (SUIT_Operation *)
 
void suspended (SUIT_Operation *)
 
void callSlot ()
 

Detailed Description

Operation interacts with OCC OCAF std document.

Constructor & Destructor Documentation

CAF_Operation::CAF_Operation ( SUIT_Application theApp)
Parameters
theAppapplication
CAF_Operation::~CAF_Operation ( )
virtual

Member Function Documentation

CAF_Operation::Handle ( TDocStd_Document  ) const
protected

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