This class is a C++ API wrapper for IInferencePlugin. More...

#include <ie_plugin_cpp.hpp>

Inheritance diagram for InferenceEngine::InferenceEngine:

Collaboration diagram for InferenceEngine::InferenceEngine:

Public Types
using	Ptr = std::shared_ptr< InferencePlugin >
	Shared pointer on InferencePlugin object.

Public Member Functions
	InferencePlugin ()=default
	A default constructor.

	InferencePlugin (const InferenceEnginePluginPtr &pointer)
	Constructs a plugin instance from the given pointer. More...

const Version *	GetVersion ()

ExecutableNetwork	LoadNetwork (ICNNNetwork &network, const std::map< std::string, std::string > &config)

ExecutableNetwork	LoadNetwork (CNNNetwork network, const std::map< std::string, std::string > &config)

void	AddExtension (InferenceEngine::IExtensionPtr extension)

void	SetConfig (const std::map< std::string, std::string > &config)

ExecutableNetwork	ImportNetwork (const std::string &modelFileName, const std::map< std::string, std::string > &config)

void	QueryNetwork (const ICNNNetwork &network, const std::map< std::string, std::string > &config, QueryNetworkResult &res) const

	operator InferenceEngine::InferenceEnginePluginPtr ()
	Converts InferenceEngine to InferenceEnginePluginPtr pointer. More...

virtual void	GetVersion (const Version *&versionInfo) noexcept=0
	Returns plugin version information. More...

virtual void	SetLogCallback (IErrorListener &listener) noexcept=0
	Sets logging callback. More...

virtual StatusCode	LoadNetwork (IExecutableNetwork::Ptr &ret, ICNNNetwork &network, const std::map< std::string, std::string > &config, ResponseDesc *resp) noexcept=0
	Creates an executable network from a network object. User can create as many networks as they need and use them simultaneously (up to the limitation of the hardware resources) More...

virtual StatusCode	ImportNetwork (IExecutableNetwork::Ptr &ret, const std::string &modelFileName, const std::map< std::string, std::string > &config, ResponseDesc *resp) noexcept=0
	Creates an executable network from a previously exported network. More...

virtual StatusCode	AddExtension (InferenceEngine::IExtensionPtr extension, InferenceEngine::ResponseDesc *resp) noexcept=0
	Registers extension within the plugin. More...

virtual StatusCode	SetConfig (const std::map< std::string, std::string > &config, ResponseDesc *resp) noexcept=0
	Sets configuration for plugin, acceptable keys can be found in ie_plugin_config.hpp. More...

virtual void	QueryNetwork (const ICNNNetwork &network, const std::map< std::string, std::string > &config, QueryNetworkResult &res) const noexcept
	Query plugin if it supports specified network with specified configuration. More...

	~IInferencePlugin () override
	A default virtual destructor.

	PluginDispatcher (const std::vector< file_name_t > &pp={file_name_t()})
	A constructor. More...

virtual InferencePlugin	getPluginByName (const file_name_t &name) const
	Loads a plugin from plugin directories. More...

InferencePlugin	getPluginByDevice (const std::string &deviceName) const
	Loads a plugin from directories that is suitable for the device string. More...

Protected Member Functions
file_name_t	make_plugin_name (const file_name_t &path, const file_name_t &input) const
	Creates path to the plugin. More...

Detailed Description

This class is a C++ API wrapper for IInferencePlugin.

This is a class to load a suitable plugin.

This class is a main plugin interface.

Deprecated:: Use InferenceEngine::Core instead.

It can throw exceptions safely for the application, where it is properly handled.

Deprecated:: Use InferenceEngine::Core instead.

Deprecated:: Use InferenceEngine::Core instead.

Member Function Documentation

§ AddExtension() [1/2]

void InferenceEngine::InferenceEngine::AddExtension ( InferenceEngine::IExtensionPtr extension )

inline

Wraps IInferencePlugin::AddExtension

Parameters

extension Pointer to loaded Extension

§ AddExtension() [2/2]

