The purpose of this class is to configure the transfer process for STL format Stores the necessary settings for DESTL_Provider. Configures and creates special provider to transfer STL files. More...

#include <DESTL_ConfigurationNode.hxx>

Inheritance diagram for DESTL_ConfigurationNode:

[legend]

Data Structures
struct	RWStl_InternalSection

Public Member Functions
	DESTL_ConfigurationNode ()
	Initializes all field by default.
	DESTL_ConfigurationNode (const occ::handle< DESTL_ConfigurationNode > &theNode)
	Copies values of all fields.
bool	Load (const occ::handle< DE_ConfigurationContext > &theResource) override
	Updates values according the resource.
TCollection_AsciiString	Save () const override
	Writes configuration to the string.
occ::handle< DE_ConfigurationNode >	Copy () const override
	Copies values of all fields.
occ::handle< DE_Provider >	BuildProvider () override
	Creates new provider for the own format.
bool	IsImportSupported () const override
	Checks the import supporting.
bool	IsExportSupported () const override
	Checks the export supporting.
bool	IsStreamSupported () const override
	Checks for stream support.
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.
NCollection_List< TCollection_AsciiString >	GetExtensions () const override
	Gets list of supported file extensions.
bool	CheckContent (const occ::handle< NCollection_Buffer > &theBuffer) const override
	Checks the file content to verify a format.
Public Member Functions inherited from DE_ConfigurationNode
	DE_ConfigurationNode ()
	Initializes all field by default.
	DE_ConfigurationNode (const occ::handle< DE_ConfigurationNode > &theConfigurationNode)
	Copies values of all fields.
virtual bool	Load (const TCollection_AsciiString &theResourcePath="")
	Updates values according the resource file.
bool	Save (const TCollection_AsciiString &theResourcePath) const
	Writes configuration to the resource file.
virtual bool	UpdateLoad (const bool theToImport, const bool theToKeep)
	Update loading status. Checking for the ability to read and write.
virtual bool	CheckExtension (const TCollection_AsciiString &theExtension) const
	Checks the file extension to verify a format.
bool	IsEnabled () const
	Gets the provider loading status.
void	SetEnabled (const bool theIsLoaded)
	Sets the provider loading status.
virtual void	CustomActivation (const NCollection_List< TCollection_AsciiString > &)
	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.
virtual void	Register (const occ::handle< DE_Wrapper > &theWrapper) const
	Registers configuration node with the specified wrapper.
virtual void	UnRegister (const occ::handle< DE_Wrapper > &theWrapper) const
	Unregisters configuration node from the specified wrapper.
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.

Data Fields
struct DESTL_ConfigurationNode::RWStl_InternalSection	InternalParameters
Data Fields inherited from DE_ConfigurationNode
struct DE_ConfigurationNode::DE_SectionGlobal	GlobalParameters

Additional Inherited Members
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 purpose of this class is to configure the transfer process for STL format Stores the necessary settings for DESTL_Provider. Configures and creates special provider to transfer STL files.

Nodes grouped by Vendor name and Format type. The Vendor name is "OCC" The Format type is "STL" The supported CAD extension is ".stl" The import process is supported. The export process is supported.

Constructor & Destructor Documentation

◆ DESTL_ConfigurationNode() [1/2]

DESTL_ConfigurationNode::DESTL_ConfigurationNode ( )

Initializes all field by default.

◆ DESTL_ConfigurationNode() [2/2]

DESTL_ConfigurationNode::DESTL_ConfigurationNode ( const occ::handle< DESTL_ConfigurationNode > & theNode )

Copies values of all fields.

Parameters

[in] theNode object to copy

Member Function Documentation

◆ BuildProvider()

occ::handle< DE_Provider > DESTL_ConfigurationNode::BuildProvider ( )

overridevirtual

Creates new provider for the own format.

Returns: new created provider

Implements DE_ConfigurationNode.

◆ CheckContent()

bool DESTL_ConfigurationNode::CheckContent ( const occ::handle< NCollection_Buffer > & theBuffer ) const

overridevirtual

Checks the file content to verify a format.

Parameters

[in] theBuffer read stream buffer to check content

Returns: true if file is supported by a current provider

Reimplemented from DE_ConfigurationNode.

◆ Copy()

occ::handle< DE_ConfigurationNode > DESTL_ConfigurationNode::Copy ( ) const

overridevirtual

Copies values of all fields.

Returns: new object with the same field values

Implements DE_ConfigurationNode.

◆ GetExtensions()

NCollection_List< TCollection_AsciiString > DESTL_ConfigurationNode::GetExtensions ( ) const

overridevirtual

Gets list of supported file extensions.

Returns: list of extensions

Implements DE_ConfigurationNode.

◆ GetFormat()

TCollection_AsciiString DESTL_ConfigurationNode::GetFormat ( ) const

overridevirtual

Gets CAD format name of associated provider.

Returns: provider CAD format

Implements DE_ConfigurationNode.

◆ GetVendor()

TCollection_AsciiString DESTL_ConfigurationNode::GetVendor ( ) const

overridevirtual

Gets provider's vendor name of associated provider.

Returns: provider's vendor name

Implements DE_ConfigurationNode.

◆ IsExportSupported()

bool DESTL_ConfigurationNode::IsExportSupported ( ) const

overridevirtual

Checks the export supporting.

Returns: true if export is supported

Reimplemented from DE_ConfigurationNode.

◆ IsImportSupported()

bool DESTL_ConfigurationNode::IsImportSupported ( ) const

overridevirtual

Checks the import supporting.

Returns: true if import is supported

Reimplemented from DE_ConfigurationNode.

◆ IsStreamSupported()

bool DESTL_ConfigurationNode::IsStreamSupported ( ) const

overridevirtual

Checks for stream support.

Returns: true if streams are supported

Reimplemented from DE_ConfigurationNode.

◆ Load()

bool DESTL_ConfigurationNode::Load ( const occ::handle< DE_ConfigurationContext > & theResource )

overridevirtual

Updates values according the resource.

Parameters

[in] theResource input resource to use

Returns: true if theResource loading has ended correctly

Implements DE_ConfigurationNode.

◆ Save()

TCollection_AsciiString DESTL_ConfigurationNode::Save ( ) const

overridevirtual

Writes configuration to the string.

Returns: result resource string

Implements DE_ConfigurationNode.

Field Documentation

◆ InternalParameters

struct DESTL_ConfigurationNode::RWStl_InternalSection DESTL_ConfigurationNode::InternalParameters

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

DESTL_ConfigurationNode.hxx

Data Structures

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DESTL_ConfigurationNode() [1/2]

◆ DESTL_ConfigurationNode() [2/2]

Member Function Documentation

◆ BuildProvider()

◆ CheckContent()

◆ Copy()

◆ GetExtensions()

◆ GetFormat()

◆ GetVendor()

◆ IsExportSupported()

◆ IsImportSupported()

◆ IsStreamSupported()

◆ Load()

◆ Save()

Field Documentation

◆ InternalParameters