DEXCAF_Provider Class Reference

The class to transfer XCAF Documents. Reads and Writes any XDE Document files into/from OCCT. Each operation needs configuration node. More...

#include <DEXCAF_Provider.hxx>

Inheritance diagram for DEXCAF_Provider:

Public Member Functions
	DEXCAF_Provider ()
	Default constructor Configure translation process with global configuration.
	DEXCAF_Provider (const occ::handle< DE_ConfigurationNode > &theNode)
	Configure translation process.
bool	Read (const TCollection_AsciiString &thePath, const occ::handle< TDocStd_Document > &theDocument, occ::handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
	Reads a CAD file, according internal configuration.
bool	Write (const TCollection_AsciiString &thePath, const occ::handle< TDocStd_Document > &theDocument, occ::handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
	Writes a CAD file, according internal configuration.
bool	Read (const TCollection_AsciiString &thePath, const occ::handle< TDocStd_Document > &theDocument, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
	Reads a CAD file, according internal configuration.
bool	Write (const TCollection_AsciiString &thePath, const occ::handle< TDocStd_Document > &theDocument, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
	Writes a CAD file, according internal configuration.
bool	Read (const TCollection_AsciiString &thePath, TopoDS_Shape &theShape, occ::handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
	Reads a CAD file, according internal configuration.
bool	Write (const TCollection_AsciiString &thePath, const TopoDS_Shape &theShape, occ::handle< XSControl_WorkSession > &theWS, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
	Writes a CAD file, according internal configuration.
bool	Read (const TCollection_AsciiString &thePath, TopoDS_Shape &theShape, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
	Reads a CAD file, according internal configuration.
bool	Write (const TCollection_AsciiString &thePath, const TopoDS_Shape &theShape, const Message_ProgressRange &theProgress=Message_ProgressRange()) override
	Writes a CAD file, according internal configuration.
TCollection_AsciiString	GetFormat () const override
	Gets CAD format name of associated provider.
TCollection_AsciiString	GetVendor () const override
	Gets provider's vendor name of associated provider.
Public Member Functions inherited from DE_Provider
	DE_Provider ()
	Default constructor Configure translation process with global configuration.
	DE_Provider (const occ::handle< DE_ConfigurationNode > &theNode)
	Configure translation process.
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 (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 (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 (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.
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
Public Types inherited from DE_Provider
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.
typedef void	base_type
	Returns a type descriptor about this object.
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

The class to transfer XCAF Documents. Reads and Writes any XDE Document files into/from OCCT. Each operation needs configuration node.

Providers grouped by Vendor name and Format type. The Vendor name is "OCC" The Format type is "XCAF" The import process is supported. The export process is supported.

Constructor & Destructor Documentation

DEXCAF_Provider() [1/2]

DEXCAF_Provider::DEXCAF_Provider

(

)

Default constructor Configure translation process with global configuration.

DEXCAF_Provider() [2/2]

DEXCAF_Provider::DEXCAF_Provider

(

const occ::handle< DE_ConfigurationNode > &

theNode

)

Configure translation process.

Parameters

[in]

theNode

object to copy

Member Function Documentation

GetFormat()

TCollection_AsciiString DEXCAF_Provider::GetFormat ( ) const

overridevirtual

Gets CAD format name of associated provider.

Returns

provider CAD format

Implements DE_Provider.

GetVendor()

TCollection_AsciiString DEXCAF_Provider::GetVendor ( ) const

overridevirtual

Gets provider's vendor name of associated provider.

Returns

provider's vendor name

Implements DE_Provider.

Read() [1/4]

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

overridevirtual

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 operation has ended correctly

Reimplemented from DE_Provider.

Read() [2/4]

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

overridevirtual

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 operation has ended correctly

Reimplemented from DE_Provider.

Read() [3/4]

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

overridevirtual

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 operation has ended correctly

Reimplemented from DE_Provider.

Read() [4/4]

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

overridevirtual

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 operation has ended correctly

Reimplemented from DE_Provider.

Write() [1/4]

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

overridevirtual

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 operation has ended correctly

Reimplemented from DE_Provider.

Write() [2/4]

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

overridevirtual

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 operation has ended correctly

Reimplemented from DE_Provider.

Write() [3/4]

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

overridevirtual

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 operation has ended correctly

Reimplemented from DE_Provider.

Write() [4/4]

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

overridevirtual

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 operation has ended correctly

Reimplemented from DE_Provider.

---

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

• DEXCAF_Provider.hxx