virtual StatusCode InferenceEngine::InferenceEngine::AddExtension	(	InferenceEngine::IExtensionPtr	extension,
		InferenceEngine::ResponseDesc *	resp
	)

pure virtualnoexcept

Registers extension within the plugin.

Parameters

extension	Pointer to already loaded extension
resp	Pointer to the response message that holds a description of an error if any occurred

Returns: Status code of the operation. InferenceEngine::OK if succeeded

§ getPluginByDevice()

InferencePlugin InferenceEngine::InferenceEngine::getPluginByDevice ( const std::string & deviceName ) const

Loads a plugin from directories that is suitable for the device string.

Deprecated:: Use InferenceEngine::Core to work with devices by name

Parameters

deviceName A string value representing target device

Returns: A pointer to the plugin

§ getPluginByName()

virtual InferencePlugin InferenceEngine::InferenceEngine::getPluginByName ( const file_name_t & name ) const

virtual

Loads a plugin from plugin directories.

Parameters

name	Plugin name

Returns: A pointer to the loaded plugin

§ GetVersion() [1/2]

const Version* InferenceEngine::InferenceEngine::GetVersion ( )

inline

Wraps IInferencePlugin::GetVersion

§ GetVersion() [2/2]

virtual void InferenceEngine::InferenceEngine::GetVersion ( const Version *& versionInfo )

pure virtualnoexcept

Returns plugin version information.

Parameters

versionInfo Pointer to version info. Is set by plugin

§ ImportNetwork() [1/2]

virtual StatusCode InferenceEngine::InferenceEngine::ImportNetwork	(	IExecutableNetwork::Ptr &	ret,
		const std::string &	modelFileName,
		const std::map< std::string, std::string > &	config,
		ResponseDesc *	resp
	)

pure virtualnoexcept

Creates an executable network from a previously exported network.

Parameters

ret	Reference to a shared ptr of the returned network interface
modelFileName	Path to the location of the exported file
config	Map of pairs: (config parameter name, config parameter value) relevant only for this load operation*
resp	Pointer to the response message that holds a description of an error if any occurred

Returns: Status code of the operation. InferenceEngine::OK if succeeded

§ ImportNetwork() [2/2]

ExecutableNetwork InferenceEngine::InferenceEngine::ImportNetwork	(	const std::string &	modelFileName,
		const std::map< std::string, std::string > &	config
	)

inline

Wraps IInferencePlugin::ImportNetwork

Parameters

modelFileName	A path to the imported network
config	A configuration map

Returns: Created Executable Network object

§ InferencePlugin()

InferenceEngine::InferenceEngine::InferencePlugin ( const InferenceEnginePluginPtr & pointer )

inlineexplicit

Constructs a plugin instance from the given pointer.

Parameters

pointer Initialized Plugin pointer

§ LoadNetwork() [1/3]

ExecutableNetwork InferenceEngine::InferenceEngine::LoadNetwork	(	ICNNNetwork &	network,
		const std::map< std::string, std::string > &	config
	)

inline

Wraps IInferencePlugin::LoadNetwork(IExecutableNetwork::Ptr&, ICNNNetwork&, const std::map<std::string, std::string> &, ResponseDesc*)

Parameters

network	A network object to load
config	A map of configuration options

Returns: Created Executable Network object

§ LoadNetwork() [2/3]

ExecutableNetwork InferenceEngine::InferenceEngine::LoadNetwork	(	CNNNetwork	network,
		const std::map< std::string, std::string > &	config
	)

inline

Wraps IInferencePlugin::LoadNetwork(IExecutableNetwork::Ptr&, ICNNNetwork&, const std::map<std::string, std::string> &, ResponseDesc*)

Parameters

network	A network object to load
config	A map of configuration options

Returns: Created Executable Network object

§ LoadNetwork() [3/3]

virtual StatusCode InferenceEngine::InferenceEngine::LoadNetwork	(	IExecutableNetwork::Ptr &	ret,
		ICNNNetwork &	network,
		const std::map< std::string, std::string > &	config,
		ResponseDesc *	resp
	)

