lsst.base::ModuleImporter Class Reference

Base class that defines an interface for importing Python modules. More...

#include <ModuleImporter.h>

Inheritance diagram for lsst.base::ModuleImporter:

Static Public Member Functions
static bool	import (std::string const &name)
	Import the given Python module, and return true if successful. More...

Protected Member Functions
	ModuleImporter ()
virtual bool	_import (std::string const &name) const =0
virtual	~ModuleImporter ()

Static Private Member Functions
static void	install (ModuleImporter const *importer)

Friends
void	installPythonModuleImporter ()

Detailed Description

Base class that defines an interface for importing Python modules.

The default implementation (defined in the source file) simply returns false, indicating that it can't import the given module. The functional implementation is in the ioLib Swig module, which is installed when that module is imported. That machinery keeps us from calling Python C-API functions from standalone C++ binaries that aren't linked with Python.

Definition at line 48 of file ModuleImporter.h.

Constructor & Destructor Documentation

lsst.base::ModuleImporter::ModuleImporter ( )

inlineprotected

Definition at line 56 of file ModuleImporter.h.

{}

virtual lsst.base::ModuleImporter::~ModuleImporter ( )

inlineprotectedvirtual

Definition at line 60 of file ModuleImporter.h.

{}

Member Function Documentation

virtual bool lsst.base::ModuleImporter::_import ( std::string const &  name ) const

protectedpure virtual

bool lsst.base::ModuleImporter::import ( std::string const &  name )

static

Import the given Python module, and return true if successful.

Definition at line 49 of file ModuleImporter.cc.

                                                  {
    return getImporterSingleton()->_import(name);
}

void lsst.base::ModuleImporter::install ( ModuleImporter const *  importer )

staticprivate

Definition at line 53 of file ModuleImporter.cc.

                                                            {
    getImporterSingleton() = importer;
}

Friends And Related Function Documentation

void installPythonModuleImporter ( )

friend

---

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

• /home/lsstsw/stack/Linux64/base/11.0.rc2+5/include/lsst/base/ModuleImporter.h
• /home/lsstsw/stack/Linux64/base/11.0.rc2+5/src/ModuleImporter.cc