Open CASCADE Technology  7.7.0.dev
Public Member Functions

TDF_Transaction Class Reference

This class offers services to open, commit or abort a transaction in a more secure way than using Data from TDF. If you forget to close a transaction, it will be automatically aborted at the destruction of this object, at the closure of its scope. More...

#include <TDF_Transaction.hxx>

Public Member Functions

 TDF_Transaction (const TCollection_AsciiString &aName="")
 Creates an empty transaction context, unable to be opened. More...
 
 TDF_Transaction (const Handle< TDF_Data > &aDF, const TCollection_AsciiString &aName="")
 Creates a transaction context on <aDF>, ready to be opened. More...
 
void Initialize (const Handle< TDF_Data > &aDF)
 Aborts all the transactions on <myDF> and sets <aDF> to build a transaction context on <aDF>, ready to be opened. More...
 
Standard_Integer Open ()
 If not yet done, opens a new transaction on <myDF>. Returns the index of the just opened transaction. More...
 
Handle< TDF_DeltaCommit (const Standard_Boolean withDelta=Standard_False)
 Commits the transactions until AND including the current opened one. More...
 
void Abort ()
 Aborts the transactions until AND including the current opened one. More...
 
 ~TDF_Transaction ()
 
Handle< TDF_DataData () const
 Returns the Data from TDF. More...
 
Standard_Integer Transaction () const
 Returns the number of the transaction opened by <me>. More...
 
const TCollection_AsciiStringName () const
 Returns the transaction name. More...
 
Standard_Boolean IsOpen () const
 Returns true if the transaction is open. More...
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 

Detailed Description

This class offers services to open, commit or abort a transaction in a more secure way than using Data from TDF. If you forget to close a transaction, it will be automatically aborted at the destruction of this object, at the closure of its scope.

In case of catching errors, the effect will be the same: aborting transactions until the good current one.

Constructor & Destructor Documentation

◆ TDF_Transaction() [1/2]

TDF_Transaction::TDF_Transaction ( const TCollection_AsciiString aName = "")

Creates an empty transaction context, unable to be opened.

◆ TDF_Transaction() [2/2]

TDF_Transaction::TDF_Transaction ( const Handle< TDF_Data > &  aDF,
const TCollection_AsciiString aName = "" 
)

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

◆ ~TDF_Transaction()

TDF_Transaction::~TDF_Transaction ( )
inline

Member Function Documentation

◆ Abort()

void TDF_Transaction::Abort ( )

Aborts the transactions until AND including the current opened one.

◆ Commit()

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

Commits the transactions until AND including the current opened one.

◆ Data()

Handle< TDF_Data > TDF_Transaction::Data ( ) const

Returns the Data from TDF.

◆ DumpJson()

void TDF_Transaction::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const

Dumps the content of me into the stream.

◆ Initialize()

void TDF_Transaction::Initialize ( const Handle< TDF_Data > &  aDF)

Aborts all the transactions on <myDF> and sets <aDF> to build a transaction context on <aDF>, ready to be opened.

◆ IsOpen()

Standard_Boolean TDF_Transaction::IsOpen ( ) const

Returns true if the transaction is open.

◆ Name()

const TCollection_AsciiString& TDF_Transaction::Name ( ) const

Returns the transaction name.

◆ Open()

Standard_Integer TDF_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 TDF_Transaction::Transaction ( ) const

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


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