TFunction_Iterator Class Reference

Iterator of the graph of functions. More...

#include <TFunction_Iterator.hxx>

Public Member Functions
	TFunction_Iterator ()
	An empty constructor.
	TFunction_Iterator (const TDF_Label &Access)
	A constructor. Initializes the iterator.
virtual void	Init (const TDF_Label &Access)
	Initializes the Iterator.
void	SetUsageOfExecutionStatus (const Standard_Boolean usage)
	Defines the mode of iteration - usage or not of the execution status. If the iterator takes into account the execution status, the method ::Current() returns only "not executed" functions while their status is not changed. If the iterator ignores the execution status, the method ::Current() returns the functions following their dependencies and ignoring the execution status.
Standard_Boolean	GetUsageOfExecutionStatus () const
	Returns usage of execution status by the iterator.
virtual Standard_Integer	GetMaxNbThreads () const
	Analyses the graph of dependencies and returns maximum number of threads may be used to calculate the model.
virtual const TDF_LabelList &	Current () const
	Returns the current list of functions. If the iterator uses the execution status, the returned list contains only the functions with "not executed" status.
virtual Standard_Boolean	More () const
	Returns false if the graph of functions is fully iterated.
virtual void	Next ()
	Switches the iterator to the next list of current functions.
TFunction_ExecutionStatus	GetStatus (const TDF_Label &func) const
	A help-function aimed to help the user to check the status of retrurned function. It calls TFunction_GraphNode::GetStatus() inside.
void	SetStatus (const TDF_Label &func, const TFunction_ExecutionStatus status) const
	A help-function aimed to help the user to change the execution status of a function. It calls TFunction_GraphNode::SetStatus() inside.
Standard_OStream &	Dump (Standard_OStream &OS) const

Detailed Description

Iterator of the graph of functions.

Constructor & Destructor Documentation

TFunction_Iterator() [1/2]

TFunction_Iterator::TFunction_Iterator

(

)

An empty constructor.

TFunction_Iterator() [2/2]

TFunction_Iterator::TFunction_Iterator

(

const TDF_Label &

Access

)

A constructor. Initializes the iterator.

Member Function Documentation

Current()

virtual const TDF_LabelList & TFunction_Iterator::Current ( ) const

virtual

Returns the current list of functions. If the iterator uses the execution status, the returned list contains only the functions with "not executed" status.

Dump()

Standard_OStream & TFunction_Iterator::Dump

(

Standard_OStream &

OS

)

const

GetMaxNbThreads()

virtual Standard_Integer TFunction_Iterator::GetMaxNbThreads ( ) const

virtual

Analyses the graph of dependencies and returns maximum number of threads may be used to calculate the model.

GetStatus()

TFunction_ExecutionStatus TFunction_Iterator::GetStatus

(

const TDF_Label &

func

)

const

A help-function aimed to help the user to check the status of retrurned function. It calls TFunction_GraphNode::GetStatus() inside.

GetUsageOfExecutionStatus()

Standard_Boolean TFunction_Iterator::GetUsageOfExecutionStatus

(

)

const

Returns usage of execution status by the iterator.

Init()

virtual void TFunction_Iterator::Init ( const TDF_Label & Access )

virtual

Initializes the Iterator.

More()

virtual Standard_Boolean TFunction_Iterator::More ( ) const

virtual

Returns false if the graph of functions is fully iterated.

Next()

virtual void TFunction_Iterator::Next ( )

virtual

Switches the iterator to the next list of current functions.

SetStatus()

void TFunction_Iterator::SetStatus	(	const TDF_Label &	func,
		const TFunction_ExecutionStatus	status ) const

A help-function aimed to help the user to change the execution status of a function. It calls TFunction_GraphNode::SetStatus() inside.

SetUsageOfExecutionStatus()

void TFunction_Iterator::SetUsageOfExecutionStatus

(

const Standard_Boolean

usage

)

Defines the mode of iteration - usage or not of the execution status. If the iterator takes into account the execution status, the method ::Current() returns only "not executed" functions while their status is not changed. If the iterator ignores the execution status, the method ::Current() returns the functions following their dependencies and ignoring the execution status.

---

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

• TFunction_Iterator.hxx