Interface_CheckTool Class Reference

Performs Checks on Entities, using General Service Library and Modules to work. Works on one Entity or on a complete Model. More...

#include <Interface_CheckTool.hxx>

Public Member Functions
	Interface_CheckTool (const occ::handle< Interface_InterfaceModel > &model, const occ::handle< Interface_Protocol > &protocol)
	Creates a CheckTool, by calling the General Service Library and Modules, selected through a Protocol, to work on a Model Moreover, Protocol recognizes Unknown Entities.
	Interface_CheckTool (const occ::handle< Interface_InterfaceModel > &model)
	Creates a CheckTool, by calling the General Service Library and Modules, selected through a Protocol, to work on a Model Protocol and so on are taken from the Model (its GTool).
	Interface_CheckTool (const Interface_Graph &graph)
	Creates a CheckTool from a Graph. The Graph contains a Model which designates a Protocol: they are used to create ShareTool.
	Interface_CheckTool (const occ::handle< Interface_HGraph > &hgraph)
void	FillCheck (const occ::handle< Standard_Transient > &ent, const Interface_ShareTool &sh, occ::handle< Interface_Check > &ach)
	Fills as required a Check with the Error and Warning messages produced by Checking a given Entity. For an Erroneous or Corrected Entity : Check build at Analyse time; else, Check computed for Entity (Verify integrity), can use a Graph as required to control context.
void	Print (const occ::handle< Interface_Check > &ach, Standard_OStream &S) const
	Utility method which Prints the content of a Check.
void	Print (const Interface_CheckIterator &list, Standard_OStream &S) const
	Simply Lists all the Checks and the Content (messages) and the Entity, if there is, of each Check (if all Checks are OK, nothing is Printed).
occ::handle< Interface_Check >	Check (const int numnum)
	Returns the Check associated to an Entity identified by its Number in a Model.
void	CheckSuccess (const bool resetreset=false)
	Checks if any Error has been detected (CheckList not empty) Returns normally if none, raises exception if some exists. It reuses the last computations from other checking methods, unless the argument <reset> is given True.
Interface_CheckIterator	CompleteCheckList ()
	Returns list of all "remarkable" information, which include :
Interface_CheckIterator	CheckList ()
	Returns list of all Errors detected Note that presence of Unknown Entities is not an error Cumulates : GlobalCheck if error + AnalyseCheckList + VerifyCheckList.
Interface_CheckIterator	AnalyseCheckList ()
	Returns list of errors detected at Analyse time (syntactic) (note that GlobalCheck is not in this list).
Interface_CheckIterator	VerifyCheckList ()
	Returns list of integrity constraints errors (semantic) (note that GlobalCheck is not in this list).
Interface_CheckIterator	WarningCheckList ()
	Returns list of Corrections (includes GlobalCheck if corrected).
Interface_EntityIterator	UnknownEntities ()
	Returns list of Unknown Entities Note that Error and Erroneous Entities are not considered as Unknown.

Detailed Description

Performs Checks on Entities, using General Service Library and Modules to work. Works on one Entity or on a complete Model.

Constructor & Destructor Documentation

Interface_CheckTool() [1/4]

Interface_CheckTool::Interface_CheckTool	(	const occ::handle< Interface_InterfaceModel > &	model,
		const occ::handle< Interface_Protocol > &	protocol )

Creates a CheckTool, by calling the General Service Library and Modules, selected through a Protocol, to work on a Model Moreover, Protocol recognizes Unknown Entities.

Interface_CheckTool() [2/4]

Interface_CheckTool::Interface_CheckTool

(

const occ::handle< Interface_InterfaceModel > &

model

)

Creates a CheckTool, by calling the General Service Library and Modules, selected through a Protocol, to work on a Model Protocol and so on are taken from the Model (its GTool).

Interface_CheckTool() [3/4]

Interface_CheckTool::Interface_CheckTool

(

const Interface_Graph &

graph

)

Creates a CheckTool from a Graph. The Graph contains a Model which designates a Protocol: they are used to create ShareTool.

Interface_CheckTool() [4/4]

Interface_CheckTool::Interface_CheckTool

(

const occ::handle< Interface_HGraph > &

hgraph

)

Member Function Documentation

AnalyseCheckList()

Interface_CheckIterator Interface_CheckTool::AnalyseCheckList

(

)

Returns list of errors detected at Analyse time (syntactic) (note that GlobalCheck is not in this list).

Check()

occ::handle< Interface_Check > Interface_CheckTool::Check

(

const int

num

)

Returns the Check associated to an Entity identified by its Number in a Model.

CheckList()

Interface_CheckIterator Interface_CheckTool::CheckList

(

)

Returns list of all Errors detected Note that presence of Unknown Entities is not an error Cumulates : GlobalCheck if error + AnalyseCheckList + VerifyCheckList.

CheckSuccess()

void Interface_CheckTool::CheckSuccess

(

const bool

reset = false

)

Checks if any Error has been detected (CheckList not empty) Returns normally if none, raises exception if some exists. It reuses the last computations from other checking methods, unless the argument <reset> is given True.

CompleteCheckList()

Interface_CheckIterator Interface_CheckTool::CompleteCheckList

(

)

Returns list of all "remarkable" information, which include :

• GlobalCheck, if not empty
• Error Checks, for all Errors (Verify + Analyse)
• also Corrected Entities
• and Unknown Entities : for those, each Unknown Entity is associated to an empty Check (it is neither an Error nor a Correction, but a remarkable information)

FillCheck()

void Interface_CheckTool::FillCheck	(	const occ::handle< Standard_Transient > &	ent,
		const Interface_ShareTool &	sh,
		occ::handle< Interface_Check > &	ach )

Fills as required a Check with the Error and Warning messages produced by Checking a given Entity. For an Erroneous or Corrected Entity : Check build at Analyse time; else, Check computed for Entity (Verify integrity), can use a Graph as required to control context.

Print() [1/2]

void Interface_CheckTool::Print	(	const Interface_CheckIterator &	list,
		Standard_OStream &	S ) const

Simply Lists all the Checks and the Content (messages) and the Entity, if there is, of each Check (if all Checks are OK, nothing is Printed).

Print() [2/2]

void Interface_CheckTool::Print	(	const occ::handle< Interface_Check > &	ach,
		Standard_OStream &	S ) const

Utility method which Prints the content of a Check.

UnknownEntities()

Interface_EntityIterator Interface_CheckTool::UnknownEntities

(

)

Returns list of Unknown Entities Note that Error and Erroneous Entities are not considered as Unknown.

VerifyCheckList()

Interface_CheckIterator Interface_CheckTool::VerifyCheckList

(

)

Returns list of integrity constraints errors (semantic) (note that GlobalCheck is not in this list).

WarningCheckList()

Interface_CheckIterator Interface_CheckTool::WarningCheckList

(

)

Returns list of Corrections (includes GlobalCheck if corrected).

---

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

• Interface_CheckTool.hxx