src/Interface/Interface_GlobalNodeOfReaderLib.hxx

   1 // Created on: 1992-02-03
   2 // Created by: Christian CAILLET
   3 // Copyright (c) 1992-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 _Interface_GlobalNodeOfReaderLib_HeaderFile
  18 #define _Interface_GlobalNodeOfReaderLib_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Transient.hxx>
  24 class Interface_ReaderModule;
  25 class Interface_Protocol;
  26 class Standard_Transient;
  27 class Interface_ReaderLib;
  28 class Interface_NodeOfReaderLib;
  29
  30
  31 class Interface_GlobalNodeOfReaderLib;
  32 DEFINE_STANDARD_HANDLE(Interface_GlobalNodeOfReaderLib, Standard_Transient)
  33
  34
  35 class Interface_GlobalNodeOfReaderLib : public Standard_Transient
  36 {
  37
  38 public:
  39
  40
  41   //! Creates an empty GlobalNode, with no Next
  42   Standard_EXPORT Interface_GlobalNodeOfReaderLib();
  43
  44   //! Adds a Module bound with a Protocol to the list : does
  45   //! nothing if already in the list, THAT IS, Same Type (exact
  46   //! match) and Same State (that is, IsEqual is not required)
  47   //! Once added, stores its attached Protocol in correspondence
  48   Standard_EXPORT void Add (const Handle(Interface_ReaderModule)& amodule, const Handle(Interface_Protocol)& aprotocol);
  49
  50   //! Returns the Module stored in a given GlobalNode
  51   Standard_EXPORT const Handle(Interface_ReaderModule)& Module() const;
  52
  53   //! Returns the attached Protocol stored in a given GlobalNode
  54   Standard_EXPORT const Handle(Interface_Protocol)& Protocol() const;
  55
  56   //! Returns the Next GlobalNode. If none is defined, returned
  57   //! value is a Null Handle
  58   Standard_EXPORT const Handle(Interface_GlobalNodeOfReaderLib)& Next() const;
  59
  60
  61
  62
  63   DEFINE_STANDARD_RTTI_INLINE(Interface_GlobalNodeOfReaderLib,Standard_Transient)
  64
  65 protected:
  66
  67
  68
  69
  70 private:
  71
  72
  73   Handle(Interface_ReaderModule) themod;
  74   Handle(Interface_Protocol) theprot;
  75   Handle(Interface_GlobalNodeOfReaderLib) thenext;
  76
  77
  78 };
  79
  80
  81
  82
  83
  84
  85
  86 #endif // _Interface_GlobalNodeOfReaderLib_HeaderFile