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. More...
#include <Interface_GTool.hxx>
Public Member Functions | |
| Interface_GTool () | |
| Creates an empty, not set, GTool. More... | |
| Interface_GTool (const Handle< Interface_Protocol > &proto, const Standard_Integer nbent=0) | |
| Creates a GTool from a Protocol Optional starting count of entities. More... | |
| void | SetSignType (const Handle< Interface_SignType > &sign) |
| Sets a new SignType. More... | |
| Handle< Interface_SignType > | SignType () const |
| Returns the SignType. Can be null. More... | |
| Standard_CString | SignValue (const Handle< Standard_Transient > &ent, const Handle< Interface_InterfaceModel > &model) 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> More... | |
| Standard_CString | SignName () const |
| Returns the Name of the SignType, or "Class Name". More... | |
| void | SetProtocol (const Handle< Interface_Protocol > &proto, const Standard_Boolean enforce=Standard_False) |
| Sets a new Protocol if <enforce> is False and the new Protocol equates the old one then nothing is done. More... | |
| Handle< Interface_Protocol > | Protocol () const |
| Returns the Protocol. Warning : it can be Null. More... | |
| Interface_GeneralLib & | Lib () |
| Returns the GeneralLib itself. More... | |
| void | Reservate (const Standard_Integer nb, const Standard_Boolean enforce=Standard_False) |
| Reservates maps for a count of entities <enforce> False : minimum count <enforce> True : clears former reservations Does not clear the maps. More... | |
| void | ClearEntities () |
| Clears the maps which record, for each already recorded entity its Module and Case Number. More... | |
| Standard_Boolean | Select (const Handle< Standard_Transient > &ent, Handle< Interface_GeneralModule > &gmod, Standard_Integer &CN, const Standard_Boolean enforce=Standard_False) |
| 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. More... | |
 Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
Detailed Description
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.
Constructor & Destructor Documentation
◆ Interface_GTool() [1/2]
| Interface_GTool::Interface_GTool | ( | ) |
Creates an empty, not set, GTool.
◆ Interface_GTool() [2/2]
| Interface_GTool::Interface_GTool | ( | const Handle< Interface_Protocol > & | proto, |
| const Standard_Integer | nbent = 0 |
||
| ) |
Creates a GTool from a Protocol Optional starting count of entities.
Member Function Documentation
◆ ClearEntities()
| void Interface_GTool::ClearEntities | ( | ) |
Clears the maps which record, for each already recorded entity its Module and Case Number.
◆ Lib()
| Interface_GeneralLib& Interface_GTool::Lib | ( | ) |
Returns the GeneralLib itself.
◆ Protocol()
| Handle< Interface_Protocol > Interface_GTool::Protocol | ( | ) | const |
Returns the Protocol. Warning : it can be Null.
◆ Reservate()
| void Interface_GTool::Reservate | ( | const Standard_Integer | nb, |
| const Standard_Boolean | enforce = Standard_False |
||
| ) |
Reservates maps for a count of entities <enforce> False : minimum count <enforce> True : clears former reservations Does not clear the maps.
◆ Select()
| Standard_Boolean Interface_GTool::Select | ( | const Handle< Standard_Transient > & | ent, |
| Handle< Interface_GeneralModule > & | gmod, | ||
| Standard_Integer & | CN, | ||
| const Standard_Boolean | enforce = Standard_False |
||
| ) |
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.
◆ SetProtocol()
| void Interface_GTool::SetProtocol | ( | const Handle< Interface_Protocol > & | proto, |
| const Standard_Boolean | enforce = Standard_False |
||
| ) |
Sets a new Protocol if <enforce> is False and the new Protocol equates the old one then nothing is done.
◆ SetSignType()
| void Interface_GTool::SetSignType | ( | const Handle< Interface_SignType > & | sign | ) |
Sets a new SignType.
◆ SignName()
| Standard_CString Interface_GTool::SignName | ( | ) | const |
Returns the Name of the SignType, or "Class Name".
◆ SignType()
| Handle< Interface_SignType > Interface_GTool::SignType | ( | ) | const |
Returns the SignType. Can be null.
◆ SignValue()
| Standard_CString Interface_GTool::SignValue | ( | const Handle< Standard_Transient > & | ent, |
| const Handle< Interface_InterfaceModel > & | model | ||
| ) | 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>
The documentation for this class was generated from the following file:
