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 479 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 487 of file sch_io_mgr.h.

487 {}

◆ SCH_PLUGIN_RELEASER() [2/2]

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

Definition at line 490 of file sch_io_mgr.h.

490  :
491  plugin( aPlugin )
492  {
493  }

◆ ~SCH_PLUGIN_RELEASER()

SCH_PLUGIN::SCH_PLUGIN_RELEASER::~SCH_PLUGIN_RELEASER ( )
inline

Definition at line 495 of file sch_io_mgr.h.

496  {
497  if( plugin )
498  release();
499  }

References plugin, and release().

Member Function Documentation

◆ operator ->()

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

Definition at line 519 of file sch_io_mgr.h.

520  {
521  return plugin;
522  }

References plugin.

◆ operator SCH_PLUGIN *()

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

Definition at line 514 of file sch_io_mgr.h.

515  {
516  return plugin;
517  }

References plugin.

◆ operator=()

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

Definition at line 484 of file sch_io_mgr.h.

484 { return *this; }

◆ release()

void SCH_PLUGIN::SCH_PLUGIN_RELEASER::release ( )
inline

Definition at line 501 of file sch_io_mgr.h.

502  {
504  plugin = nullptr;
505  }
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:69

References plugin, and SCH_IO_MGR::ReleasePlugin().

Referenced by set(), 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 481 of file sch_io_mgr.h.

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


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