TFunction_Logbook Class Reference

This class contains information which is written and read during the solving process. Information is divided in three groups. More...

#include <TFunction_Logbook.hxx>

Public Member Functions
	TFunction_Logbook ()
	<>next methods are solving declaration More...
void	Clear ()
	Clears this logbook to its default, empty state. More...
Standard_Boolean	IsEmpty () const
void	SetTouched (const TDF_Label &L)
	Sets the label L as a touched label in this logbook. In other words, L is understood to have been modified by the end user. More...
void	SetImpacted (const TDF_Label &L, const Standard_Boolean WithChildren=Standard_False)
	Sets the label L as an impacted label in this logbook. This method is called by execution of the function driver. More...
void	SetValid (const TDF_Label &L, const Standard_Boolean WithChildren=Standard_False)
	Sets the label L as a valid label in this logbook. More...
TDF_LabelMap &	ChangeValid ()
Standard_Boolean	IsModified (const TDF_Label &L, const Standard_Boolean WithChildren=Standard_False) const
	Returns True if the label L is touched or impacted. This method is called by <TFunction_FunctionDriver::MustExecute>. If <WithChildren> is set to true, the method checks all the sublabels of <L> too. <>next method to consult solving result More...
const TDF_LabelMap &	GetTouched () const
	Returns the map of touched labels in this logbook. A touched label is the one modified by the end user. More...
const TDF_LabelMap &	GetImpacted () const
	Returns the map of impacted labels contained in this logbook. More...
const TDF_LabelMap &	GetValid () const
	Returns the map of valid labels in this logbook. More...
void	Done (const Standard_Boolean status)
	Sets if the execution failed. More...
Standard_Boolean	IsDone () const
Standard_OStream &	Dump (Standard_OStream &stream) const

Detailed Description

This class contains information which is written and read during the solving process. Information is divided in three groups.

• Touched Labels (modified by the end user),
• Impacted Labels (modified during execution of the function),
• Valid Labels (within the valid label scope).

Constructor & Destructor Documentation

TFunction_Logbook::TFunction_Logbook

(

)

<>next methods are solving declaration

Member Function Documentation

TDF_LabelMap& TFunction_Logbook::ChangeValid

(

)

void TFunction_Logbook::Clear

(

)

Clears this logbook to its default, empty state.

void TFunction_Logbook::Done

(

const Standard_Boolean

status

)

Sets if the execution failed.

Standard_OStream& TFunction_Logbook::Dump

(

Standard_OStream &

stream

)

const

const TDF_LabelMap& TFunction_Logbook::GetImpacted

(

)

const

Returns the map of impacted labels contained in this logbook.

const TDF_LabelMap& TFunction_Logbook::GetTouched

(

)

const

Returns the map of touched labels in this logbook. A touched label is the one modified by the end user.

const TDF_LabelMap& TFunction_Logbook::GetValid

(

)

const

Returns the map of valid labels in this logbook.

Standard_Boolean TFunction_Logbook::IsDone

(

)

const

Standard_Boolean TFunction_Logbook::IsEmpty

(

)

const

Standard_Boolean TFunction_Logbook::IsModified	(	const TDF_Label &	L,
		const Standard_Boolean	WithChildren = Standard_False
	)		const

Returns True if the label L is touched or impacted. This method is called by <TFunction_FunctionDriver::MustExecute>. If <WithChildren> is set to true, the method checks all the sublabels of <L> too.

<>next method to consult solving result

void TFunction_Logbook::SetImpacted	(	const TDF_Label &	L,
		const Standard_Boolean	WithChildren = Standard_False
	)

Sets the label L as an impacted label in this logbook. This method is called by execution of the function driver.

void TFunction_Logbook::SetTouched

(

const TDF_Label &

L

)

Sets the label L as a touched label in this logbook. In other words, L is understood to have been modified by the end user.

void TFunction_Logbook::SetValid	(	const TDF_Label &	L,
		const Standard_Boolean	WithChildren = Standard_False
	)

Sets the label L as a valid label in this logbook.

---

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

• TFunction_Logbook.hxx