Pothos::Plugin Class Reference

#include <Plugin.hpp>

Public Member Functions
	Plugin (void)
	Create a null plugin. More...
	Plugin (const PluginPath &path, const Object &object=Object(), const PluginModule &module=PluginModule())
template<typename ValueType >
	Plugin (const PluginPath &path, ValueType &&value)
const PluginPath &	getPath (void) const
	Get the path from the Plugin. More...
const Object &	getObject (void) const
	Get the object from the Plugin. More...
const PluginModule &	getModule (void) const
	Get the Module from the Plugin. More...
std::string	toString (void) const
	String representation of plugin. More...

Detailed Description

A plugin is a combination of an Path, Object, and a Module.

Constructor & Destructor Documentation

Pothos::Plugin::Plugin

(

void

)

Create a null plugin.

Pothos::Plugin::Plugin	(	const PluginPath &	path,
		const Object &	object = Object(),
		const PluginModule &	module = PluginModule()
	)

Create a plugin from components.

template<typename ValueType >

Pothos::Plugin::Plugin	(	const PluginPath &	path,
		ValueType &&	value
	)

Create a plugin from components. This templated version takes any type and stores it in an Object.

Member Function Documentation

const PluginModule& Pothos::Plugin::getModule

(

void

)

const

Get the Module from the Plugin.

const Object& Pothos::Plugin::getObject

(

void

)

const

Get the object from the Plugin.

const PluginPath& Pothos::Plugin::getPath

(

void

)

const

Get the path from the Plugin.

std::string Pothos::Plugin::toString

(

void

)

const

String representation of plugin.

---

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

• include/Pothos/Plugin/Plugin.hpp