KiCad PCB EDA Suite
SCH_PLUGIN::SCH_PLUGIN_RELEASER Class Reference

Helper object to release a SCH_PLUGIN in the context of a potential thrown exception through its destructor. More...

#include <sch_io_mgr.h>

Public Member Functions

 SCH_PLUGIN_RELEASER (SCH_PLUGIN *aPlugin=nullptr)
 
 ~SCH_PLUGIN_RELEASER ()
 
void release ()
 
void set (SCH_PLUGIN *aPlugin)
 
 operator SCH_PLUGIN * () const
 
SCH_PLUGINoperator-> () const
 

Private Member Functions

SCH_PLUGIN_RELEASERoperator= (SCH_PLUGIN_RELEASER &aOther)
 
 SCH_PLUGIN_RELEASER (const SCH_PLUGIN_RELEASER &aOther)
 

Private Attributes

SCH_PLUGINplugin
 

Detailed Description

Helper object to release a SCH_PLUGIN in the context of a potential thrown exception through its destructor.

Definition at line 534 of file sch_io_mgr.h.

Constructor & Destructor Documentation

◆ SCH_PLUGIN_RELEASER() [1/2]

SCH_PLUGIN::SCH_PLUGIN_RELEASER::SCH_PLUGIN_RELEASER ( const SCH_PLUGIN_RELEASER aOther)
inlineprivate

Definition at line 542 of file sch_io_mgr.h.

542{}

◆ SCH_PLUGIN_RELEASER() [2/2]

SCH_PLUGIN::SCH_PLUGIN_RELEASER::SCH_PLUGIN_RELEASER ( SCH_PLUGIN aPlugin = nullptr)
inline

Definition at line 545 of file sch_io_mgr.h.

545 :
546 plugin( aPlugin )
547 {
548 }

◆ ~SCH_PLUGIN_RELEASER()

SCH_PLUGIN::SCH_PLUGIN_RELEASER::~SCH_PLUGIN_RELEASER ( )
inline

Definition at line 550 of file sch_io_mgr.h.

551 {
552 if( plugin )
553 release();
554 }

References plugin, and release().

Member Function Documentation

◆ operator SCH_PLUGIN *()

SCH_PLUGIN::SCH_PLUGIN_RELEASER::operator SCH_PLUGIN * ( ) const
inline

Definition at line 569 of file sch_io_mgr.h.

570 {
571 return plugin;
572 }

References plugin.

◆ operator->()

SCH_PLUGIN * SCH_PLUGIN::SCH_PLUGIN_RELEASER::operator-> ( ) const
inline

Definition at line 574 of file sch_io_mgr.h.

575 {
576 return plugin;
577 }

References plugin.

◆ operator=()

SCH_PLUGIN_RELEASER & SCH_PLUGIN::SCH_PLUGIN_RELEASER::operator= ( SCH_PLUGIN_RELEASER aOther)
inlineprivate

Definition at line 539 of file sch_io_mgr.h.

539{ return *this; }

◆ release()

void SCH_PLUGIN::SCH_PLUGIN_RELEASER::release ( )
inline

Definition at line 556 of file sch_io_mgr.h.

557 {
559 plugin = nullptr;
560 }
static void ReleasePlugin(SCH_PLUGIN *aPlugin)
Release a SCH_PLUGIN back to the system, and may cause it to be unloaded from memory.
Definition: sch_io_mgr.cpp:71

References plugin, and SCH_IO_MGR::ReleasePlugin().

Referenced by set(), SYMBOL_LIB_TABLE_ROW::SetType(), and ~SCH_PLUGIN_RELEASER().

◆ set()

void SCH_PLUGIN::SCH_PLUGIN_RELEASER::set ( SCH_PLUGIN aPlugin)
inline

Member Data Documentation

◆ plugin

SCH_PLUGIN* SCH_PLUGIN::SCH_PLUGIN_RELEASER::plugin
private

Definition at line 536 of file sch_io_mgr.h.

Referenced by operator SCH_PLUGIN *(), operator->(), release(), set(), and ~SCH_PLUGIN_RELEASER().


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