Open CASCADE Technology  6.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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
More...

#include <Interface_GTool.hxx>

Inheritance diagram for Interface_GTool:
Inheritance graph
[legend]

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_GeneralLibLib ()
 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 MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void ShallowDump (Standard_OStream &) const
 
virtual const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const 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 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...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. 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::Interface_GTool ( )

Creates an empty, not set, GTool

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

void Interface_GTool::ClearEntities ( )

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

Interface_GeneralLib& Interface_GTool::Lib ( )

Returns the GeneralLib itself

Handle_Interface_Protocol Interface_GTool::Protocol ( ) const

Returns the Protocol. Warning : it can be Null

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

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

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

void Interface_GTool::SetSignType ( const Handle< Interface_SignType > &  sign)

Sets a new SignType

Standard_CString Interface_GTool::SignName ( ) const

Returns the Name of the SignType, or "Class Name"

Handle_Interface_SignType Interface_GTool::SignType ( ) const

Returns the SignType. Can be null

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: