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]

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

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

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

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

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

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

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

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

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

virtual Standard_Boolean	Write (const TCollection_AsciiString &thePath, const TopoDS_Shape &theShape, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Writes a CAD file, according 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.

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

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

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 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 DEBRepCascade_Provider, DEXCAFCascade_Provider, IGESCAFControl_Provider, RWGltf_Provider, RWObj_Provider, RWPly_Provider, RWStl_Provider, STEPCAFControl_Provider, and Vrml_Provider.

◆ GetNode()

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 DEBRepCascade_Provider, DEXCAFCascade_Provider, IGESCAFControl_Provider, RWGltf_Provider, RWObj_Provider, RWPly_Provider, RWStl_Provider, STEPCAFControl_Provider, and Vrml_Provider.

◆ Read() [1/4]

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

Returns: True if Read was successful

Reimplemented in DEBRepCascade_Provider, DEXCAFCascade_Provider, IGESCAFControl_Provider, RWGltf_Provider, RWObj_Provider, RWStl_Provider, STEPCAFControl_Provider, and Vrml_Provider.

◆ Read() [2/4]

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

Returns: True if Read was successful

Reimplemented in DEBRepCascade_Provider, DEXCAFCascade_Provider, IGESCAFControl_Provider, RWGltf_Provider, RWObj_Provider, RWStl_Provider, STEPCAFControl_Provider, and Vrml_Provider.

◆ Read() [3/4]

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

Returns: True if Read was successful

Reimplemented in DEBRepCascade_Provider, DEXCAFCascade_Provider, IGESCAFControl_Provider, RWGltf_Provider, RWObj_Provider, RWStl_Provider, STEPCAFControl_Provider, and Vrml_Provider.

◆ Read() [4/4]

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

Returns: True if Read was successful

Reimplemented in DEBRepCascade_Provider, DEXCAFCascade_Provider, IGESCAFControl_Provider, RWGltf_Provider, RWObj_Provider, RWStl_Provider, STEPCAFControl_Provider, and Vrml_Provider.

◆ SetNode()

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

inline

Sets internal configuration node.

Parameters

[in] theNode configuration node to set

◆ Write() [1/4]

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

Returns: True if Write was successful

Reimplemented in DEBRepCascade_Provider, DEXCAFCascade_Provider, IGESCAFControl_Provider, RWGltf_Provider, RWObj_Provider, RWPly_Provider, RWStl_Provider, STEPCAFControl_Provider, and Vrml_Provider.

◆ Write() [2/4]

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

Returns: True if Write was successful

Reimplemented in DEBRepCascade_Provider, DEXCAFCascade_Provider, IGESCAFControl_Provider, RWGltf_Provider, RWObj_Provider, RWPly_Provider, RWStl_Provider, STEPCAFControl_Provider, and Vrml_Provider.

◆ Write() [3/4]

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

Returns: True if Write was successful

Reimplemented in DEBRepCascade_Provider, DEXCAFCascade_Provider, IGESCAFControl_Provider, RWGltf_Provider, RWObj_Provider, RWPly_Provider, RWStl_Provider, STEPCAFControl_Provider, and Vrml_Provider.

◆ Write() [4/4]

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

Returns: True if Write was successful

Reimplemented in DEBRepCascade_Provider, DEXCAFCascade_Provider, IGESCAFControl_Provider, RWGltf_Provider, RWObj_Provider, RWPly_Provider, RWStl_Provider, STEPCAFControl_Provider, and Vrml_Provider.

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

DE_Provider.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DE_Provider() [1/2]

◆ DE_Provider() [2/2]

Member Function Documentation

◆ GetFormat()

◆ GetNode()

◆ GetVendor()

◆ Read() [1/4]

◆ Read() [2/4]

◆ Read() [3/4]

◆ Read() [4/4]

◆ SetNode()

◆ Write() [1/4]

◆ Write() [2/4]

◆ Write() [3/4]

◆ Write() [4/4]