TFunction_IFunction Class Reference

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.
void	Init (const TDF_Label &L)
	Initializes the interface by the label of function.
const TDF_Label &	Label () const
	Returns a label of the function.
bool	UpdateDependencies () const
	Updates the dependencies of this function only.
void	Arguments (NCollection_List< TDF_Label > &args) const
	The method fills-in the list by labels, where the arguments of the function are located.
void	Results (NCollection_List< TDF_Label > &res) const
	The method fills-in the list by labels, where the results of the function are located.
void	GetPrevious (NCollection_List< TDF_Label > &prev) const
	Returns a list of previous functions.
void	GetNext (NCollection_List< TDF_Label > &prev) const
	Returns a list of next functions.
TFunction_ExecutionStatus	GetStatus () const
	Returns the execution status of the function.
void	SetStatus (const TFunction_ExecutionStatus status) const
	Defines an execution status for a function.
const NCollection_DoubleMap< int, TDF_Label > &	GetAllFunctions () const
	Returns the scope of all functions.
occ::handle< TFunction_Logbook >	GetLogbook () const
	Returns the Logbook - keeper of modifications.
occ::handle< TFunction_Driver >	GetDriver (const int thread=0) const
	Returns a driver of the function.
occ::handle< TFunction_GraphNode >	GetGraphNode () const
	Returns a graph node of the function.

Static Public Member Functions
static bool	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.
static bool	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.
static bool	UpdateDependencies (const TDF_Label &Access)
	Updates dependencies for all functions of the scope. It returns false in case of an error. An empty constructor.

Detailed Description

Interface class for usage of Function Mechanism.

Constructor & Destructor Documentation

TFunction_IFunction() [1/2]

TFunction_IFunction::TFunction_IFunction

(

)

TFunction_IFunction() [2/2]

TFunction_IFunction::TFunction_IFunction

(

const TDF_Label &

L

)

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

Member Function Documentation

Arguments()

void TFunction_IFunction::Arguments

(

NCollection_List< TDF_Label > &

args

)

const

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

DeleteFunction()

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

GetAllFunctions()

const NCollection_DoubleMap< int, TDF_Label > & TFunction_IFunction::GetAllFunctions

(

)

const

Returns the scope of all functions.

GetDriver()

occ::handle< TFunction_Driver > TFunction_IFunction::GetDriver

(

const int

thread = 0

)

const

Returns a driver of the function.

GetGraphNode()

occ::handle< TFunction_GraphNode > TFunction_IFunction::GetGraphNode

(

)

const

Returns a graph node of the function.

GetLogbook()

occ::handle< TFunction_Logbook > TFunction_IFunction::GetLogbook

(

)

const

Returns the Logbook - keeper of modifications.

GetNext()

void TFunction_IFunction::GetNext

(

NCollection_List< TDF_Label > &

prev

)

const

Returns a list of next functions.

GetPrevious()

void TFunction_IFunction::GetPrevious

(

NCollection_List< TDF_Label > &

prev

)

const

Returns a list of previous functions.

GetStatus()

TFunction_ExecutionStatus TFunction_IFunction::GetStatus

(

)

const

Returns the execution status of the function.

Init()

void TFunction_IFunction::Init

(

const TDF_Label &

L

)

Initializes the interface by the label of function.

Label()

const TDF_Label & TFunction_IFunction::Label

(

)

const

Returns a label of the function.

NewFunction()

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

Results()

void TFunction_IFunction::Results

(

NCollection_List< TDF_Label > &

res

)

const

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

SetStatus()

void TFunction_IFunction::SetStatus

(

const TFunction_ExecutionStatus

status

)

const

Defines an execution status for a function.

UpdateDependencies() [1/2]

bool TFunction_IFunction::UpdateDependencies

(

)

const

Updates the dependencies of this function only.

UpdateDependencies() [2/2]

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

---

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

• TFunction_IFunction.hxx