TObj_CheckModel Class Reference

#include <TObj_CheckModel.hxx>

Inheritance diagram for TObj_CheckModel:

Public Member Functions
	TObj_CheckModel (const occ::handle< TObj_Model > &theModel)
	Initialize checker by model.
void	SetToFix (const bool theToFix)
	Sets flag allowing fixing inconsistencies.
bool	IsToFix () const
	Returns true if it is allowed to fix inconsistencies.
const occ::handle< TObj_Model > &	GetModel () const
	Returns the checked model.
	~TObj_CheckModel () override=default
	Empty virtual destructor.
virtual bool	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.
Public Member Functions inherited from Message_Algorithm
	Message_Algorithm ()
	Empty constructor.
void	SetStatus (const Message_Status &theStat)
	Sets status with no parameter.
void	SetStatus (const Message_Status &theStat, const int theInt)
	Sets status with integer parameter.
void	SetStatus (const Message_Status &theStat, const char *const theStr, const bool noRepetitions=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.
void	SetStatus (const Message_Status &theStat, const TCollection_AsciiString &theStr, const bool noRepetitions=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.
void	SetStatus (const Message_Status &theStat, const occ::handle< TCollection_HAsciiString > &theStr, const bool noRepetitions=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.
void	SetStatus (const Message_Status &theStat, const TCollection_ExtendedString &theStr, const bool noRepetitions=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.
void	SetStatus (const Message_Status &theStat, const occ::handle< TCollection_HExtendedString > &theStr, const bool noRepetitions=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.
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.
const Message_ExecStatus &	GetStatus () const
	Returns copy of exec status of algorithm.
Message_ExecStatus &	ChangeStatus ()
	Returns exec status of algorithm.
void	ClearStatus ()
	Clear exec status of algorithm.
void	SetMessenger (const occ::handle< Message_Messenger > &theMsgr)
	Sets messenger to algorithm.
occ::handle< Message_Messenger >	GetMessenger () const
	Returns messenger of algorithm. The returned handle is always non-null and can be used for sending messages.
virtual void	SendStatusMessages (const Message_ExecStatus &theFilter, const Message_Gravity theTraceLevel=Message_Warning, const int theMaxCount=20) const
	Print messages for all status flags that have been set during algorithm execution, excluding statuses that are NOT set in theFilter.
void	SendMessages (const Message_Gravity theTraceLevel=Message_Warning, const int theMaxCount=20) const
	Convenient variant of SendStatusMessages() with theFilter having defined all WARN, ALARM, and FAIL (but not DONE) status flags.
void	AddStatus (const occ::handle< Message_Algorithm > &theOther)
	Add statuses to this algorithm from other algorithm (including messages)
void	AddStatus (const Message_ExecStatus &theStatus, const occ::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.
occ::handle< TColStd_HPackedMapOfInteger >	GetMessageNumbers (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.
occ::handle< NCollection_HSequence< occ::handle< TCollection_HExtendedString > > >	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.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
Standard_Transient *	This () 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Message_Algorithm
static TCollection_ExtendedString	PrepareReport (const occ::handle< TColStd_HPackedMapOfInteger > &theError, const int theMaxCount)
	Prepares a string containing a list of integers contained in theError map, but not more than theMaxCount.
static TCollection_ExtendedString	PrepareReport (const NCollection_Sequence< occ::handle< TCollection_HExtendedString > > &theReportSeq, const int theMaxCount)
	Prepares a string containing a list of names contained in theReportSeq sequence, but not more than theMaxCount.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.
Protected Attributes inherited from Message_Algorithm
Message_ExecStatus	myStatus
occ::handle< Message_Messenger >	myMessenger

Detailed Description

This class provides consistency check of the TObj model. It collects all inconsistencies in the status bits and prepares 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::TObj_CheckModel ( const occ::handle< TObj_Model > & theModel )

inline

Initialize checker by model.

~TObj_CheckModel()

TObj_CheckModel::~TObj_CheckModel ( )

overridedefault

Empty virtual destructor.

Member Function Documentation

GetModel()

const occ::handle< TObj_Model > & TObj_CheckModel::GetModel ( ) const

inline

Returns the checked model.

IsToFix()

bool TObj_CheckModel::IsToFix ( ) const

inline

Returns true if it is allowed to fix inconsistencies.

Perform()

virtual bool 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.

SetToFix()

void TObj_CheckModel::SetToFix ( const bool theToFix )

inline

Sets flag allowing fixing inconsistencies.

---

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

• TObj_CheckModel.hxx