This driver class provide services around function
execution. One instance of this class is built for
the whole session. The driver is bound to the
DriverGUID in the DriverTable class.
It allows you to create classes which inherit from
this abstract class.
These subclasses identify the various algorithms
which can be applied to the data contained in the
attributes of sub-labels of a model.
A single instance of this class and each of its
subclasses is built for the whole session.
More...

#include <TFunction_Driver.hxx>

Inheritance diagram for TFunction_Driver:

[legend]

Public Member Functions
void	Init (const TDF_Label &L)
	Initializes the label L for this function prior to its execution. More...

TDF_Label	Label () const
	Returns the label of the driver for this function. More...

virtual void	Validate (TFunction_Logbook &log) const
	Validates labels of a function in <log>. <br> This function is the one initialized in this function driver. Warning In regeneration mode, the solver must call this method even if the function is not executed. //! execution of function ===================== More...

virtual Standard_Boolean	MustExecute (const TFunction_Logbook &log) const
	Analyzes the labels in the logbook log. <br> Returns true if attributes have been modified. If the function label itself has been modified, the function must be executed. More...

virtual Standard_Integer	Execute (TFunction_Logbook &log) const =0
	Executes the function in this function driver and <br> puts the impacted labels in the logbook log. //! arguments & results of functions ================================ More...

virtual void	Arguments (TDF_LabelList &args) const
	The method fills-in the list by labels, where the arguments of the function are located. More...

virtual void	Results (TDF_LabelList &res) const
	The method fills-in the list by labels, where the results of the function are located. 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_Transient &	operator= (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...

Protected Member Functions
	TFunction_Driver ()
	initialisation of the driver ============================ More...

Detailed Description

This driver class provide services around function
execution. One instance of this class is built for
the whole session. The driver is bound to the
DriverGUID in the DriverTable class.
It allows you to create classes which inherit from
this abstract class.
These subclasses identify the various algorithms
which can be applied to the data contained in the
attributes of sub-labels of a model.
A single instance of this class and each of its
subclasses is built for the whole session.

Constructor & Destructor Documentation

TFunction_Driver::TFunction_Driver ( )

protected

initialisation of the driver
============================

Member Function Documentation

virtual void TFunction_Driver::Arguments ( TDF_LabelList & args ) const

virtual

The method fills-in the list by labels,
where the arguments of the function are located.

virtual Standard_Integer TFunction_Driver::Execute ( TFunction_Logbook & log ) const

pure virtual

 Executes the function in this function driver and <br>

puts the impacted labels in the logbook log.
//! arguments & results of functions
================================

Implemented in DNaming_BooleanOperationDriver, DNaming_TransformationDriver, DNaming_FilletDriver, DNaming_Line3DDriver, DNaming_PrismDriver, DNaming_RevolutionDriver, DNaming_BoxDriver, DNaming_CylinderDriver, DNaming_SphereDriver, DNaming_PointDriver, and DNaming_SelectionDriver.

void TFunction_Driver::Init ( const TDF_Label & L )

Initializes the label L for this function prior to its execution.

TDF_Label TFunction_Driver::Label ( ) const

Returns the label of the driver for this function.

virtual Standard_Boolean TFunction_Driver::MustExecute ( const TFunction_Logbook & log ) const

virtual

 Analyzes the labels in the logbook log. <br>

Returns true if attributes have been modified.
If the function label itself has been modified, the function must be executed.

Reimplemented in DNaming_BooleanOperationDriver, DNaming_TransformationDriver, DNaming_FilletDriver, DNaming_Line3DDriver, DNaming_PrismDriver, DNaming_RevolutionDriver, DNaming_BoxDriver, DNaming_CylinderDriver, DNaming_SphereDriver, DNaming_PointDriver, and DNaming_SelectionDriver.

virtual void TFunction_Driver::Results ( TDF_LabelList & res ) const

virtual

The method fills-in the list by labels,
where the results of the function are located.

virtual void TFunction_Driver::Validate ( TFunction_Logbook & log ) const

virtual

 Validates labels of a function  in <log>. <br>

This function is the one initialized in this function driver.
Warning
In regeneration mode, the solver must call this
method even if the function is not executed.
//! execution of function
=====================

Reimplemented in DNaming_BooleanOperationDriver, DNaming_TransformationDriver, DNaming_FilletDriver, DNaming_Line3DDriver, DNaming_PrismDriver, DNaming_RevolutionDriver, DNaming_BoxDriver, DNaming_CylinderDriver, DNaming_SphereDriver, DNaming_PointDriver, and DNaming_SelectionDriver.

The documentation for this class was generated from the following file:

TFunction_Driver.hxx

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation