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

#include <DEXCAFCascade_Provider.hxx>

Inheritance diagram for DEXCAFCascade_Provider:

[legend]

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

	DEXCAFCascade_Provider (const Handle< DE_ConfigurationNode > &theNode)
	Configure translation process.

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

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

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

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

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

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

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

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

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

virtual 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 Handle< DE_ConfigurationNode > &theNode)
	Configure translation process.

Handle< DE_ConfigurationNode >	GetNode () const
	Gets internal configuration node.

void	SetNode (const 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 ()
	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.

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

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

◆ DEXCAFCascade_Provider() [1/2]

DEXCAFCascade_Provider::DEXCAFCascade_Provider ( )

Default constructor Configure translation process with global configuration.

◆ DEXCAFCascade_Provider() [2/2]

DEXCAFCascade_Provider::DEXCAFCascade_Provider ( const Handle< DE_ConfigurationNode > & theNode )

Configure translation process.

Parameters

[in] theNode object to copy

Member Function Documentation

◆ GetFormat()

virtual TCollection_AsciiString DEXCAFCascade_Provider::GetFormat ( ) const

overridevirtual

Gets CAD format name of associated provider.

Returns: provider CAD format

Implements DE_Provider.

◆ GetVendor()

virtual TCollection_AsciiString DEXCAFCascade_Provider::GetVendor ( ) const

overridevirtual

Gets provider's vendor name of associated provider.

Returns: provider's vendor name

Implements DE_Provider.

◆ Read() [1/4]

virtual bool DEXCAFCascade_Provider::Read	(	const TCollection_AsciiString &	thePath,
		const 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
	theProgress[in]	progress indicator

Returns: true if Read operation has ended correctly

Reimplemented from DE_Provider.

◆ Read() [2/4]

virtual bool DEXCAFCascade_Provider::Read	(	const TCollection_AsciiString &	thePath,
		const Handle< TDocStd_Document > &	theDocument,
		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
	theProgress[in]	progress indicator

Returns: true if Read operation has ended correctly

Reimplemented from DE_Provider.

◆ Read() [3/4]

virtual bool DEXCAFCascade_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
	theProgress[in]	progress indicator

Returns: true if Read operation has ended correctly

Reimplemented from DE_Provider.

◆ Read() [4/4]

virtual bool DEXCAFCascade_Provider::Read	(	const TCollection_AsciiString &	thePath,
		TopoDS_Shape &	theShape,
		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
	theProgress[in]	progress indicator

Returns: true if Read operation has ended correctly

Reimplemented from DE_Provider.

◆ Write() [1/4]

virtual bool DEXCAFCascade_Provider::Write	(	const TCollection_AsciiString &	thePath,
		const 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
	theProgress[in]	progress indicator

Returns: true if Write operation has ended correctly

Reimplemented from DE_Provider.

◆ Write() [2/4]

virtual bool DEXCAFCascade_Provider::Write	(	const TCollection_AsciiString &	thePath,
		const Handle< TDocStd_Document > &	theDocument,
		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
	theProgress[in]	progress indicator

Returns: true if Write operation has ended correctly

Reimplemented from DE_Provider.

◆ Write() [3/4]

virtual bool DEXCAFCascade_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
	theProgress[in]	progress indicator

Returns: true if Write operation has ended correctly

Reimplemented from DE_Provider.

◆ Write() [4/4]

virtual bool DEXCAFCascade_Provider::Write	(	const TCollection_AsciiString &	thePath,
		const TopoDS_Shape &	theShape,
		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
	theProgress[in]	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:

DEXCAFCascade_Provider.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DEXCAFCascade_Provider() [1/2]

◆ DEXCAFCascade_Provider() [2/2]

Member Function Documentation

◆ GetFormat()

◆ GetVendor()

◆ Read() [1/4]

◆ Read() [2/4]

◆ Read() [3/4]

◆ Read() [4/4]

◆ Write() [1/4]

◆ Write() [2/4]

◆ Write() [3/4]

◆ Write() [4/4]