Pothos  0.4.0-gd11861cd
The Pothos dataflow programming software suite
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros Pages
Public Member Functions | List of all members
Pothos::PluginPath Class Reference

#include <Path.hpp>

Public Member Functions

 PluginPath (void)
 
 PluginPath (const std::string &path)
 
 PluginPath (const char *path)
 
 PluginPath (const PluginPath &path)
 
 ~PluginPath (void)
 
PluginPathoperator= (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

Pothos::PluginPath::PluginPath ( void  )
explicit

Create a PluginPath at the root ("/")

Pothos::PluginPath::PluginPath ( const std::string &  path)

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

Parameters
patha plugin path in string representation
Pothos::PluginPath::PluginPath ( const char *  path)

Create a PluginPath from a path string.

Exceptions
PluginPathErrorif bad format.
Parameters
patha plugin path in string representation
Pothos::PluginPath::PluginPath ( const PluginPath path)

Copy constructor for PluginPath.

Parameters
paththe PluginPath to copy
Pothos::PluginPath::~PluginPath ( void  )

Destructor for PluginPath.

Member Function Documentation

PluginPath Pothos::PluginPath::join ( const std::string &  subPath) const

Join a subpath with the path in this PluginPath.

Exceptions
PluginPathErrorif bad format.
Parameters
subPaththe path to append to the end
Returns
a newly constructed PluginPath
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
PluginPath& Pothos::PluginPath::operator= ( const PluginPath path)

Assignment operator for PluginPath.

Parameters
paththe PluginPath to assign to this
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: