src/StepData/StepData_DescrProtocol.cdl

   1 -- Created on: 1997-05-21
   2 -- Created by: Christian CAILLET
   3 -- Copyright (c) 1997-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class DescrProtocol  from StepData    inherits FileProtocol  from StepData
  18
  19     ---Purpose : A DescrProtocol is a protocol dynamically (at execution time)
  20     --           defined with :
  21     --           - a list of resources (inherits FileProtocol)
  22     --           - a list of entity descriptions
  23     --           i.e. it can be defined with only C++ writing to initialize it
  24     --           Its initialization must :
  25     --           - set its schema name
  26     --           - define its resources (which can also be other DescrProtocol)
  27     --           - define its entity descriptions
  28     --           - record it in the system by calling RecordLib
  29
  30 uses CString, AsciiString from TCollection
  31
  32 is
  33
  34     Create returns DescrProtocol;
  35
  36     SetSchemaName (me : mutable; name : CString);
  37     ---Purpose : Defines a specific Schema Name for this Protocol
  38
  39     LibRecord     (me);
  40     ---Purpose : Records this Protocol in the service libraries, with a
  41     --           DescrGeneral and a DescrReadWrite
  42     --           Does nothing if the Protocol brings no proper description
  43
  44     SchemaName (me) returns CString  is redefined;
  45     ---Purpose : Returns the Schema Name attached to each class of Protocol
  46     --           here, returns the SchemaName set by SetSchemaName
  47     -- was C++ : return const
  48
  49 fields
  50
  51     thename : AsciiString;
  52
  53 end DescrProtocol;