OCC Main Page | DataExchange | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

DataExchange
TKXSBase
Interface


Interface_CheckIterator Class Reference

Result of a Check operation (especially from InterfaceModel)
.

#include <Interface_CheckIterator.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_CheckIterator ()
 Creates an empty CheckIterator
.
Standard_EXPORT Interface_CheckIterator (const Standard_CString name)
 Creates a CheckIterator with a name (displayed by Print as a
title)
.
Standard_EXPORT void SetName (const Standard_CString name)
 Sets / Changes the name
.
Standard_EXPORT Standard_CString Name () const
 Returns the recorded name (can be empty)
.
Standard_EXPORT void SetModel (const Handle(Interface_InterfaceModel)&model)
 Defines a Model, used to locate entities (not required, if it
is absent, entities are simply less documented)
.
Standard_EXPORT Handle_Interface_InterfaceModel Model () const
 Returns the stored model (can be a null handle)
.
Standard_EXPORT void Clear ()
 Clears the list of checks
.
Standard_EXPORT void Merge (Interface_CheckIterator &other)
 Merges another CheckIterator into <me>, i.e. adds each of its
Checks. Content of <other> remains unchanged.
Takes also the Model but not the Name
.
Standard_EXPORT void Add (const Handle(Interface_Check)&ach, const Standard_Integer num=0)
 Adds a Check to the list to be iterated
This Check is Accompanied by Entity Number in the Model
(0 for Global Check or Entity unknown in the Model), if 0 and
Model is recorded in <me>, it is computed
.
Standard_EXPORT const Handle_Interface_Check & Check (const Standard_Integer num) const
 Returns the Check which was attached to an Entity given its
Number in the Model. <num>=0 is for the Global Check.
If no Check was recorded for this Number, returns an empty
Check.
Remark : Works apart from the iteration methods (no interference)
.
Standard_EXPORT const Handle_Interface_Check & Check (const Handle(Standard_Transient)&ent) const
 Returns the Check attached to an Entity
If no Check was recorded for this Entity, returns an empty
Check.
Remark : Works apart from the iteration methods (no interference)
.
Standard_EXPORT Handle_Interface_Check & CCheck (const Standard_Integer num)
 Returns the Check bound to an Entity Number (0 : Global)
in order to be consulted or completed on the spot
I.e. returns the Check if is already exists, or adds it then
returns the new empty Check
.
Standard_EXPORT Handle_Interface_Check & CCheck (const Handle(Standard_Transient)&ent)
 Returns the Check bound to an Entity, in order to be consulted
or completed on the spot
I.e. returns the Check if is already exists, or adds it then
returns the new empty Check
.
Standard_EXPORT Standard_Boolean IsEmpty (const Standard_Boolean failsonly) const
 Returns True if : no Fail has been recorded if <failsonly> is
True, no Check at all if <failsonly> is False
.
Standard_EXPORT Interface_CheckStatus Status () const
 Returns worst status among : OK, Warning, Fail
.
Standard_EXPORT Standard_Boolean Complies (const Interface_CheckStatus status) const
 Tells if this check list complies with a given status :
OK (i.e. empty), Warning (at least one Warning, but no Fail),
Fail (at least one), Message (not OK), NoFail, Any
.
Standard_EXPORT Interface_CheckIterator Extract (const Interface_CheckStatus status) const
 Returns a CheckIterator which contains the checks which comply
with a given status
Each check is added completely (no split Warning/Fail)
.
Standard_EXPORT Interface_CheckIterator Extract (const Standard_CString mess, const Standard_Integer incl, const Interface_CheckStatus status) const
 Returns a CheckIterator which contains the check which comply
with a message, plus some conditions as follows :
<incl> = 0 : <mess> exactly matches one of the messages
<incl> < 0 : <mess> is contained by one of the messages
<incl> > 0 : <mess> contains one of the messages
For <status> : for CheckWarning and CheckFail, considers only
resp. Warning or Check messages. for CheckAny, considers all
other values are ignored (answer will be false)
Each Check which complies is entirely taken
.
Standard_EXPORT Standard_Boolean Remove (const Standard_CString mess, const Standard_Integer incl, const Interface_CheckStatus status)
 Removes the messages of all Checks, under these conditions :
<incl> = 0 : <mess> exactly matches one of the messages
<incl> < 0 : <mess> is contained by one of the messages
<incl> > 0 : <mess> contains one of the messages
For <status> : for CheckWarning and CheckFail, considers only
resp. Warning or Check messages. for CheckAny, considers all
other values are ignored (nothing is done)
Returns True if at least one message has been removed, False else
.
Standard_EXPORT Handle_TColStd_HSequenceOfTransient Checkeds (const Standard_Boolean failsonly, const Standard_Boolean global) const
 Returns the list of entities concerned by a Check
Only fails if <failsonly> is True, else all non-empty checks
If <global> is true, adds the model for a global check
Else, global check is ignored
.
Standard_EXPORT void Start () const
 Starts Iteration. Thus, it is possible to restart it
Remark : an iteration may be done with a const Iterator
While its content is modified (through a pointer), this allows
to give it as a const argument to a function
.
Standard_EXPORT Standard_Boolean More () const
 Returns True if there are more Checks to get
.
Standard_EXPORT void Next () const
 Sets Iteration to next Item
.
Standard_EXPORT const Handle_Interface_Check & Value () const
 Returns Check currently Iterated
It brings all other informations (status, messages, ...)
The Number of the Entity in the Model is given by Number below
.
Standard_EXPORT Standard_Integer Number () const
 Returns Number of Entity for the Check currently iterated
or 0 for GlobalCheck
.
Standard_EXPORT void Print (const Handle(Message_Messenger)&S, const Standard_Boolean failsonly, const Standard_Integer final=0) const
 Prints the list of Checks with their attached Numbers
If <failsonly> is True, prints only Fail messages
If <failsonly> is False, prints all messages
If <final> = 0 (D), prints also original messages if different
If <final> < 0, prints only original messages
If <final> > 0, prints only final messages
It uses the recorded Model if it is defined
Remark : Works apart from the iteration methods (no interference)
.
Standard_EXPORT void Print (const Handle(Message_Messenger)&S, const Handle(Interface_InterfaceModel)&model, const Standard_Boolean failsonly, const Standard_Integer final=0) const
 Works as Print without a model, but for entities which have
no attached number (Number not positive), tries to compute
this Number from <model> and displays "original" or "computed"
.
Standard_EXPORT void Destroy ()
 Clears data of iteration
.
 ~Interface_CheckIterator ()

Private Attributes

Handle_Interface_HSequenceOfCheck thelist
Handle_TColStd_HSequenceOfInteger thenums
Handle_Interface_InterfaceModel themod
TCollection_AsciiString thename
Handle_Interface_IntVal thecurr


Constructor & Destructor Documentation

Standard_EXPORT Interface_CheckIterator::Interface_CheckIterator  ) 
 

Standard_EXPORT Interface_CheckIterator::Interface_CheckIterator const Standard_CString  name  ) 
 

Interface_CheckIterator::~Interface_CheckIterator  )  [inline]
 


Member Function Documentation

Standard_EXPORT void Interface_CheckIterator::Add const Handle(Interface_Check)&  ach,
const Standard_Integer  num = 0
 

Standard_EXPORT Handle_Interface_Check& Interface_CheckIterator::CCheck const Handle(Standard_Transient)&  ent  ) 
 

Standard_EXPORT Handle_Interface_Check& Interface_CheckIterator::CCheck const Standard_Integer  num  ) 
 

Standard_EXPORT const Handle_Interface_Check& Interface_CheckIterator::Check const Handle(Standard_Transient)&  ent  )  const
 

Standard_EXPORT const Handle_Interface_Check& Interface_CheckIterator::Check const Standard_Integer  num  )  const
 

Standard_EXPORT Handle_TColStd_HSequenceOfTransient Interface_CheckIterator::Checkeds const Standard_Boolean  failsonly,
const Standard_Boolean  global
const
 

Standard_EXPORT void Interface_CheckIterator::Clear  ) 
 

Standard_EXPORT Standard_Boolean Interface_CheckIterator::Complies const Interface_CheckStatus  status  )  const
 

Standard_EXPORT void Interface_CheckIterator::Destroy  ) 
 

Standard_EXPORT Interface_CheckIterator Interface_CheckIterator::Extract const Standard_CString  mess,
const Standard_Integer  incl,
const Interface_CheckStatus  status
const
 

Standard_EXPORT Interface_CheckIterator Interface_CheckIterator::Extract const Interface_CheckStatus  status  )  const
 

Standard_EXPORT Standard_Boolean Interface_CheckIterator::IsEmpty const Standard_Boolean  failsonly  )  const
 

Standard_EXPORT void Interface_CheckIterator::Merge Interface_CheckIterator other  ) 
 

Standard_EXPORT Handle_Interface_InterfaceModel Interface_CheckIterator::Model  )  const
 

Standard_EXPORT Standard_Boolean Interface_CheckIterator::More  )  const
 

Standard_EXPORT Standard_CString Interface_CheckIterator::Name  )  const
 

Standard_EXPORT void Interface_CheckIterator::Next  )  const
 

Standard_EXPORT Standard_Integer Interface_CheckIterator::Number  )  const
 

void Interface_CheckIterator::operator delete void *  anAddress  )  [inline]
 

void* Interface_CheckIterator::operator new size_t  size  )  [inline]
 

void* Interface_CheckIterator::operator new size_t  ,
void *  anAddress
[inline]
 

Standard_EXPORT void Interface_CheckIterator::Print const Handle(Message_Messenger)&  S,
const Handle(Interface_InterfaceModel)&  model,
const Standard_Boolean  failsonly,
const Standard_Integer  final = 0
const
 

Standard_EXPORT void Interface_CheckIterator::Print const Handle(Message_Messenger)&  S,
const Standard_Boolean  failsonly,
const Standard_Integer  final = 0
const
 

Standard_EXPORT Standard_Boolean Interface_CheckIterator::Remove const Standard_CString  mess,
const Standard_Integer  incl,
const Interface_CheckStatus  status
 

Standard_EXPORT void Interface_CheckIterator::SetModel const Handle(Interface_InterfaceModel)&  model  ) 
 

Standard_EXPORT void Interface_CheckIterator::SetName const Standard_CString  name  ) 
 

Standard_EXPORT void Interface_CheckIterator::Start  )  const
 

Standard_EXPORT Interface_CheckStatus Interface_CheckIterator::Status  )  const
 

Standard_EXPORT const Handle_Interface_Check& Interface_CheckIterator::Value  )  const
 


Field Documentation

Handle_Interface_IntVal Interface_CheckIterator::thecurr [private]
 

Handle_Interface_HSequenceOfCheck Interface_CheckIterator::thelist [private]
 

Handle_Interface_InterfaceModel Interface_CheckIterator::themod [private]
 

TCollection_AsciiString Interface_CheckIterator::thename [private]
 

Handle_TColStd_HSequenceOfInteger Interface_CheckIterator::thenums [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:41:32 2008 for OpenCASCADE by  doxygen 1.4.1