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;
0031 DEFINE_STANDARD_HANDLE(Interface_GlobalNodeOfGeneralLib, Standard_Transient)
0032
0033 class Interface_GlobalNodeOfGeneralLib : public Standard_Transient
0034 {
0035
0036 public:
0037   //! Creates an empty GlobalNode, with no Next
0038   Standard_EXPORT Interface_GlobalNodeOfGeneralLib();
0039
0040   //! Adds a Module bound with a Protocol to the list : does
0041   //! nothing if already in the list, THAT IS, Same Type (exact
0042   //! match) and Same State (that is, IsEqual is not required)
0043   //! Once added, stores its attached Protocol in correspondence
0044   Standard_EXPORT void Add(const Handle(Interface_GeneralModule)& amodule,
0045                            const Handle(Interface_Protocol)&      aprotocol);
0046
0047   //! Returns the Module stored in a given GlobalNode
0048   Standard_EXPORT const Handle(Interface_GeneralModule)& Module() const;
0049
0050   //! Returns the attached Protocol stored in a given GlobalNode
0051   Standard_EXPORT const Handle(Interface_Protocol)& Protocol() const;
0052
0053   //! Returns the Next GlobalNode. If none is defined, returned
0054   //! value is a Null Handle
0055   Standard_EXPORT const Handle(Interface_GlobalNodeOfGeneralLib)& Next() const;
0056
0057   DEFINE_STANDARD_RTTI_INLINE(Interface_GlobalNodeOfGeneralLib, Standard_Transient)
0058
0059 protected:
0060 private:
0061   Handle(Interface_GeneralModule)          themod;
0062   Handle(Interface_Protocol)               theprot;
0063   Handle(Interface_GlobalNodeOfGeneralLib) thenext;
0064 };
0065
0066 #endif // _Interface_GlobalNodeOfGeneralLib_HeaderFile