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-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23 class DescrProtocol  from StepData    inherits FileProtocol  from StepData
  24
  25     ---Purpose : A DescrProtocol is a protocol dynamically (at execution time)
  26     --           defined with :
  27     --           - a list of resources (inherits FileProtocol)
  28     --           - a list of entity descriptions
  29     --           i.e. it can be defined with only C++ writing to initialize it
  30     --           Its initialization must :
  31     --           - set its schema name
  32     --           - define its resources (which can also be other DescrProtocol)
  33     --           - define its entity descriptions
  34     --           - record it in the system by calling RecordLib
  35
  36 uses CString, AsciiString from TCollection
  37
  38 is
  39
  40     Create returns mutable DescrProtocol;
  41
  42     SetSchemaName (me : mutable; name : CString);
  43     ---Purpose : Defines a specific Schema Name for this Protocol
  44
  45     LibRecord     (me);
  46     ---Purpose : Records this Protocol in the service libraries, with a
  47     --           DescrGeneral and a DescrReadWrite
  48     --           Does nothing if the Protocol brings no proper description
  49
  50     SchemaName (me) returns CString  is redefined;
  51     ---Purpose : Returns the Schema Name attached to each class of Protocol
  52     --           here, returns the SchemaName set by SetSchemaName
  53     -- was C++ : return const
  54
  55 fields
  56
  57     thename : AsciiString;
  58
  59 end DescrProtocol;