Base class to make transfer process. Reads or Writes specialized CAD files into/from OCCT. Each operation needs the Configuration Node. More...

#include <DE_Provider.hxx>

Inheritance diagram for DE_Provider:

[legend]

Data Structures
struct	ReadStreamNode
	Node to store read stream information Contains relative path and reference to input stream. More...

struct	WriteStreamNode
	Node to store write stream information Contains relative path and reference to output stream. More...

Public Types
using	WriteStreamList = NCollection_List<WriteStreamNode>
	List to store write stream nodes First element is the main stream, others are for internal referencing.

using	ReadStreamList = NCollection_List<ReadStreamNode>
	List to store read stream nodes First element is the main stream, others are for internal referencing.

Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Public Member Functions
	DE_Provider ()
	Default constructor Configure translation process with global configuration.

	DE_Provider (const occ::handle< DE_ConfigurationNode > &theNode)
	Configure translation process.

virtual bool	Read (const TCollection_AsciiString &thePath, const occ::handle< TDocStd_Document > &theDocument, occ::handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Reads a CAD file, according internal configuration.

virtual bool	Write (const TCollection_AsciiString &thePath, const occ::handle< TDocStd_Document > &theDocument, occ::handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Writes a CAD file, according internal configuration.

virtual bool	Read (ReadStreamList &theStreams, const occ::handle< TDocStd_Document > &theDocument, occ::handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Reads streams according to internal configuration.

virtual bool	Write (WriteStreamList &theStreams, const occ::handle< TDocStd_Document > &theDocument, occ::handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Writes streams according to internal configuration.

virtual bool	Read (const TCollection_AsciiString &thePath, const occ::handle< TDocStd_Document > &theDocument, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Reads a CAD file, according internal configuration.

virtual bool	Write (const TCollection_AsciiString &thePath, const occ::handle< TDocStd_Document > &theDocument, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Writes a CAD file, according internal configuration.

virtual bool	Read (ReadStreamList &theStreams, const occ::handle< TDocStd_Document > &theDocument, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Reads streams according to internal configuration.

virtual bool	Write (WriteStreamList &theStreams, const occ::handle< TDocStd_Document > &theDocument, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Writes streams according to internal configuration.

virtual bool	Read (const TCollection_AsciiString &thePath, TopoDS_Shape &theShape, occ::handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Reads a CAD file, according internal configuration.

virtual bool	Write (const TCollection_AsciiString &thePath, const TopoDS_Shape &theShape, occ::handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Writes a CAD file, according internal configuration.

virtual bool	Read (ReadStreamList &theStreams, TopoDS_Shape &theShape, occ::handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Reads streams according to internal configuration.

virtual bool	Write (WriteStreamList &theStreams, const TopoDS_Shape &theShape, occ::handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Writes streams according to internal configuration.

virtual bool	Read (const TCollection_AsciiString &thePath, TopoDS_Shape &theShape, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Reads a CAD file, according internal configuration.

virtual bool	Write (const TCollection_AsciiString &thePath, const TopoDS_Shape &theShape, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Writes a CAD file, according internal configuration.

virtual bool	Read (ReadStreamList &theStreams, TopoDS_Shape &theShape, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Reads streams according to internal configuration.

virtual bool	Write (WriteStreamList &theStreams, const TopoDS_Shape &theShape, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Writes streams according to internal configuration.

virtual TCollection_AsciiString	GetFormat () const =0
	Gets CAD format name of associated provider.

virtual TCollection_AsciiString	GetVendor () const =0
	Gets provider's vendor name of associated provider.

occ::handle< DE_ConfigurationNode >	GetNode () const
	Gets internal configuration node.

void	SetNode (const occ::handle< DE_ConfigurationNode > &theNode)
	Sets internal configuration node.

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

Detailed Description

Base class to make transfer process. Reads or Writes specialized CAD files into/from OCCT. Each operation needs the Configuration Node.

Providers are grouped by Vendor's name and Format type. The Vendor name is not defined by default. The Format type is not defined by default. The import process is not supported. The export process is not supported.

The algorithm for standalone transfer operation: 1) Create new empty Provider object 2) Configure the current object by special Configuration Node (SetNode) 3) Initiate the transfer process: 3.1) Call the required Read method (if Read methods are implemented) 3.2) Call the required Write method (if Write methods are implemented) 4) Validate the output values

Member Typedef Documentation

◆ ReadStreamList

using DE_Provider::ReadStreamList = NCollection_List<ReadStreamNode>

List to store read stream nodes First element is the main stream, others are for internal referencing.

◆ WriteStreamList

using DE_Provider::WriteStreamList = NCollection_List<WriteStreamNode>

List to store write stream nodes First element is the main stream, others are for internal referencing.

Constructor & Destructor Documentation

◆ DE_Provider() [1/2]

DE_Provider::DE_Provider ( )

Default constructor Configure translation process with global configuration.

◆ DE_Provider() [2/2]

DE_Provider::DE_Provider ( const occ::handle< DE_ConfigurationNode > & theNode )

Configure translation process.

Parameters

[in] theNode object to copy

Member Function Documentation

◆ GetFormat()

virtual TCollection_AsciiString DE_Provider::GetFormat ( ) const

pure virtual

Gets CAD format name of associated provider.

Returns: provider CAD format

Implemented in DEBREP_Provider, DEXCAF_Provider, DEGLTF_Provider, DEIGES_Provider, DEOBJ_Provider, DEPLY_Provider, DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ GetNode()

occ::handle< DE_ConfigurationNode > DE_Provider::GetNode ( ) const

inline

Gets internal configuration node.

Returns: configuration node object

◆ GetVendor()

virtual TCollection_AsciiString DE_Provider::GetVendor ( ) const

pure virtual

Gets provider's vendor name of associated provider.

Returns: provider's vendor name

Implemented in DEBREP_Provider, DEXCAF_Provider, DEGLTF_Provider, DEIGES_Provider, DEOBJ_Provider, DEPLY_Provider, DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Read() [1/8]

virtual bool DE_Provider::Read	(	const TCollection_AsciiString &	thePath,
		const occ::handle< TDocStd_Document > &	theDocument,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Reads a CAD file, according internal configuration.

Parameters

[in]	thePath	path to the import CAD file
[out]	theDocument	document to save result
[in]	theProgress	progress indicator

Returns: True if Read was successful

Reimplemented in DEBREP_Provider, DEXCAF_Provider, DEGLTF_Provider, DEIGES_Provider, DEOBJ_Provider, DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Read() [2/8]

virtual bool DE_Provider::Read	(	const TCollection_AsciiString &	thePath,
		const occ::handle< TDocStd_Document > &	theDocument,
		occ::handle< XSControl_WorkSession > &	theWS,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Reads a CAD file, according internal configuration.

Parameters

[in]	thePath	path to the import CAD file
[out]	theDocument	document to save result
[in]	theWS	current work session
[in]	theProgress	progress indicator

Returns: True if Read was successful

Reimplemented in DEBREP_Provider, DEXCAF_Provider, DEGLTF_Provider, DEIGES_Provider, DEOBJ_Provider, DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Read() [3/8]

virtual bool DE_Provider::Read	(	const TCollection_AsciiString &	thePath,
		TopoDS_Shape &	theShape,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Reads a CAD file, according internal configuration.

Parameters

[in]	thePath	path to the import CAD file
[out]	theShape	shape to save result
[in]	theProgress	progress indicator

Returns: True if Read was successful

Reimplemented in DEBREP_Provider, DEXCAF_Provider, DEGLTF_Provider, DEIGES_Provider, DEOBJ_Provider, DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Read() [4/8]

virtual bool DE_Provider::Read	(	const TCollection_AsciiString &	thePath,
		TopoDS_Shape &	theShape,
		occ::handle< XSControl_WorkSession > &	theWS,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Reads a CAD file, according internal configuration.

Parameters

[in]	thePath	path to the import CAD file
[out]	theShape	shape to save result
[in]	theWS	current work session
[in]	theProgress	progress indicator

Returns: True if Read was successful

Reimplemented in DEBREP_Provider, DEXCAF_Provider, DEGLTF_Provider, DEIGES_Provider, DEOBJ_Provider, DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Read() [5/8]

virtual bool DE_Provider::Read	(	ReadStreamList &	theStreams,
		const occ::handle< TDocStd_Document > &	theDocument,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Reads streams according to internal configuration.

Parameters

[in]	theStreams	streams to read from
[out]	theDocument	document to save result
[in]	theProgress	progress indicator

Returns: True if Read was successful

Reimplemented in DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Read() [6/8]

virtual bool DE_Provider::Read	(	ReadStreamList &	theStreams,
		const occ::handle< TDocStd_Document > &	theDocument,
		occ::handle< XSControl_WorkSession > &	theWS,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Reads streams according to internal configuration.

Parameters

[in]	theStreams	streams to read from
[out]	theDocument	document to save result
[in]	theWS	current work session
[in]	theProgress	progress indicator

Returns: True if Read was successful

Reimplemented in DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Read() [7/8]

virtual bool DE_Provider::Read	(	ReadStreamList &	theStreams,
		TopoDS_Shape &	theShape,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Reads streams according to internal configuration.

Parameters

[in]	theStreams	streams to read from
[out]	theShape	shape to save result
[in]	theProgress	progress indicator

Returns: True if Read was successful

Reimplemented in DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Read() [8/8]

virtual bool DE_Provider::Read	(	ReadStreamList &	theStreams,
		TopoDS_Shape &	theShape,
		occ::handle< XSControl_WorkSession > &	theWS,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Reads streams according to internal configuration.

Parameters

[in]	theStreams	streams to read from
[out]	theShape	shape to save result
[in]	theWS	current work session
[in]	theProgress	progress indicator

Returns: True if Read was successful

Reimplemented in DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ SetNode()

void DE_Provider::SetNode ( const occ::handle< DE_ConfigurationNode > & theNode )

inline

Sets internal configuration node.

Parameters

[in] theNode configuration node to set

◆ Write() [1/8]

virtual bool DE_Provider::Write	(	const TCollection_AsciiString &	thePath,
		const occ::handle< TDocStd_Document > &	theDocument,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Writes a CAD file, according internal configuration.

Parameters

[in]	thePath	path to the export CAD file
[out]	theDocument	document to export
[in]	theProgress	progress indicator

Returns: True if Write was successful

Reimplemented in DEBREP_Provider, DEXCAF_Provider, DEGLTF_Provider, DEIGES_Provider, DEOBJ_Provider, DEPLY_Provider, DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Write() [2/8]

virtual bool DE_Provider::Write	(	const TCollection_AsciiString &	thePath,
		const occ::handle< TDocStd_Document > &	theDocument,
		occ::handle< XSControl_WorkSession > &	theWS,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Writes a CAD file, according internal configuration.

Parameters

[in]	thePath	path to the export CAD file
[out]	theDocument	document to export
[in]	theWS	current work session
[in]	theProgress	progress indicator

Returns: True if Write was successful

Reimplemented in DEBREP_Provider, DEXCAF_Provider, DEGLTF_Provider, DEIGES_Provider, DEOBJ_Provider, DEPLY_Provider, DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Write() [3/8]

virtual bool DE_Provider::Write	(	const TCollection_AsciiString &	thePath,
		const TopoDS_Shape &	theShape,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Writes a CAD file, according internal configuration.

Parameters

[in]	thePath	path to the export CAD file
[out]	theShape	shape to export
[in]	theProgress	progress indicator

Returns: True if Write was successful

Reimplemented in DEBREP_Provider, DEXCAF_Provider, DEGLTF_Provider, DEIGES_Provider, DEOBJ_Provider, DEPLY_Provider, DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Write() [4/8]

virtual bool DE_Provider::Write	(	const TCollection_AsciiString &	thePath,
		const TopoDS_Shape &	theShape,
		occ::handle< XSControl_WorkSession > &	theWS,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Writes a CAD file, according internal configuration.

Parameters

[in]	thePath	path to the export CAD file
[out]	theShape	shape to export
[in]	theWS	current work session
[in]	theProgress	progress indicator

Returns: True if Write was successful

Reimplemented in DEBREP_Provider, DEXCAF_Provider, DEGLTF_Provider, DEIGES_Provider, DEOBJ_Provider, DEPLY_Provider, DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Write() [5/8]

virtual bool DE_Provider::Write	(	WriteStreamList &	theStreams,
		const occ::handle< TDocStd_Document > &	theDocument,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Writes streams according to internal configuration.

Parameters

[in]	theStreams	streams to write to
[out]	theDocument	document to export
[in]	theProgress	progress indicator

Returns: True if Write was successful

Reimplemented in DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Write() [6/8]

virtual bool DE_Provider::Write	(	WriteStreamList &	theStreams,
		const occ::handle< TDocStd_Document > &	theDocument,
		occ::handle< XSControl_WorkSession > &	theWS,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Writes streams according to internal configuration.

Parameters

[in]	theStreams	streams to write to
[out]	theDocument	document to export
[in]	theWS	current work session
[in]	theProgress	progress indicator

Returns: True if Write was successful

Reimplemented in DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Write() [7/8]

virtual bool DE_Provider::Write	(	WriteStreamList &	theStreams,
		const TopoDS_Shape &	theShape,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Writes streams according to internal configuration.

Parameters

[in]	theStreams	streams to write to
[out]	theShape	shape to export
[in]	theProgress	progress indicator

Returns: True if Write was successful

Reimplemented in DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

◆ Write() [8/8]

virtual bool DE_Provider::Write	(	WriteStreamList &	theStreams,
		const TopoDS_Shape &	theShape,
		occ::handle< XSControl_WorkSession > &	theWS,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

virtual

Writes streams according to internal configuration.

Parameters

[in]	theStreams	streams to write to
[out]	theShape	shape to export
[in]	theWS	current work session
[in]	theProgress	progress indicator

Returns: True if Write was successful

Reimplemented in DESTEP_Provider, DESTL_Provider, and DEVRML_Provider.

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

DE_Provider.hxx

Data Structures

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ReadStreamList

◆ WriteStreamList

Constructor & Destructor Documentation

◆ DE_Provider() [1/2]

◆ DE_Provider() [2/2]

Member Function Documentation

◆ GetFormat()

◆ GetNode()

◆ GetVendor()

◆ Read() [1/8]

◆ Read() [2/8]

◆ Read() [3/8]

◆ Read() [4/8]

◆ Read() [5/8]

◆ Read() [6/8]

◆ Read() [7/8]

◆ Read() [8/8]

◆ SetNode()

◆ Write() [1/8]

◆ Write() [2/8]

◆ Write() [3/8]

◆ Write() [4/8]

◆ Write() [5/8]

◆ Write() [6/8]

◆ Write() [7/8]

◆ Write() [8/8]