Open CASCADE Technology 7.8.2.dev
DDF_Transaction Class Reference

This class encapsulates TDF_Transaction. More...

#include <DDF_Transaction.hxx>

Inheritance diagram for DDF_Transaction:

Public Member Functions

 DDF_Transaction ()
 Creates an empty transaction context, unable to be opened.
 
 DDF_Transaction (const Handle< TDF_Data > &aDF)
 Creates a transaction context on <aDF>, ready to be opened.
 
Standard_Integer Open ()
 If not yet done, opens a new transaction on <myDF>. Returns the index of the just opened transaction.
 
Handle< TDF_DeltaCommit (const Standard_Boolean withDelta=Standard_False)
 Commits the transactions until AND including the current opened one.
 
void Abort ()
 Aborts the transactions until AND including the current opened one.
 
 ~DDF_Transaction ()
 
Handle< TDF_DataData () const
 Returns the Data from TDF.
 
Standard_Integer Transaction () const
 Returns the number of the transaction opened by <me>.
 
Standard_Boolean IsOpen () const
 Returns true if the transaction is open.
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter.
 
virtual ~Standard_Transient ()
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
 
Standard_Integer GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object.
 
Standard_Integer DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const char * get_type_name ()
 Returns a type descriptor about this object.
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class.
 

Detailed Description

This class encapsulates TDF_Transaction.

Constructor & Destructor Documentation

◆ DDF_Transaction() [1/2]

DDF_Transaction::DDF_Transaction ( )

Creates an empty transaction context, unable to be opened.

◆ DDF_Transaction() [2/2]

DDF_Transaction::DDF_Transaction ( const Handle< TDF_Data > & aDF)

Creates a transaction context on <aDF>, ready to be opened.

◆ ~DDF_Transaction()

DDF_Transaction::~DDF_Transaction ( )
inline

Member Function Documentation

◆ Abort()

void DDF_Transaction::Abort ( )

Aborts the transactions until AND including the current opened one.

◆ Commit()

Handle< TDF_Delta > DDF_Transaction::Commit ( const Standard_Boolean withDelta = Standard_False)

Commits the transactions until AND including the current opened one.

◆ Data()

Handle< TDF_Data > DDF_Transaction::Data ( ) const

Returns the Data from TDF.

◆ IsOpen()

Standard_Boolean DDF_Transaction::IsOpen ( ) const

Returns true if the transaction is open.

◆ Open()

Standard_Integer DDF_Transaction::Open ( )

If not yet done, opens a new transaction on <myDF>. Returns the index of the just opened transaction.

It raises DomainError if the transaction is already open, and NullObject if there is no current Data framework.

◆ Transaction()

Standard_Integer DDF_Transaction::Transaction ( ) const

Returns the number of the transaction opened by <me>.


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