Base class to work with CAD transfer properties. Stores the necessary settings for a single Provider type. Configures and creates special provider to transfer CAD files. More...

#include <DE_ConfigurationNode.hxx>

Inheritance diagram for DE_ConfigurationNode:

[legend]

Data Structures
struct	DE_SectionGlobal
	< Internal parameters for transfer process More...

Public Member Functions
	DE_ConfigurationNode ()
	Initializes all field by default.

	DE_ConfigurationNode (const Handle< DE_ConfigurationNode > &theConfigurationNode)
	Copies values of all fields.

virtual bool	Load (const TCollection_AsciiString &theResourcePath="")
	Updates values according the resource file.

virtual bool	Load (const Handle< DE_ConfigurationContext > &theResource)=0
	Updates values according the resource.

bool	Save (const TCollection_AsciiString &theResourcePath) const
	Writes configuration to the resource file.

virtual TCollection_AsciiString	Save () const =0
	Writes configuration to the string.

virtual Handle< DE_Provider >	BuildProvider ()=0
	Creates new provider for the own format.

virtual Handle< DE_ConfigurationNode >	Copy () const =0
	Copies values of all fields.

virtual bool	UpdateLoad (const Standard_Boolean theToImport, const Standard_Boolean theToKeep)
	Update loading status. Checking for the ability to read and write.

virtual bool	IsImportSupported () const
	Checks the import supporting.

virtual bool	IsExportSupported () const
	Checks the export supporting.

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.

virtual TColStd_ListOfAsciiString	GetExtensions () const =0
	Gets list of supported file extensions.

virtual bool	CheckExtension (const TCollection_AsciiString &theExtension) const
	Checks the file extension to verify a format.

virtual bool	CheckContent (const Handle< NCollection_Buffer > &theBuffer) const
	Checks the file content to verify a format.

Standard_Boolean	IsEnabled () const
	Gets the provider loading status.

void	SetEnabled (const Standard_Boolean theIsLoaded)
	Sets the provider loading status.

virtual void	CustomActivation (const TColStd_ListOfAsciiString &)
	Custom function to activate commercial DE component. The input is special sequence of values that described in specific component documentation. Order is important. Each component can have own way of activation.

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.

Data Fields
struct DE_ConfigurationNode::DE_SectionGlobal	GlobalParameters

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 work with CAD transfer properties. Stores the necessary settings for a single Provider type. Configures and creates special provider to transfer CAD files.

Nodes 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 supported CAD extensions are 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 Node object 2) Configure the current Node 2.1) Use the external resource file to configure (Load) 2.2) Change the internal parameters directly: 2.2.1) Change field values of "GlobalParameters" 2.2.2) Change field values of "InternalParameters" 3) Create one-time transfer provider (BuildProvider) 4) Initiate the transfer process: 4.1) Import (if "::IsImportSupported: returns TRUE) 4.1.1) Validate the support of input format (::CheckContent or ::CheckExtension) 4.1.2) Use created provider's "::Read" method 4.2) Export (if "IsExportSupported: returns TRUE) 4.2.1) Use created provider's "::Write" method 5) Check the provider's output

Constructor & Destructor Documentation

◆ DE_ConfigurationNode() [1/2]

DE_ConfigurationNode::DE_ConfigurationNode ( )

Initializes all field by default.

◆ DE_ConfigurationNode() [2/2]

DE_ConfigurationNode::DE_ConfigurationNode ( const Handle< DE_ConfigurationNode > & theConfigurationNode )

Copies values of all fields.

Parameters

[in] theConfigurationNode object to copy

Member Function Documentation

◆ BuildProvider()

virtual Handle< DE_Provider > DE_ConfigurationNode::BuildProvider ( )

pure virtual

Creates new provider for the own format.

Returns: new created provider

Implemented in DEBRepCascade_ConfigurationNode, DEXCAFCascade_ConfigurationNode, IGESCAFControl_ConfigurationNode, RWGltf_ConfigurationNode, RWObj_ConfigurationNode, RWPly_ConfigurationNode, RWStl_ConfigurationNode, STEPCAFControl_ConfigurationNode, and Vrml_ConfigurationNode.

◆ CheckContent()

virtual bool DE_ConfigurationNode::CheckContent ( const Handle< NCollection_Buffer > & theBuffer ) const

virtual

Checks the file content to verify a format.

Parameters

[in] theBuffer read stream buffer to check content

Returns: Standard_True if file is supported by a current provider

Reimplemented in DEBRepCascade_ConfigurationNode, DEXCAFCascade_ConfigurationNode, IGESCAFControl_ConfigurationNode, RWPly_ConfigurationNode, RWStl_ConfigurationNode, and STEPCAFControl_ConfigurationNode.

◆ CheckExtension()

virtual bool DE_ConfigurationNode::CheckExtension ( const TCollection_AsciiString & theExtension ) const

virtual

Checks the file extension to verify a format.

Parameters

[in] theExtension input file extension

Returns: Standard_True if file is supported by a current provider

◆ Copy()

virtual Handle< DE_ConfigurationNode > DE_ConfigurationNode::Copy ( ) const

pure virtual

Copies values of all fields.

Returns: new object with the same field values

Implemented in DEBRepCascade_ConfigurationNode, DEXCAFCascade_ConfigurationNode, IGESCAFControl_ConfigurationNode, RWGltf_ConfigurationNode, RWObj_ConfigurationNode, RWPly_ConfigurationNode, RWStl_ConfigurationNode, STEPCAFControl_ConfigurationNode, and Vrml_ConfigurationNode.

◆ CustomActivation()

virtual void DE_ConfigurationNode::CustomActivation ( const TColStd_ListOfAsciiString & )

inlinevirtual

Custom function to activate commercial DE component. The input is special sequence of values that described in specific component documentation. Order is important. Each component can have own way of activation.

The main goal - real-time loading plug-in activation. OpenSource components don't need to have activation process.

◆ GetExtensions()

virtual TColStd_ListOfAsciiString DE_ConfigurationNode::GetExtensions ( ) const

pure virtual

Gets list of supported file extensions.

Returns: list of extensions

Implemented in DEBRepCascade_ConfigurationNode, DEXCAFCascade_ConfigurationNode, IGESCAFControl_ConfigurationNode, RWGltf_ConfigurationNode, RWObj_ConfigurationNode, RWPly_ConfigurationNode, RWStl_ConfigurationNode, STEPCAFControl_ConfigurationNode, and Vrml_ConfigurationNode.

◆ GetFormat()

virtual TCollection_AsciiString DE_ConfigurationNode::GetFormat ( ) const

pure virtual

Gets CAD format name of associated provider.

Returns: provider CAD format

Implemented in DEBRepCascade_ConfigurationNode, DEXCAFCascade_ConfigurationNode, IGESCAFControl_ConfigurationNode, RWGltf_ConfigurationNode, RWObj_ConfigurationNode, RWPly_ConfigurationNode, RWStl_ConfigurationNode, STEPCAFControl_ConfigurationNode, and Vrml_ConfigurationNode.

◆ GetVendor()

virtual TCollection_AsciiString DE_ConfigurationNode::GetVendor ( ) const

pure virtual

Gets provider's vendor name of associated provider.

Returns: provider's vendor name

Implemented in DEBRepCascade_ConfigurationNode, DEXCAFCascade_ConfigurationNode, IGESCAFControl_ConfigurationNode, RWGltf_ConfigurationNode, RWObj_ConfigurationNode, RWPly_ConfigurationNode, RWStl_ConfigurationNode, STEPCAFControl_ConfigurationNode, and Vrml_ConfigurationNode.

◆ IsEnabled()

Standard_Boolean DE_ConfigurationNode::IsEnabled ( ) const

inline

Gets the provider loading status.

Returns: Standard_True if the load is correct

◆ IsExportSupported()

virtual bool DE_ConfigurationNode::IsExportSupported ( ) const

virtual

Checks the export supporting.

Returns: Standard_True if export is support

Reimplemented in DEBRepCascade_ConfigurationNode, DEXCAFCascade_ConfigurationNode, IGESCAFControl_ConfigurationNode, RWGltf_ConfigurationNode, RWObj_ConfigurationNode, RWPly_ConfigurationNode, RWStl_ConfigurationNode, STEPCAFControl_ConfigurationNode, and Vrml_ConfigurationNode.

◆ IsImportSupported()

virtual bool DE_ConfigurationNode::IsImportSupported ( ) const

virtual

Checks the import supporting.

Returns: Standard_True if import is support

Reimplemented in DEBRepCascade_ConfigurationNode, DEXCAFCascade_ConfigurationNode, IGESCAFControl_ConfigurationNode, RWGltf_ConfigurationNode, RWObj_ConfigurationNode, RWPly_ConfigurationNode, RWStl_ConfigurationNode, STEPCAFControl_ConfigurationNode, and Vrml_ConfigurationNode.

◆ Load() [1/2]

virtual bool DE_ConfigurationNode::Load ( const Handle< DE_ConfigurationContext > & theResource )

pure virtual

Updates values according the resource.

Parameters

[in] theResource input resource to use

Returns: True if Load was successful

Implemented in DE_ShapeFixConfigurationNode, DEBRepCascade_ConfigurationNode, DEXCAFCascade_ConfigurationNode, IGESCAFControl_ConfigurationNode, RWGltf_ConfigurationNode, RWObj_ConfigurationNode, RWPly_ConfigurationNode, RWStl_ConfigurationNode, STEPCAFControl_ConfigurationNode, and Vrml_ConfigurationNode.

◆ Load() [2/2]

virtual bool DE_ConfigurationNode::Load ( const TCollection_AsciiString & theResourcePath = "" )

virtual

Updates values according the resource file.

Parameters

[in] theResourcePath file path to resource

Returns: True if Load was successful

◆ Save() [1/2]

virtual TCollection_AsciiString DE_ConfigurationNode::Save ( ) const

pure virtual

Writes configuration to the string.

Returns: result resource string

Implemented in DE_ShapeFixConfigurationNode, DEBRepCascade_ConfigurationNode, DEXCAFCascade_ConfigurationNode, IGESCAFControl_ConfigurationNode, RWGltf_ConfigurationNode, RWObj_ConfigurationNode, RWPly_ConfigurationNode, RWStl_ConfigurationNode, STEPCAFControl_ConfigurationNode, and Vrml_ConfigurationNode.

◆ Save() [2/2]

bool DE_ConfigurationNode::Save ( const TCollection_AsciiString & theResourcePath ) const

Writes configuration to the resource file.

Parameters

[in] theResourcePath file path to resource

Returns: True if Save was successful

◆ SetEnabled()

void DE_ConfigurationNode::SetEnabled ( const Standard_Boolean theIsLoaded )

inline

Sets the provider loading status.

Parameters

[in] theIsLoaded input load status

◆ UpdateLoad()

virtual bool DE_ConfigurationNode::UpdateLoad	(	const Standard_Boolean	theToImport,
		const Standard_Boolean	theToKeep )

virtual

Update loading status. Checking for the ability to read and write.

Parameters

[in]	theToImport	flag to updates for import. Standard_True-import, Standard_False-export
[in]	theToKeep	flag to save update result

Returns: Standard_True, if node can be used

Field Documentation

◆ GlobalParameters

struct DE_ConfigurationNode::DE_SectionGlobal DE_ConfigurationNode::GlobalParameters

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

DE_ConfigurationNode.hxx

Data Structures

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DE_ConfigurationNode() [1/2]

◆ DE_ConfigurationNode() [2/2]

Member Function Documentation

◆ BuildProvider()

◆ CheckContent()

◆ CheckExtension()

◆ Copy()

◆ CustomActivation()

◆ GetExtensions()

◆ GetFormat()

◆ GetVendor()

◆ IsEnabled()

◆ IsExportSupported()

◆ IsImportSupported()

◆ Load() [1/2]

◆ Load() [2/2]

◆ Save() [1/2]

◆ Save() [2/2]

◆ SetEnabled()

◆ UpdateLoad()

Field Documentation

◆ GlobalParameters