// 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 #ifndef _Standard_HeaderFile #include #endif #ifndef _Standard_DefineHandle_HeaderFile #include #endif #ifndef _Handle_Interface_GTool_HeaderFile #include #endif #ifndef _Handle_Interface_Protocol_HeaderFile #include #endif #ifndef _Handle_Interface_SignType_HeaderFile #include #endif #ifndef _Interface_GeneralLib_HeaderFile #include #endif #ifndef _Interface_DataMapOfTransientInteger_HeaderFile #include #endif #ifndef _TColStd_IndexedDataMapOfTransientTransient_HeaderFile #include #endif #ifndef _MMgt_TShared_HeaderFile #include #endif #ifndef _Standard_Integer_HeaderFile #include #endif #ifndef _Standard_CString_HeaderFile #include #endif #ifndef _Handle_Standard_Transient_HeaderFile #include #endif #ifndef _Handle_Interface_InterfaceModel_HeaderFile #include #endif #ifndef _Standard_Boolean_HeaderFile #include #endif #ifndef _Handle_Interface_GeneralModule_HeaderFile #include #endif 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
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 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
//! False : minimum count
//! 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
//! 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; }; // other Inline functions and methods (like "C++: function call" methods) #endif