src/StepData/StepData_DescrProtocol.hxx

   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 #ifndef _StepData_DescrProtocol_HeaderFile
  18 #define _StepData_DescrProtocol_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <TCollection_AsciiString.hxx>
  24 #include <StepData_FileProtocol.hxx>
  25 #include <Standard_CString.hxx>
  26
  27
  28 class StepData_DescrProtocol;
  29 DEFINE_STANDARD_HANDLE(StepData_DescrProtocol, StepData_FileProtocol)
  30
  31 //! A DescrProtocol is a protocol dynamically (at execution time)
  32 //! defined with :
  33 //! - a list of resources (inherits FileProtocol)
  34 //! - a list of entity descriptions
  35 //! i.e. it can be defined with only C++ writing to initialize it
  36 //! Its initialization must :
  37 //! - set its schema name
  38 //! - define its resources (which can also be other DescrProtocol)
  39 //! - define its entity descriptions
  40 //! - record it in the system by calling RecordLib
  41 class StepData_DescrProtocol : public StepData_FileProtocol
  42 {
  43
  44 public:
  45
  46
  47   Standard_EXPORT StepData_DescrProtocol();
  48
  49   //! Defines a specific Schema Name for this Protocol
  50   Standard_EXPORT void SetSchemaName (const Standard_CString name);
  51
  52   //! Records this Protocol in the service libraries, with a
  53   //! DescrGeneral and a DescrReadWrite
  54   //! Does nothing if the Protocol brings no proper description
  55   Standard_EXPORT void LibRecord() const;
  56
  57   //! Returns the Schema Name attached to each class of Protocol
  58   //! here, returns the SchemaName set by SetSchemaName
  59   //! was C++ : return const
  60   Standard_EXPORT virtual Standard_CString SchemaName() const Standard_OVERRIDE;
  61
  62
  63
  64
  65   DEFINE_STANDARD_RTTIEXT(StepData_DescrProtocol,StepData_FileProtocol)
  66
  67 protected:
  68
  69
  70
  71
  72 private:
  73
  74
  75   TCollection_AsciiString thename;
  76
  77
  78 };
  79
  80
  81
  82
  83
  84
  85
  86 #endif // _StepData_DescrProtocol_HeaderFile