Pothos::PluginPath Class Reference

#include <Path.hpp>

Public Member Functions
	PluginPath (void)
	PluginPath (const std::string &path)
	PluginPath (const PluginPath &path0, const PluginPath &path1)
	PluginPath (const char *path)
	PluginPath (const PluginPath &path)
	~PluginPath (void)
PluginPath &	operator= (const PluginPath &path)
PluginPath	join (const std::string &subPath) const
std::vector< std::string >	listNodes (void) const
std::string	toString (void) const

Detailed Description

Plugin path represents a UNIX-style path for the plugin hierarchy. All paths must be absolute and start with the root slash. Node names must be alphanumeric, underscored, hyphenated. Example of a valid path: /foo_bar/my-module

Constructor & Destructor Documentation

PluginPath() [1/5]

Pothos::PluginPath::PluginPath ( void  )

explicit

Create a PluginPath at the root ("/")

PluginPath() [2/5]

Pothos::PluginPath::PluginPath

(

const std::string &

path

)

Create a PluginPath from a path string. A PluginPathError will be thrown on bad format.

Parameters

path	a plugin path in string representation

PluginPath() [3/5]

Pothos::PluginPath::PluginPath	(	const PluginPath &	path0,
		const PluginPath &	path1
	)

Create a PluginPath by concatenating two paths. The resulting path with be a valid /path0/path1

PluginPath() [4/5]

Pothos::PluginPath::PluginPath

(

const char *

path

)

Create a PluginPath from a path string.

Exceptions

PluginPathError

if bad format.

Parameters

path	a plugin path in string representation

PluginPath() [5/5]

Pothos::PluginPath::PluginPath

(

const PluginPath &

path

)

Copy constructor for PluginPath.

Parameters

path	the PluginPath to copy

~PluginPath()

Pothos::PluginPath::~PluginPath

(

void

)

Destructor for PluginPath.

Member Function Documentation

join()

PluginPath Pothos::PluginPath::join

(

const std::string &

subPath

)

const

Join a subpath with the path in this PluginPath.

Exceptions

PluginPathError

if bad format.

Parameters

subPath

the path to append to the end

Returns

a newly constructed PluginPath

listNodes()

std::vector<std::string> Pothos::PluginPath::listNodes

(

void

)

const

List the nodes that make up the path. Basically, this splits the path at the slashes.

Returns

a vector of strings between each slash

operator=()

PluginPath& Pothos::PluginPath::operator=

(

const PluginPath &

path

)

Assignment operator for PluginPath.

Parameters

path	the PluginPath to assign to this

toString()

std::string Pothos::PluginPath::toString

(

void

)

const

Get the PluginPath as a string representation.

Returns

the path as a string with slashes

---

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

• include/Pothos/Plugin/Path.hpp