Files
OCCT/src/PCDM/PCDM_StorageDriver.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

102 lines
4.0 KiB
Plaintext
Executable File

-- Created on: 1997-11-03
-- Created by: Jean-Louis Frenkel
-- Copyright (c) 1997-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
deferred class StorageDriver from PCDM inherits Writer from PCDM
---Purpose: persistent implemention of storage.
--
-- The application must redefine one the two Make()
-- methods. The first one, if the application wants to
-- put only one document in the storage file.
--
-- The second method should be redefined to put
-- additional document that could be used by the
-- retrieval instead of the principal document, depending
-- on the schema used during the retrieval. For example,
-- a second document could be a standard
-- CDMShape_Document. This means that a client
-- application will already be able to extract a CDMShape_Document
-- of the file, if the Shape Schema remains unchanged.
--
---Category: persistent implemention of storage.
uses
Document from CDM,
Document from PCDM,
Data from Storage,
ExtendedString from TCollection,
Schema from Storage,
SequenceOfExtendedString from TColStd,
SequenceOfDocument from PCDM,
StoreStatus from PCDM
raises NoSuchObject from Standard,DriverError from PCDM
is
Make(me: mutable; aDocument: Document from CDM)
returns Document from PCDM
is virtual;
---Purpose: raises NotImplemented.
Make(me: mutable; aDocument: Document from CDM; Documents: out SequenceOfDocument from PCDM)
is virtual;
---Purpose:By default, puts in the Sequence the document returns
-- by the previous Make method.
--
--
SchemaName(me) returns ExtendedString from TCollection
is deferred;
LoadExtensions(me: mutable; aSchema: Schema from Storage; Extensions: SequenceOfExtendedString from TColStd)
is virtual;
Write(me: mutable; aDocument: Document from CDM; aFileName: ExtendedString from TCollection)
raises DriverError
---Purpose: Warning! raises DriverError if an error occurs during inside the
-- Make method.
is redefined virtual;
---Purpose: stores the content of the Document into a new file.
--
-- by default Write will use Make method to build a persistent
-- document and the Schema method to write the persistent document.
--
SetFormat (me : mutable; aformat : ExtendedString from TCollection);
GetFormat (me)
returns ExtendedString from TCollection;
IsError (me) returns Boolean from Standard;
SetIsError(me : mutable; theIsError : Boolean);
GetStoreStatus (me) returns StoreStatus from PCDM;
SetStoreStatus(me : mutable; theStoreStatus : StoreStatus from PCDM);
fields
myFormat : ExtendedString from TCollection;
myIsError: Boolean from Standard;
myStoreStatus: StoreStatus from PCDM;
end StorageDriver from PCDM;