include/opencascade/IGESData_SpecificLib.hxx

0001 // Created on: 1992-04-06
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 _IGESData_SpecificLib_HeaderFile
0018 #define _IGESData_SpecificLib_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Integer.hxx>
0025 class IGESData_NodeOfSpecificLib;
0026 class Standard_NoSuchObject;
0027 class IGESData_IGESEntity;
0028 class IGESData_SpecificModule;
0029 class IGESData_Protocol;
0030 class IGESData_GlobalNodeOfSpecificLib;
0031 class Standard_Transient;
0032
0033 class IGESData_SpecificLib
0034 {
0035 public:
0036   DEFINE_STANDARD_ALLOC
0037
0038   //! Adds a couple (Module-Protocol) into the global definition set
0039   //! for this class of Library.
0040   Standard_EXPORT static void SetGlobal(const Handle(IGESData_SpecificModule)& amodule,
0041                                         const Handle(IGESData_Protocol)&       aprotocol);
0042
0043   //! Creates a Library which complies with a Protocol, that is :
0044   //! Same class (criterium IsInstance)
0045   //! This creation gets the Modules from the global set, those
0046   //! which are bound to the given Protocol and its Resources
0047   Standard_EXPORT IGESData_SpecificLib(const Handle(IGESData_Protocol)& aprotocol);
0048
0049   //! Creates an empty Library : it will later by filled by method
0050   //! AddProtocol
0051   Standard_EXPORT IGESData_SpecificLib();
0052
0053   //! Adds a couple (Module-Protocol) to the Library, given the
0054   //! class of a Protocol. Takes Resources into account.
0055   //! (if <aprotocol> is not of type TheProtocol, it is not added)
0056   Standard_EXPORT void AddProtocol(const Handle(Standard_Transient)& aprotocol);
0057
0058   //! Clears the list of Modules of a library (can be used to
0059   //! redefine the order of Modules before action : Clear then
0060   //! refill the Library by calls to AddProtocol)
0061   Standard_EXPORT void Clear();
0062
0063   //! Sets a library to be defined with the complete Global list
0064   //! (all the couples Protocol/Modules recorded in it)
0065   Standard_EXPORT void SetComplete();
0066
0067   //! Selects a Module from the Library, given an Object.
0068   //! Returns True if Select has succeeded, False else.
0069   //! Also Returns (as arguments) the selected Module and the Case
0070   //! Number determined by the associated Protocol.
0071   //! If Select has failed, <module> is Null Handle and CN is zero.
0072   //! (Select can work on any criterium, such as Object DynamicType)
0073   Standard_EXPORT Standard_Boolean Select(const Handle(IGESData_IGESEntity)& obj,
0074                                           Handle(IGESData_SpecificModule)&   module,
0075                                           Standard_Integer&                  CN) const;
0076
0077   //! Starts Iteration on the Modules (sets it on the first one)
0078   Standard_EXPORT void Start();
0079
0080   //! Returns True if there are more Modules to iterate on
0081   Standard_EXPORT Standard_Boolean More() const;
0082
0083   //! Iterates by getting the next Module in the list
0084   //! If there is none, the exception will be raised by Value
0085   Standard_EXPORT void Next();
0086
0087   //! Returns the current Module in the Iteration
0088   Standard_EXPORT const Handle(IGESData_SpecificModule)& Module() const;
0089
0090   //! Returns the current Protocol in the Iteration
0091   Standard_EXPORT const Handle(IGESData_Protocol)& Protocol() const;
0092
0093 protected:
0094 private:
0095   Handle(IGESData_NodeOfSpecificLib) thelist;
0096   Handle(IGESData_NodeOfSpecificLib) thecurr;
0097 };
0098
0099 #endif // _IGESData_SpecificLib_HeaderFile