Open CASCADE Technology 6.6.0
Public Member Functions
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

#include <Interface_CheckTool.hxx>

Public Member Functions

 Interface_CheckTool (const Handle< Interface_InterfaceModel > &model, const 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 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 Handle< Interface_HGraph > &hgraph)
void FillCheck (const Handle< Standard_Transient > &ent, const Interface_ShareTool &sh, 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 Handle< Interface_Check > &ach, const Handle< Message_Messenger > &S) const
 Utility method which Prints the content of a Check

void Print (const Interface_CheckIterator &list, const Handle< Message_Messenger > &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)

Handle_Interface_Check Check (const Standard_Integer num)
 Returns the Check associated to an Entity identified by
its Number in a Model.

void CheckSuccess (const Standard_Boolean reset=Standard_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 <resest> is given True

Interface_CheckIterator CompleteCheckList ()
 Returns list of all "remarkable" informations, 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 dectected 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


Constructor & Destructor Documentation

Interface_CheckTool::Interface_CheckTool ( const Handle< Interface_InterfaceModel > &  model,
const Handle< Interface_Protocol > &  protocol 
)
Interface_CheckTool::Interface_CheckTool ( const Handle< Interface_InterfaceModel > &  model)
Interface_CheckTool::Interface_CheckTool ( const Interface_Graph graph)
Interface_CheckTool::Interface_CheckTool ( const Handle< Interface_HGraph > &  hgraph)

Member Function Documentation

Interface_CheckIterator Interface_CheckTool::AnalyseCheckList ( )
Handle_Interface_Check Interface_CheckTool::Check ( const Standard_Integer  num)
Interface_CheckIterator Interface_CheckTool::CheckList ( )
void Interface_CheckTool::CheckSuccess ( const Standard_Boolean  reset = Standard_False)
Interface_CheckIterator Interface_CheckTool::CompleteCheckList ( )
  • 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)
void Interface_CheckTool::FillCheck ( const Handle< Standard_Transient > &  ent,
const Interface_ShareTool sh,
Handle< Interface_Check > &  ach 
)
void Interface_CheckTool::Print ( const Handle< Interface_Check > &  ach,
const Handle< Message_Messenger > &  S 
) const
void Interface_CheckTool::Print ( const Interface_CheckIterator list,
const Handle< Message_Messenger > &  S 
) const
Interface_EntityIterator Interface_CheckTool::UnknownEntities ( )
Interface_CheckIterator Interface_CheckTool::VerifyCheckList ( )
Interface_CheckIterator Interface_CheckTool::WarningCheckList ( )

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines