Pothos  0.7.0-gf7fbae99
The Pothos dataflow programming software suite
Public Member Functions | List of all members
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::null())
 
template<typename ValueType >
 Plugin (const PluginPath &path, ValueType &&value)
 
const PluginPathgetPath (void) const
 Get the path from the Plugin. More...
 
const ObjectgetObject (void) const
 Get the object from the Plugin. More...
 
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

◆ Plugin() [1/3]

Pothos::Plugin::Plugin ( void  )

Create a null plugin.

◆ Plugin() [2/3]

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

Create a plugin from components.

◆ Plugin() [3/3]

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

◆ getModule()

PluginModule Pothos::Plugin::getModule ( void  ) const

Get the Module from the Plugin.

◆ getObject()

const Object& Pothos::Plugin::getObject ( void  ) const

Get the object from the Plugin.

◆ getPath()

const PluginPath& Pothos::Plugin::getPath ( void  ) const

Get the path from the Plugin.

◆ toString()

std::string Pothos::Plugin::toString ( void  ) const

String representation of plugin.


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