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:

[legend]

Public Member Functions
	Interface_GTool ()
	Creates an empty, not set, GTool.

	Interface_GTool (const occ::handle< Interface_Protocol > &proto, const int nbent=0)
	Creates a GTool from a Protocol Optional starting count of entities.

void	SetSignType (const occ::handle< Interface_SignType > &sign)
	Sets a new SignType.

occ::handle< Interface_SignType >	SignType () const
	Returns the SignType. Can be null.

const char *	SignValue (const occ::handle< Standard_Transient > &ent, const occ::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>

const char *	SignName () const
	Returns the Name of the SignType, or "Class Name".

void	SetProtocol (const occ::handle< Interface_Protocol > &proto, const bool enforce=false)
	Sets a new Protocol if <enforce> is False and the new Protocol equates the old one then nothing is done.

occ::handle< Interface_Protocol >	Protocol () const
	Returns the Protocol. Warning: it can be Null.

Interface_GeneralLib &	Lib ()
	Returns the GeneralLib itself.

void	Reservate (const int nb, const bool enforce=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.

bool	Select (const occ::handle< Standard_Transient > &ent, occ::handle< Interface_GeneralModule > &gmod, int &CN, const bool enforce=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.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	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.

bool	IsKind (const char *const 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.

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.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

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 occ::handle< Interface_Protocol > &	proto,
		const int	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()

occ::handle< Interface_Protocol > Interface_GTool::Protocol ( ) const

Returns the Protocol. Warning: it can be Null.

◆ Reservate()

void Interface_GTool::Reservate	(	const int	nb,
		const bool	enforce = false )

Reservates maps for a count of entities <enforce> False : minimum count <enforce> True : clears former reservations Does not clear the maps.

◆ Select()

bool Interface_GTool::Select	(	const occ::handle< Standard_Transient > &	ent,
		occ::handle< Interface_GeneralModule > &	gmod,
		int &	CN,
		const bool	enforce = 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 occ::handle< Interface_Protocol > &	proto,
		const bool	enforce = 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 occ::handle< Interface_SignType > & sign )

Sets a new SignType.

◆ SignName()

const char * Interface_GTool::SignName ( ) const

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

◆ SignType()

occ::handle< Interface_SignType > Interface_GTool::SignType ( ) const

Returns the SignType. Can be null.

◆ SignValue()

const char * Interface_GTool::SignValue	(	const occ::handle< Standard_Transient > &	ent,
		const occ::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:

Interface_GTool.hxx

Public Member Functions

Additional Inherited Members