include/opencascade/TPrsStd_DriverTable.hxx

0001 // Created on: 1999-08-04
0002 // Created by: Denis PASCAL
0003 // Copyright (c) 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 _TPrsStd_DriverTable_HeaderFile
0018 #define _TPrsStd_DriverTable_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <TPrsStd_DataMapOfGUIDDriver.hxx>
0024 #include <Standard_Transient.hxx>
0025 class Standard_GUID;
0026 class TPrsStd_Driver;
0027
0028
0029 class TPrsStd_DriverTable;
0030 DEFINE_STANDARD_HANDLE(TPrsStd_DriverTable, Standard_Transient)
0031
0032 //! This class is   a  container to record  (AddDriver)
0033 //! binding between  GUID and  TPrsStd_Driver.
0034 //! You create a new instance of TPrsStd_Driver
0035 //! and use the method AddDriver to load it into the driver table. the method
0036 class TPrsStd_DriverTable : public Standard_Transient
0037 {
0038
0039 public:
0040
0041
0042   //! Returns the static table.
0043   //! If it does not exist, creates it and fills it with standard drivers.
0044   Standard_EXPORT static Handle(TPrsStd_DriverTable) Get();
0045
0046   //! Default constructor
0047   Standard_EXPORT TPrsStd_DriverTable();
0048
0049   //! Fills the table with standard drivers
0050   Standard_EXPORT void InitStandardDrivers();
0051
0052   //! Returns true if the driver has been added successfully to the driver table.
0053   Standard_EXPORT Standard_Boolean AddDriver (const Standard_GUID& guid, const Handle(TPrsStd_Driver)& driver);
0054
0055   //! Returns true if the driver was found.
0056   Standard_EXPORT Standard_Boolean FindDriver (const Standard_GUID& guid, Handle(TPrsStd_Driver)& driver) const;
0057
0058
0059   //! Removes a driver with the given GUID.
0060   //! Returns true if the driver has been removed successfully.
0061   Standard_EXPORT Standard_Boolean RemoveDriver (const Standard_GUID& guid);
0062
0063   //! Removes all drivers. Returns
0064   //! true if the driver has been removed successfully.
0065   //! If this method is used, the InitStandardDrivers method should be
0066   //! called to fill the table with standard drivers.
0067   Standard_EXPORT void Clear();
0068
0069
0070
0071
0072   DEFINE_STANDARD_RTTIEXT(TPrsStd_DriverTable,Standard_Transient)
0073
0074 protected:
0075
0076
0077
0078
0079 private:
0080
0081
0082   TPrsStd_DataMapOfGUIDDriver myDrivers;
0083
0084
0085 };
0086
0087
0088
0089
0090
0091
0092
0093 #endif // _TPrsStd_DriverTable_HeaderFile