BRepMesh_DiscretFactory Class Reference

This class intended to setup / retrieve default triangulation algorithm.
Use BRepMesh_DiscretFactory::Get() static method to retrieve global Factory instance.
Use BRepMesh_DiscretFactory::Discret() method to retrieve meshing tool.
More...

#include <BRepMesh_DiscretFactory.hxx>

Public Member Functions
const TColStd_MapOfAsciiString &	Names () const
	Returns the list of registered meshing algorithms.
Standard_Boolean	SetDefaultName (const TCollection_AsciiString &theName)
	Setup meshing algorithm by name. Returns TRUE if requested tool is available. On fail Factory will continue to use previous algo.
const TCollection_AsciiString &	DefaultName () const
	Returns name for current meshing algorithm.
Standard_Boolean	SetFunctionName (const TCollection_AsciiString &theFuncName)
	Advanced function. Changes function name to retrieve from plugin. Returns TRUE if requested tool is available. On fail Factory will continue to use previous algo.
const TCollection_AsciiString &	FunctionName () const
	Returns function name that should be exported by plugin.
BRepMesh_FactoryError	ErrorStatus () const
	Returns error status for last meshing algorithm switch.
Standard_Boolean	SetDefault (const TCollection_AsciiString &theName, const TCollection_AsciiString &theFuncName="DISCRETALGO")
	Setup meshing algorithm that should be created by this Factory. Returns TRUE if requested tool is available. On fail Factory will continue to use previous algo. Call ErrorStatus() method to retrieve fault reason.
Handle< BRepMesh_DiscretRoot >	Discret (const TopoDS_Shape &theShape, const Standard_Real theLinDeflection, const Standard_Real theAngDeflection)
	Returns triangulation algorithm instance.

Static Public Member Functions
static BRepMesh_DiscretFactory &	Get ()
	Returns the global factory instance.

Protected Member Functions
	BRepMesh_DiscretFactory ()
	Constructor.
virtual	~BRepMesh_DiscretFactory ()
	Destructor.
void	clear ()
	Clears factory data.

Protected Attributes
BRepMesh_PluginEntryType	myPluginEntry
BRepMesh_FactoryError	myErrorStatus
TColStd_MapOfAsciiString	myNames
TCollection_AsciiString	myDefaultName
TCollection_AsciiString	myFunctionName
Plugin_MapOfFunctions	myFactoryMethods

Detailed Description

This class intended to setup / retrieve default triangulation algorithm.
Use BRepMesh_DiscretFactory::Get() static method to retrieve global Factory instance.
Use BRepMesh_DiscretFactory::Discret() method to retrieve meshing tool.

Constructor & Destructor Documentation

BRepMesh_DiscretFactory()

BRepMesh_DiscretFactory::BRepMesh_DiscretFactory ( )

protected

Constructor.

~BRepMesh_DiscretFactory()

virtual BRepMesh_DiscretFactory::~BRepMesh_DiscretFactory ( )

protectedvirtual

Destructor.

Member Function Documentation

clear()

void BRepMesh_DiscretFactory::clear ( )

protected

Clears factory data.

DefaultName()

const TCollection_AsciiString & BRepMesh_DiscretFactory::DefaultName ( ) const

inline

Returns name for current meshing algorithm.

Discret()

Handle< BRepMesh_DiscretRoot > BRepMesh_DiscretFactory::Discret	(	const TopoDS_Shape &	theShape,
		const Standard_Real	theLinDeflection,
		const Standard_Real	theAngDeflection
	)

Returns triangulation algorithm instance.

Parameters

theShape	shape to be meshed.
theLinDeflection	linear deflection to be used for meshing.
theAngDeflection	angular deflection to be used for meshing.

ErrorStatus()

BRepMesh_FactoryError BRepMesh_DiscretFactory::ErrorStatus ( ) const

inline

Returns error status for last meshing algorithm switch.

FunctionName()

const TCollection_AsciiString & BRepMesh_DiscretFactory::FunctionName ( ) const

inline

Returns function name that should be exported by plugin.

Get()

static BRepMesh_DiscretFactory & BRepMesh_DiscretFactory::Get ( )

static

Returns the global factory instance.

Names()

const TColStd_MapOfAsciiString & BRepMesh_DiscretFactory::Names ( ) const

inline

Returns the list of registered meshing algorithms.

SetDefault()

Standard_Boolean BRepMesh_DiscretFactory::SetDefault	(	const TCollection_AsciiString &	theName,
		const TCollection_AsciiString &	theFuncName = "DISCRETALGO"
	)

Setup meshing algorithm that should be created by this Factory.
Returns TRUE if requested tool is available.
On fail Factory will continue to use previous algo.
Call ErrorStatus() method to retrieve fault reason.

SetDefaultName()

Standard_Boolean BRepMesh_DiscretFactory::SetDefaultName ( const TCollection_AsciiString &  theName )

inline

Setup meshing algorithm by name.
Returns TRUE if requested tool is available.
On fail Factory will continue to use previous algo.

SetFunctionName()

Standard_Boolean BRepMesh_DiscretFactory::SetFunctionName ( const TCollection_AsciiString &  theFuncName )

inline

Advanced function. Changes function name to retrieve from plugin.
Returns TRUE if requested tool is available.
On fail Factory will continue to use previous algo.

Field Documentation

myDefaultName

TCollection_AsciiString BRepMesh_DiscretFactory::myDefaultName

protected

myErrorStatus

BRepMesh_FactoryError BRepMesh_DiscretFactory::myErrorStatus

protected

myFactoryMethods

Plugin_MapOfFunctions BRepMesh_DiscretFactory::myFactoryMethods

protected

myFunctionName

TCollection_AsciiString BRepMesh_DiscretFactory::myFunctionName

protected

myNames

TColStd_MapOfAsciiString BRepMesh_DiscretFactory::myNames

protected

myPluginEntry

BRepMesh_PluginEntryType BRepMesh_DiscretFactory::myPluginEntry

protected

---

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

• BRepMesh_DiscretFactory.hxx