Files
OCCT/src/TDF/TDF_Transaction.cdl
abv d5f74e42d6 0024624: Lost word in license statement in source files
License statement text corrected; compiler warnings caused by Bison 2.41 disabled for MSVC; a few other compiler warnings on 54-bit Windows eliminated by appropriate type cast
Wrong license statements corrected in several files.
Copyright and license statements added in XSD and GLSL files.
Copyright year updated in some files.
Obsolete documentation files removed from DrawResources.
2014-02-20 16:15:17 +04:00

121 lines
3.6 KiB
Plaintext

-- Created by: DAUTRY Philippe
-- Copyright (c) 1997-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
-- -------------------
---Version: 0.0
--Version Date Purpose
-- 0.0 Oct 1 1997 Creation
class Transaction from TDF
---Purpose: 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 automaticaly 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.
uses
Data from TDF,
Delta from TDF,
AsciiString from TCollection
raises
DomainError, NullObject from Standard
is
Create(aName : AsciiString from TCollection = "")
returns Transaction from TDF;
---Purpose: Creates an empty transaction context, unable to be
-- opened.
Create(aTrans : Transaction from TDF)
returns Transaction from TDF
is private;
---Purpose: Private to avoid copy.
Create(aDF : Data from TDF;
aName : AsciiString from TCollection = "")
returns Transaction from TDF;
---Purpose: Creates a transaction context on <aDF>, ready to
-- be opened.
Initialize(me : in out; aDF : Data from TDF);
---Purpose: Aborts all the transactions on <myDF> and sets
-- <aDF> to build a transaction context on <aDF>,
-- ready to be opened.
Open(me : in out)
returns Integer from Standard
raises DomainError, NullObject from Standard;
---Purpose: 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.
Commit(me : in out;
withDelta : Boolean from Standard = Standard_False)
returns Delta from TDF;
---Purpose: Commits the transactions until AND including the
-- current opened one.
Abort(me : in out);
---Purpose: Aborts the transactions until AND including the
-- current opened one.
--
---C++: alias ~
Data(me) returns Data from TDF;
---Purpose: Returns the Data from TDF.
--
---C++: inline
Transaction(me) returns Integer from Standard;
---Purpose: Returns the number of the transaction opened by <me>.
--
---C++: inline
Name(me) returns AsciiString from TCollection;
---Purpose: Returns the transaction name.
--
---C++: return const &
IsOpen(me)
returns Boolean from Standard;
---Purpose: Returns true if the transaction is open.
--
---C++: inline
fields
myDF : Data from TDF;
myUntilTransaction : Integer from Standard;
myName : AsciiString from TCollection;
end Transaction;