src/BinMDF/BinMDF_ADriver.cdl

   1 -- Created on: 2002-10-29
   2 -- Created by: Michael SAZONOV
   3 -- Copyright (c) 2002-2014 OPEN CASCADE SAS
   4 --
   5 -- This file is part of Open CASCADE Technology software library.
   6 --
   7 -- This library is free software; you can redistribute it and/or modify it under
   8 -- the terms of the GNU Lesser General Public License version 2.1 as published
   9 -- by the Free Software Foundation, with special exception defined in the file
  10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 -- distribution for complete text of the license and disclaimer of any warranty.
  12 --
  13 -- Alternatively, this file may be used under the terms of Open CASCADE
  14 -- commercial license or contractual agreement.
  15
  16 deferred class ADriver from BinMDF inherits TShared from MMgt
  17
  18         ---Purpose: Attribute Storage/Retrieval Driver.
  19
  20 uses
  21     ExtendedString   from TCollection,
  22     MessageDriver    from CDM,
  23     AsciiString      from TCollection,
  24     Attribute        from TDF,
  25     RRelocationTable from BinObjMgt,
  26     SRelocationTable from BinObjMgt,
  27     Persistent       from BinObjMgt
  28
  29 is
  30     Initialize (theMsgDriver: MessageDriver from CDM;
  31                 theName     : CString from Standard = NULL);
  32
  33     NewEmpty    (me)
  34         returns Attribute from TDF
  35         is deferred;
  36         ---Purpose: Creates a new attribute from TDF.
  37
  38     SourceType  (me) returns Type from Standard;
  39         ---C++: return const &
  40         ---C++: inline
  41         ---Purpose: Returns the type of source object,
  42         --          inheriting from Attribute from TDF.
  43
  44     TypeName    (me)
  45         returns AsciiString from TCollection
  46         is static;
  47         ---C++: return const &
  48         ---C++: inline
  49         ---Purpose: Returns the type name of the attribute object
  50
  51     Paste       (me; aSource     : Persistent from BinObjMgt;
  52                      aTarget     : Attribute from TDF;
  53                      aRelocTable : out RRelocationTable from BinObjMgt)
  54         returns Boolean from Standard is deferred;
  55         ---Purpose: Translate the contents of <aSource> and put it
  56         --          into <aTarget>, using the relocation table
  57         --          <aRelocTable> to keep the sharings.
  58
  59     Paste       (me; aSource     : Attribute from TDF;
  60                      aTarget     : in out Persistent from BinObjMgt;
  61                      aRelocTable : out SRelocationTable from BinObjMgt)
  62         is deferred;
  63         ---Purpose: Translate the contents of <aSource> and put it
  64         --          into <aTarget>, using the relocation table
  65         --          <aRelocTable> to keep the sharings.
  66
  67     WriteMessage (me; theMessage : ExtendedString from TCollection);
  68         ---Purpose: Send message to Application (usually when error occurres)
  69
  70 fields
  71
  72     myMessageDriver : MessageDriver from CDM;
  73     myTypeName      : AsciiString   from TCollection is protected;
  74
  75 end ADriver;