include/opencascade/Interface_GlobalNodeOfGeneralLib.hxx

0001 // Created on: 1992-02-03
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1992-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Interface_GlobalNodeOfGeneralLib_HeaderFile
0018 #define _Interface_GlobalNodeOfGeneralLib_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024 class Interface_GeneralModule;
0025 class Interface_Protocol;
0026 class Standard_Transient;
0027 class Interface_GeneralLib;
0028 class Interface_NodeOfGeneralLib;
0029
0030 class Interface_GlobalNodeOfGeneralLib : public Standard_Transient
0031 {
0032
0033 public:
0034   //! Creates an empty GlobalNode, with no Next
0035   Standard_EXPORT Interface_GlobalNodeOfGeneralLib();
0036
0037   //! Adds a Module bound with a Protocol to the list : does
0038   //! nothing if already in the list, THAT IS, Same Type (exact
0039   //! match) and Same State (that is, IsEqual is not required)
0040   //! Once added, stores its attached Protocol in correspondence
0041   Standard_EXPORT void Add(const occ::handle<Interface_GeneralModule>& amodule,
0042                            const occ::handle<Interface_Protocol>&      aprotocol);
0043
0044   //! Returns the Module stored in a given GlobalNode
0045   Standard_EXPORT const occ::handle<Interface_GeneralModule>& Module() const;
0046
0047   //! Returns the attached Protocol stored in a given GlobalNode
0048   Standard_EXPORT const occ::handle<Interface_Protocol>& Protocol() const;
0049
0050   //! Returns the Next GlobalNode. If none is defined, returned
0051   //! value is a Null Handle
0052   Standard_EXPORT const occ::handle<Interface_GlobalNodeOfGeneralLib>& Next() const;
0053
0054   DEFINE_STANDARD_RTTI_INLINE(Interface_GlobalNodeOfGeneralLib, Standard_Transient)
0055
0056 private:
0057   occ::handle<Interface_GeneralModule>          themod;
0058   occ::handle<Interface_Protocol>               theprot;
0059   occ::handle<Interface_GlobalNodeOfGeneralLib> thenext;
0060 };
0061
0062 #endif // _Interface_GlobalNodeOfGeneralLib_HeaderFile