# DataExchange
TKXSBase
Interface

# 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

void * | operator new (size_t, void *anAddress)
void * | operator new (size_t size)
void | operator delete (void *anAddress)
Standard_EXPORT | 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 .
Standard_EXPORT | 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) .
Standard_EXPORT | 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 .
Standard_EXPORT | Interface_CheckTool (const Handle(Interface_HGraph)&hgraph)
Standard_EXPORT 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 .
Standard_EXPORT void | Print (const Handle(Interface_Check)&ach, const Handle(Message_Messenger)&S) const
| Utility method which Prints the content of a Check .
Standard_EXPORT 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) .
Standard_EXPORT Handle_Interface_Check | Check (const Standard_Integer num)
| Returns the Check associated to an Entity identified by its Number in a Model. .
Standard_EXPORT 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 .
Standard_EXPORT Interface_CheckIterator | CompleteCheckList ()
| Returns list of all "remarkable" informations, 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) .
Standard_EXPORT 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 .
Standard_EXPORT Interface_CheckIterator | AnalyseCheckList ()
| Returns list of errors dectected at Analyse time (syntactic) (note that GlobalCheck is not in this list) .
Standard_EXPORT Interface_CheckIterator | VerifyCheckList ()
| Returns list of integrity constraints errors (semantic) (note that GlobalCheck is not in this list) .
Standard_EXPORT Interface_CheckIterator | WarningCheckList ()
| Returns list of Corrections (includes GlobalCheck if corrected) .
Standard_EXPORT Interface_EntityIterator | UnknownEntities ()
| Returns list of Unknown Entities Note that Error and Erroneous Entities are not considered as Unknown .

## Private Attributes

Handle_Interface_GTool | thegtool
Interface_ShareTool | theshare
Standard_Integer | thestat

## Constructor & Destructor Documentation

Standard_EXPORT Interface_CheckTool::Interface_CheckTool | ( | const Handle(Interface_InterfaceModel)& | model,
|  | const Handle(Interface_Protocol)& | protocol
| ) |

Standard_EXPORT Interface_CheckTool::Interface_CheckTool | ( | const Handle(Interface_InterfaceModel)& | model | ) |

Standard_EXPORT Interface_CheckTool::Interface_CheckTool | ( | const Interface_Graph & | graph | ) |

Standard_EXPORT Interface_CheckTool::Interface_CheckTool | ( | const Handle(Interface_HGraph)& | hgraph | ) |

## Member Function Documentation

Standard_EXPORT Interface_CheckIterator Interface_CheckTool::AnalyseCheckList | ( |  | ) |

Standard_EXPORT Handle_Interface_Check Interface_CheckTool::Check | ( | const Standard_Integer | num | ) |

Standard_EXPORT Interface_CheckIterator Interface_CheckTool::CheckList | ( |  | ) |

Standard_EXPORT void Interface_CheckTool::CheckSuccess | ( | const Standard_Boolean | reset = `Standard_False` | ) |

Standard_EXPORT Interface_CheckIterator Interface_CheckTool::CompleteCheckList | ( |  | ) |

Standard_EXPORT void Interface_CheckTool::FillCheck | ( | const Handle(Standard_Transient)& | ent,
|  | const Interface_ShareTool & | sh,
|  | Handle(Interface_Check)& | ach
| ) |

void Interface_CheckTool::operator delete | ( | void * | anAddress | ) | `[inline]`

void* Interface_CheckTool::operator new | ( | size_t | size | ) | `[inline]`

void* Interface_CheckTool::operator new | ( | size_t | ,
|  | void * | anAddress
| ) | `[inline]`

Standard_EXPORT void Interface_CheckTool::Print | ( | const Interface_CheckIterator & | list,
|  | const Handle(Message_Messenger)& | S
| ) | const

Standard_EXPORT void Interface_CheckTool::Print | ( | const Handle(Interface_Check)& | ach,
|  | const Handle(Message_Messenger)& | S
| ) | const

Standard_EXPORT Interface_EntityIterator Interface_CheckTool::UnknownEntities | ( |  | ) |

Standard_EXPORT Interface_CheckIterator Interface_CheckTool::VerifyCheckList | ( |  | ) |

Standard_EXPORT Interface_CheckIterator Interface_CheckTool::WarningCheckList | ( |  | ) |

## Field Documentation

Handle_Interface_GTool Interface_CheckTool::thegtool `[private]`

Interface_ShareTool Interface_CheckTool::theshare `[private]`

Standard_Integer Interface_CheckTool::thestat `[private]`

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

- Interface_CheckTool.hxx