IMeshTools_ModelBuilder Class Reference

Interface class represents API for tool building discrete model. More...

#include <IMeshTools_ModelBuilder.hxx>

Inheritance diagram for IMeshTools_ModelBuilder:

Public Member Functions
virtual	~IMeshTools_ModelBuilder ()
	Destructor.
Handle< IMeshData_Model >	Perform (const TopoDS_Shape &theShape, const IMeshTools_Parameters &theParameters)
	Exceptions protected method to create discrete model for the given shape. Returns nullptr in case of failure.
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 Standard_Integer theInt)
	Sets status with integer parameter.
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.
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.
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.
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.
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.
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 Handle< Message_Messenger > &theMsgr)
	Sets messenger to algorithm.
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 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.
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.
void	AddStatus (const Handle< Message_Algorithm > &theOther)
	Add statuses to this algorithm from other algorithm (including messages)
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.
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.
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.
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 ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
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.
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.
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.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
	IMeshTools_ModelBuilder ()
	Constructor.
virtual Handle< IMeshData_Model >	performInternal (const TopoDS_Shape &theShape, const IMeshTools_Parameters &theParameters)=0
	Creates discrete model for the given shape. Returns nullptr in case of failure.

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 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.
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.
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
Handle< Message_Messenger >	myMessenger

Detailed Description

Interface class represents API for tool building discrete model.

The following statuses should be used by default: Message_Done1 - model has been successfully built. Message_Fail1 - empty shape. Message_Fail2 - model has not been build due to unexpected reason.

Constructor & Destructor Documentation

~IMeshTools_ModelBuilder()

virtual IMeshTools_ModelBuilder::~IMeshTools_ModelBuilder ( )

inlinevirtual

Destructor.

IMeshTools_ModelBuilder()

IMeshTools_ModelBuilder::IMeshTools_ModelBuilder ( )

inlineprotected

Constructor.

Member Function Documentation

Perform()

Handle< IMeshData_Model > IMeshTools_ModelBuilder::Perform ( const TopoDS_Shape &  theShape, const IMeshTools_Parameters &  theParameters  )

inline

Exceptions protected method to create discrete model for the given shape. Returns nullptr in case of failure.

performInternal()

virtual Handle< IMeshData_Model > IMeshTools_ModelBuilder::performInternal ( const TopoDS_Shape &  theShape, const IMeshTools_Parameters &  theParameters  )

protectedpure virtual

Creates discrete model for the given shape. Returns nullptr in case of failure.

Implemented in BRepMesh_ModelBuilder.

---

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

• IMeshTools_ModelBuilder.hxx