Interface class for usage of Function Mechanism
More...

#include <TFunction_IFunction.hxx>

Public Member Functions
	TFunction_IFunction ()

	TFunction_IFunction (const TDF_Label &L)
	A constructor. Initializes the interface by the label of function. More...

void	Init (const TDF_Label &L)
	Initializes the interface by the label of function. More...

const TDF_Label &	Label () const
	Returns a label of the function. More...

Standard_Boolean	UpdateDependencies () const
	Updates the dependencies of this function only. More...

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

void	Results (TDF_LabelList &res) const
	The method fills-in the list by labels, where the results of the function are located. More...

void	GetPrevious (TDF_LabelList &prev) const
	Returns a list of previous functions. More...

void	GetNext (TDF_LabelList &prev) const
	Returns a list of next functions. More...

TFunction_ExecutionStatus	GetStatus () const
	Returns the execution status of the function. More...

void	SetStatus (const TFunction_ExecutionStatus status) const
	Defines an execution status for a function. More...

const TFunction_DoubleMapOfIntegerLabel &	GetAllFunctions () const
	Returns the scope of all functions. More...

TFunction_Logbook &	GetLogbook () const
	Returns the Logbook - keeper of modifications. More...

Handle_TFunction_Driver	GetDriver (const Standard_Integer thread=0) const
	Returns a driver of the function. More...

Handle_TFunction_GraphNode	GetGraphNode () const
	Returns a graph node of the function. More...

Static Public Member Functions
static Standard_Boolean	NewFunction (const TDF_Label &L, const Standard_GUID &ID)
	Sets a new function attached to a label <L> with <ID>. It creates a new TFunction_Function attribute initialized by the <ID>, a new TFunction_GraphNode with an empty list of dependencies and the status equal to TFunction_ES_WrongDefinition. It registers the function in the scope of functions for this document. More...

static Standard_Boolean	DeleteFunction (const TDF_Label &L)
	Deletes a function attached to a label <L>. It deletes a TFunction_Function attribute and a TFunction_GraphNode. It deletes the functions from the scope of function of this document. More...

static Standard_Boolean	UpdateDependencies (const TDF_Label &Access)
	Updates dependencies for all functions of the scope. It returns false in case of an error. //! An empty constructor. More...

Detailed Description

Interface class for usage of Function Mechanism

Constructor & Destructor Documentation

TFunction_IFunction::TFunction_IFunction ( )

TFunction_IFunction::TFunction_IFunction ( const TDF_Label & L )

A constructor.
Initializes the interface by the label of function.

Member Function Documentation

void TFunction_IFunction::Arguments ( TDF_LabelList & args ) const

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

static Standard_Boolean TFunction_IFunction::DeleteFunction ( const TDF_Label & L )

static

Deletes a function attached to a label <L>.
It deletes a TFunction_Function attribute and a TFunction_GraphNode.
It deletes the functions from the scope of function of this document.

const TFunction_DoubleMapOfIntegerLabel& TFunction_IFunction::GetAllFunctions ( ) const

Returns the scope of all functions.

Handle_TFunction_Driver TFunction_IFunction::GetDriver ( const Standard_Integer thread = 0 ) const

Returns a driver of the function.

Handle_TFunction_GraphNode TFunction_IFunction::GetGraphNode ( ) const

Returns a graph node of the function.

TFunction_Logbook& TFunction_IFunction::GetLogbook ( ) const

Returns the Logbook - keeper of modifications.

void TFunction_IFunction::GetNext ( TDF_LabelList & prev ) const

Returns a list of next functions.

void TFunction_IFunction::GetPrevious ( TDF_LabelList & prev ) const

Returns a list of previous functions.

TFunction_ExecutionStatus TFunction_IFunction::GetStatus ( ) const

Returns the execution status of the function.

void TFunction_IFunction::Init ( const TDF_Label & L )

Initializes the interface by the label of function.

const TDF_Label& TFunction_IFunction::Label ( ) const

Returns a label of the function.

static Standard_Boolean TFunction_IFunction::NewFunction	(	const TDF_Label &	L,
		const Standard_GUID &	ID
	)

static

Sets a new function attached to a label <L> with <ID>.
It creates a new TFunction_Function attribute initialized by the <ID>,
a new TFunction_GraphNode with an empty list of dependencies and
the status equal to TFunction_ES_WrongDefinition.
It registers the function in the scope of functions for this document.

void TFunction_IFunction::Results ( TDF_LabelList & res ) const

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

void TFunction_IFunction::SetStatus ( const TFunction_ExecutionStatus status ) const

Defines an execution status for a function.

static Standard_Boolean TFunction_IFunction::UpdateDependencies ( const TDF_Label & Access )

static

Updates dependencies for all functions of the scope.
It returns false in case of an error.
//! An empty constructor.

Standard_Boolean TFunction_IFunction::UpdateDependencies ( ) const

Updates the dependencies of this function only.

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

TFunction_IFunction.hxx

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation