Open CASCADE Technology  7.1.0.beta
Public Member Functions

TObj_CheckModel Class Reference

#include <TObj_CheckModel.hxx>

Inheritance diagram for TObj_CheckModel:
Inheritance graph
[legend]

Public Member Functions

 TObj_CheckModel (const Handle< TObj_Model > &theModel)
 Initialize checker by model. More...
 
void SetToFix (const Standard_Boolean theToFix)
 Sets flag allowing fixing inconsistencies. More...
 
Standard_Boolean IsToFix () const
 Returns true if it is allowed to fix inconsistencies. More...
 
const Handle< TObj_Model > & GetModel () const
 Returns the checked model. More...
 
virtual ~TObj_CheckModel ()
 Empty virtual destructor. More...
 
virtual Standard_Boolean Perform ()
 Performs all checks. Descendants should call parent method before doing own checks. This implementation checks OCAF references and back references between objects of the model. Returns true if no inconsistencies found. More...
 
- Public Member Functions inherited from Message_Algorithm
 Message_Algorithm ()
 Empty constructor. More...
 
void SetStatus (const Message_Status &theStat)
 Sets status with no parameter. More...
 
void SetStatus (const Message_Status &theStat, const Standard_Integer theInt)
 Sets status with integer parameter. More...
 
void SetStatus (const Message_Status &theStat, const Standard_CString theStr, const Standard_Boolean noRepetitions=Standard_True)
 Sets status with string parameter. If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag. More...
 
void SetStatus (const Message_Status &theStat, const TCollection_AsciiString &theStr, const Standard_Boolean noRepetitions=Standard_True)
 Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag. More...
 
void SetStatus (const Message_Status &theStat, const Handle< TCollection_HAsciiString > &theStr, const Standard_Boolean noRepetitions=Standard_True)
 Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag. More...
 
void SetStatus (const Message_Status &theStat, const TCollection_ExtendedString &theStr, const Standard_Boolean noRepetitions=Standard_True)
 Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag. More...
 
void SetStatus (const Message_Status &theStat, const Handle< TCollection_HExtendedString > &theStr, const Standard_Boolean noRepetitions=Standard_True)
 Sets status with string parameter If noRepetitions is True, the parameter will be added only if it has not been yet recorded for the same status flag. More...
 
void SetStatus (const Message_Status &theStat, const Message_Msg &theMsg)
 Sets status with preformatted message. This message will be used directly to report the status; automatic generation of status messages will be disabled for it. More...
 
const Message_ExecStatusGetStatus () const
 Returns copy of exec status of algorithm. More...
 
Message_ExecStatusChangeStatus ()
 Returns exec status of algorithm. More...
 
void ClearStatus ()
 Clear exec status of algorithm. More...
 
void SetMessenger (const Handle< Message_Messenger > &theMsgr)
 Sets messenger to algorithm. More...
 
Handle< Message_MessengerGetMessenger () const
 Returns messenger of algorithm. The returned handle is always non-null and can be used for sending messages. More...
 
virtual void SendStatusMessages (const Message_ExecStatus &theFilter, const Message_Gravity theTraceLevel=Message_Warning, const Standard_Integer theMaxCount=20) const
 Print messages for all status flags that have been set during algorithm execution, excluding statuses that are NOT set in theFilter. More...
 
void SendMessages (const Message_Gravity theTraceLevel=Message_Warning, const Standard_Integer theMaxCount=20) const
 Convenient variant of SendStatusMessages() with theFilter having defined all WARN, ALARM, and FAIL (but not DONE) status flags. More...
 
void AddStatus (const Handle< Message_Algorithm > &theOther)
 Add statuses to this algorithm from other algorithm (including messages) More...
 
void AddStatus (const Message_ExecStatus &theStatus, const Handle< Message_Algorithm > &theOther)
 Add statuses to this algorithm from other algorithm, but only those items are moved that correspond to statuses set in theStatus. More...
 
Handle< TColStd_HPackedMapOfIntegerGetMessageNumbers (const Message_Status &theStatus) const
 Return the numbers associated with the indicated status; Null handle if no such status or no numbers associated with it. More...
 
Handle< TColStd_HSequenceOfHExtendedString > GetMessageStrings (const Message_Status &theStatus) const
 Return the strings associated with the indicated status; Null handle if no such status or no strings associated with it. More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const override
 Memory deallocator for transient classes. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Message_Algorithm
static TCollection_ExtendedString PrepareReport (const Handle< TColStd_HPackedMapOfInteger > &theError, const Standard_Integer theMaxCount)
 Prepares a string containing a list of integers contained in theError map, but not more than theMaxCount. More...
 
static TCollection_ExtendedString PrepareReport (const TColStd_SequenceOfHExtendedString &theReportSeq, const Standard_Integer theMaxCount)
 Prepares a string containing a list of names contained in theReportSeq sequence, but not more than theMaxCount. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Attributes inherited from Message_Algorithm
Message_ExecStatus myStatus
 
Handle< Message_MessengermyMessenger
 

Detailed Description

This class provides consistency check of the TObj model. It collects all inconsistencies in the status bits and prepaires messages to be sent using SendStatusMessages (SendMessages) method. It supports also the fix mode, in which some inconsistencies are corrected.

Constructor & Destructor Documentation

TObj_CheckModel::TObj_CheckModel ( const Handle< TObj_Model > &  theModel)
inline

Initialize checker by model.

virtual TObj_CheckModel::~TObj_CheckModel ( )
inlinevirtual

Empty virtual destructor.

Member Function Documentation

const Handle< TObj_Model >& TObj_CheckModel::GetModel ( ) const
inline

Returns the checked model.

Standard_Boolean TObj_CheckModel::IsToFix ( ) const
inline

Returns true if it is allowed to fix inconsistencies.

virtual Standard_Boolean TObj_CheckModel::Perform ( )
virtual

Performs all checks. Descendants should call parent method before doing own checks. This implementation checks OCAF references and back references between objects of the model. Returns true if no inconsistencies found.

void TObj_CheckModel::SetToFix ( const Standard_Boolean  theToFix)
inline

Sets flag allowing fixing inconsistencies.


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