pure virtualnoexcept

Creates an executable network from a network object. User can create as many networks as they need and use them simultaneously (up to the limitation of the hardware resources)

Parameters

ret	Reference to a shared ptr of the returned network interface
network	Network object acquired from CNNNetReader
config	Map of pairs: (config parameter name, config parameter value) relevant only for this load operation
resp	Pointer to the response message that holds a description of an error if any occurred

Returns: Status code of the operation. InferenceEngine::OK if succeeded

§ make_plugin_name()

file_name_t InferenceEngine::InferenceEngine::make_plugin_name	(	const file_name_t &	path,
		const file_name_t &	input
	)		const

protected

Creates path to the plugin.

Parameters

path	Path to the plugin
input	Plugin name

Returns: The path to the plugin

§ operator InferenceEngine::InferenceEnginePluginPtr()

InferenceEngine::InferenceEngine::operator InferenceEngine::InferenceEnginePluginPtr ( )

inline

Converts InferenceEngine to InferenceEnginePluginPtr pointer.

Returns: Wrapped object

§ PluginDispatcher()

InferenceEngine::InferenceEngine::PluginDispatcher ( const std::vector< file_name_t > & pp = {file_name_t()} )

explicit

A constructor.

Parameters

pp	Vector of paths to plugin directories

§ QueryNetwork() [1/2]

virtual void InferenceEngine::InferenceEngine::QueryNetwork	(	const ICNNNetwork &	network,
		const std::map< std::string, std::string > &	config,
		QueryNetworkResult &	res
	)		const

inlinevirtualnoexcept

Query plugin if it supports specified network with specified configuration.

Parameters

network	Network object to query
config	Map of pairs: (config parameter name, config parameter value)
res	Reference to query network result

§ QueryNetwork() [2/2]

void InferenceEngine::InferenceEngine::QueryNetwork	(	const ICNNNetwork &	network,
		const std::map< std::string, std::string > &	config,
		QueryNetworkResult &	res
	)		const

inline

Wraps IInferencePlugin::QueryNetwork(const ICNNNetwork&, const std::map<std::string, std::string> &, QueryNetworkResult&) const

Parameters

network	A network object to query
config	A configuration map
res	Query results

§ SetConfig() [1/2]

void InferenceEngine::InferenceEngine::SetConfig ( const std::map< std::string, std::string > & config )

inline

Wraps IInferencePlugin::SetConfig

Parameters

config A configuration map

§ SetConfig() [2/2]

virtual StatusCode InferenceEngine::InferenceEngine::SetConfig	(	const std::map< std::string, std::string > &	config,
		ResponseDesc *	resp
	)

pure virtualnoexcept

Sets configuration for plugin, acceptable keys can be found in ie_plugin_config.hpp.

Parameters

config	Map of pairs: (config parameter name, config parameter value)
resp	Pointer to the response message that holds a description of an error if any occurred

Returns: Status code of the operation. InferenceEngine::OK if succeeded

§ SetLogCallback()

virtual void InferenceEngine::InferenceEngine::SetLogCallback ( IErrorListener & listener )

pure virtualnoexcept

Sets logging callback.

Logging is used to track what is going on inside

Parameters

listener Logging sink

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

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

§ AddExtension() [1/2]

§ AddExtension() [2/2]

§ getPluginByDevice()

§ getPluginByName()

§ GetVersion() [1/2]

§ GetVersion() [2/2]

§ ImportNetwork() [1/2]

§ ImportNetwork() [2/2]

§ InferencePlugin()

§ LoadNetwork() [1/3]

§ LoadNetwork() [2/3]

§ LoadNetwork() [3/3]

§ make_plugin_name()

§ operator InferenceEngine::InferenceEnginePluginPtr()

§ PluginDispatcher()

§ QueryNetwork() [1/2]

§ QueryNetwork() [2/2]

§ SetConfig() [1/2]

§ SetConfig() [2/2]

§ SetLogCallback()