1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
|
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to
// this header file considered to be the "object code" form of the original source.
#ifndef _Interface_GTool_HeaderFile
#define _Interface_GTool_HeaderFile
#include <Standard.hxx>
#include <Standard_DefineHandle.hxx>
#include <Handle_Interface_GTool.hxx>
#include <Handle_Interface_Protocol.hxx>
#include <Handle_Interface_SignType.hxx>
#include <Interface_GeneralLib.hxx>
#include <Interface_DataMapOfTransientInteger.hxx>
#include <TColStd_IndexedDataMapOfTransientTransient.hxx>
#include <MMgt_TShared.hxx>
#include <Standard_Integer.hxx>
#include <Standard_CString.hxx>
#include <Handle_Standard_Transient.hxx>
#include <Handle_Interface_InterfaceModel.hxx>
#include <Standard_Boolean.hxx>
#include <Handle_Interface_GeneralModule.hxx>
class Interface_Protocol;
class Interface_SignType;
class Standard_Transient;
class Interface_InterfaceModel;
class Interface_GeneralLib;
class Interface_GeneralModule;
//! GTool - General Tool for a Model
//! Provides the functions performed by Protocol/GeneralModule for
//! entities of a Model, and recorded in a GeneralLib
//! Optimized : once an entity has been queried, the GeneralLib is
//! not longer queried
//! Shareable between several users : as a Handle
class Interface_GTool : public MMgt_TShared
{
public:
//! Creates an empty, not set, GTool
Standard_EXPORT Interface_GTool();
//! Creates a GTool from a Protocol
//! Optional starting count of entities
Standard_EXPORT Interface_GTool(const Handle(Interface_Protocol)& proto, const Standard_Integer nbent = 0);
//! Sets a new SignType
Standard_EXPORT void SetSignType (const Handle(Interface_SignType)& sign) ;
//! Returns the SignType. Can be null
Standard_EXPORT Handle(Interface_SignType) SignType() const;
//! Returns the Signature for a Transient Object in a Model
//! It calls SignType to do that
//! If SignType is not defined, return ClassName of <ent>
Standard_EXPORT Standard_CString SignValue (const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model) const;
//! Returns the Name of the SignType, or "Class Name"
Standard_EXPORT Standard_CString SignName() const;
//! Sets a new Protocol
//! if <enforce> is False and the new Protocol equates the old one
//! then nothing is done
Standard_EXPORT void SetProtocol (const Handle(Interface_Protocol)& proto, const Standard_Boolean enforce = Standard_False) ;
//! Returns the Protocol. Warning : it can be Null
Standard_EXPORT Handle(Interface_Protocol) Protocol() const;
//! Returns the GeneralLib itself
Standard_EXPORT Interface_GeneralLib& Lib() ;
//! Reservates maps for a count of entities
//! <enforce> False : minimum count
//! <enforce> True : clears former reservations
//! Does not clear the maps
Standard_EXPORT void Reservate (const Standard_Integer nb, const Standard_Boolean enforce = Standard_False) ;
//! Clears the maps which record, for each already recorded entity
//! its Module and Case Number
Standard_EXPORT void ClearEntities() ;
//! Selects for an entity, its Module and Case Number
//! It is optimised : once done for each entity, the result is
//! mapped and the GeneralLib is not longer queried
//! <enforce> True overpasses this optimisation
Standard_EXPORT Standard_Boolean Select (const Handle(Standard_Transient)& ent, Handle(Interface_GeneralModule)& gmod, Standard_Integer& CN, const Standard_Boolean enforce = Standard_False) ;
DEFINE_STANDARD_RTTI(Interface_GTool)
protected:
private:
Handle(Interface_Protocol) theproto;
Handle(Interface_SignType) thesign;
Interface_GeneralLib thelib;
Interface_DataMapOfTransientInteger thentnum;
TColStd_IndexedDataMapOfTransientTransient thentmod;
};
#endif // _Interface_GTool_HeaderFile
|