src/XmlMDF/XmlMDF_ADriver.cdl

   1 -- Created on: 2001-07-09
   2 -- Created by: Julia DOROVSKIKH
   3 -- Copyright (c) 2001-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 XmlMDF inherits TShared from MMgt
  17
  18         ---Purpose: Attribute Storage/Retrieval Driver.
  19
  20 uses
  21     AsciiString         from TCollection,
  22     ExtendedString      from TCollection,
  23     Attribute           from TDF,
  24     MessageDriver       from CDM,
  25     RRelocationTable    from XmlObjMgt,
  26     SRelocationTable    from XmlObjMgt,
  27     Persistent          from XmlObjMgt,
  28     Element             from XmlObjMgt
  29
  30 is
  31     Initialize (theMessageDriver : MessageDriver from CDM;
  32                 theNamespace     : CString from Standard;
  33                 theName          : CString from Standard = NULL);
  34
  35     VersionNumber(me) returns Integer from Standard
  36         is virtual;
  37         ---Purpose: Returns the version number from which the driver
  38         --          is available.
  39
  40     NewEmpty    (me)
  41         returns Attribute from TDF
  42         is deferred;
  43         ---Purpose: Creates a new attribute from TDF.
  44
  45     SourceType  (me) returns Type from Standard;
  46         ---Purpose: Returns the type of source object,
  47         --          inheriting from Attribute from TDF.
  48
  49     TypeName    (me)
  50         returns AsciiString from TCollection
  51         is static;
  52         ---C++: return const &
  53         ---Purpose: Returns the full XML tag name (including NS prefix)
  54
  55     Paste       (me; aSource     : Persistent from XmlObjMgt;
  56                      aTarget     : Attribute from TDF;
  57                      aRelocTable : out RRelocationTable from XmlObjMgt)
  58         returns Boolean from Standard
  59         is deferred;
  60         ---Purpose: Translate the contents of <aSource> and put it
  61         --          into <aTarget>, using the relocation table
  62         --          <aRelocTable> to keep the sharings.
  63
  64     Paste       (me; aSource     : Attribute from TDF;
  65                      aTarget     : in out Persistent from XmlObjMgt;
  66                      aRelocTable : out SRelocationTable from XmlObjMgt)
  67         is deferred;
  68         ---Purpose: Translate the contents of <aSource> and put it
  69         --          into <aTarget>, using the relocation table
  70         --          <aRelocTable> to keep the sharings.
  71
  72     WriteMessage (me; theMessage : ExtendedString from TCollection);
  73         ---Purpose: Send message to Application (usually when error occurres)
  74
  75 fields
  76
  77     myMessageDriver : MessageDriver from CDM;
  78     myTypeName      : AsciiString from TCollection is protected;
  79
  80 end ADriver;