Open CASCADE Technology 6.6.0
Public Member Functions
Interface_GTool Class Reference

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

#include <Interface_GTool.hxx>

Inheritance diagram for Interface_GTool:
Inheritance graph
[legend]

Public Member Functions

 Interface_GTool ()
 Creates an empty, not set, GTool

 Interface_GTool (const Handle< Interface_Protocol > &proto, const Standard_Integer nbent=0)
 Creates a GTool from a Protocol
Optional starting count of entities

void SetSignType (const Handle< Interface_SignType > &sign)
 Sets a new SignType

Handle_Interface_SignType SignType () const
 Returns the SignType. Can be null

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>

Standard_CString SignName () const
 Returns the Name of the SignType, or "Class Name"

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

Handle_Interface_Protocol Protocol () const
 Returns the Protocol. Warning : it can be Null

Interface_GeneralLibLib ()
 Returns the GeneralLib itself

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

void ClearEntities ()
 Clears the maps which record, for each already recorded entity
its Module and Case Number

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


Constructor & Destructor Documentation

Interface_GTool::Interface_GTool ( )
Interface_GTool::Interface_GTool ( const Handle< Interface_Protocol > &  proto,
const Standard_Integer  nbent = 0 
)

Member Function Documentation

void Interface_GTool::ClearEntities ( )
Interface_GeneralLib& Interface_GTool::Lib ( )
Handle_Interface_Protocol Interface_GTool::Protocol ( ) const
void Interface_GTool::Reservate ( const Standard_Integer  nb,
const Standard_Boolean  enforce = Standard_False 
)
Standard_Boolean Interface_GTool::Select ( const Handle< Standard_Transient > &  ent,
Handle< Interface_GeneralModule > &  gmod,
Standard_Integer CN,
const Standard_Boolean  enforce = Standard_False 
)
void Interface_GTool::SetProtocol ( const Handle< Interface_Protocol > &  proto,
const Standard_Boolean  enforce = Standard_False 
)
void Interface_GTool::SetSignType ( const Handle< Interface_SignType > &  sign)
Standard_CString Interface_GTool::SignName ( ) const
Handle_Interface_SignType Interface_GTool::SignType ( ) const
Standard_CString Interface_GTool::SignValue ( const Handle< Standard_Transient > &  ent,
const Handle< Interface_InterfaceModel > &  model 
) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines