Pothos  0.4.1-gb758ed46
The Pothos dataflow programming software suite
Namespaces | Classes | Typedefs | Functions
Pothos Namespace Reference

Namespaces

 serialization
 
 System
 
 Util
 

Classes

class  ApplicationException
 
class  AssertionViolationException
 
class  BadCastException
 
class  Block
 
class  BlockRegistry
 
class  BufferAccumulator
 
class  BufferChunk
 
class  BufferManager
 
struct  BufferManagerArgs
 
class  BufferPool
 
class  BugcheckException
 
class  Callable
 
class  CallInterface
 
class  CallRegistry
 
class  CircularReferenceException
 
class  Connectable
 
class  CreateFileException
 
class  DataException
 
class  DataFormatException
 
class  DType
 
class  Exception
 
class  ExistsException
 
class  FileAccessDeniedException
 
class  FileException
 
class  FileExistsException
 
class  FileNotFoundException
 
class  FileReadOnlyException
 
class  IllegalStateException
 
class  InputPort
 
class  InvalidAccessException
 
class  InvalidArgumentException
 
class  IOException
 
class  Label
 
class  LabelIteratorRange
 
class  LibraryAlreadyLoadedException
 
class  LibraryLoadException
 
class  LogicException
 
class  ManagedBuffer
 
class  ManagedClass
 
class  NoPermissionException
 
class  NotFoundException
 
class  NoThreadAvailableException
 
class  NotImplementedException
 
class  NullObject
 
class  NullPointerException
 
class  NullValueException
 
class  Object
 
class  ObjectM
 
class  OpenFileException
 
class  OutOfMemoryException
 
class  OutputPort
 
struct  Packet
 
class  PathNotFoundException
 
class  PathSyntaxException
 
class  Plugin
 
class  PluginLoader
 
class  PluginModule
 
class  PluginPath
 
class  PluginRegistry
 
struct  PluginRegistryInfoDump
 
class  PoolOverflowException
 
class  PortInfo
 Information about an IO port. More...
 
class  PropertyNotSupportedException
 
class  ProtocolException
 
class  Proxy
 
class  ProxyEnvironment
 
class  ProxyHandle
 
class  RangeException
 
class  ReadFileException
 
class  RegularExpressionException
 
class  RemoteClient
 
class  RemoteHandler
 
class  RemoteServer
 
class  RuntimeException
 
class  ScopedInit
 
class  SharedBuffer
 
class  SignalException
 
class  SyntaxException
 
class  SystemException
 
struct  TestingBase
 
class  ThreadPool
 
class  ThreadPoolArgs
 
class  TimeoutException
 
class  Topology
 
class  UnhandledException
 
class  UnknownURISchemeException
 
struct  WorkInfo
 
class  WriteFileException
 

Typedefs

typedef std::map< std::string, std::string > ProxyEnvironmentArgs
 
typedef std::pair< std::string, Pothos::CallableProxyConvertPair
 
typedef std::vector< ProxyProxyVector
 
typedef std::set< ProxyProxySet
 
typedef std::map< Proxy, ProxyProxyMap
 
typedef std::vector< ObjectObjectVector
 
typedef std::set< ObjectObjectSet
 
typedef std::map< Object, ObjectObjectMap
 
typedef std::map< std::string, ObjectObjectKwargs
 

Functions

 POTHOS_DECLARE_EXCEPTION (POTHOS_API, ManagedClassLookupError, RuntimeException)
 
 POTHOS_DECLARE_EXCEPTION (POTHOS_API, ManagedClassTypeError, RuntimeException)
 
 POTHOS_DECLARE_EXCEPTION (POTHOS_API, ManagedClassNameError, RuntimeException)
 
bool operator== (const ManagedBuffer &lhs, const ManagedBuffer &rhs)
 
bool operator== (const BufferChunk &lhs, const BufferChunk &rhs)
 
POTHOS_API bool operator== (const ThreadPool &lhs, const ThreadPool &rhs)
 Are these two thread pools the same? More...
 
POTHOS_API bool operator== (const DType &lhs, const DType &rhs)
 Equality operator for DType (all attributes must match for equality) More...
 
bool operator== (const Label &rhs, const Label &lhs)
 Are these two labels equivalent? all fields must be equal. More...
 
bool operator== (const SharedBuffer &lhs, const SharedBuffer &rhs)
 
POTHOS_API bool operator== (const Callable &lhs, const Callable &rhs)
 
POTHOS_API void init (void)
 
POTHOS_API void deinit (void)
 
 POTHOS_DECLARE_EXCEPTION (POTHOS_API, ProxyEnvironmentFactoryError, RuntimeException)
 
 POTHOS_DECLARE_EXCEPTION (POTHOS_API, ProxyEnvironmentFindError, RuntimeException)
 
 POTHOS_DECLARE_EXCEPTION (POTHOS_API, ProxyEnvironmentConvertError, RuntimeException)
 
 POTHOS_DECLARE_EXCEPTION (POTHOS_API, ProxyHandleCallError, RuntimeException)
 
 POTHOS_DECLARE_EXCEPTION (POTHOS_API, ProxyExceptionMessage, RuntimeException)
 
 POTHOS_DECLARE_EXCEPTION (POTHOS_API, ProxyCompareError, RuntimeException)
 
 POTHOS_DECLARE_EXCEPTION (POTHOS_API, ProxySerializeError, RuntimeException)
 
POTHOS_API bool operator== (const Proxy &lhs, const Proxy &rhs)
 
 POTHOS_DECLARE_EXCEPTION (POTHOS_API, ObjectConvertError, RuntimeException)
 
bool operator== (const Object &lhs, const Object &rhs)
 
POTHOS_API bool operator== (const PluginPath &lhs, const PluginPath &rhs)
 

Typedef Documentation

typedef std::map<std::string, Object> Pothos::ObjectKwargs
typedef std::map<Object, Object> Pothos::ObjectMap
typedef std::set<Object> Pothos::ObjectSet
typedef std::vector<Object> Pothos::ObjectVector
typedef std::pair<std::string, Pothos::Callable> Pothos::ProxyConvertPair

ProxyConvertPair typedef used in proxy -> local plugin registrations

typedef std::map<std::string, std::string> Pothos::ProxyEnvironmentArgs
typedef std::map<Proxy, Proxy> Pothos::ProxyMap
typedef std::set<Proxy> Pothos::ProxySet
typedef std::vector<Proxy> Pothos::ProxyVector

Function Documentation

POTHOS_API void Pothos::deinit ( void  )

Perform cleanup routines before application exit. The deinit() call unloads plugin modules loaded by init() Match any calls to init() with to deinit() before application exit.

POTHOS_API void Pothos::init ( void  )

Perform initialization routines. This call will check the integrity of the installation. This looks for the root directory, the runtime library, permissions on user configuration and data directories. Also, the runtime modules will be loaded into the system. This call will throw if any of the above fails. Subsequent calls to init() are safe and result in NOP.

bool Pothos::operator== ( const Label rhs,
const Label lhs 
)
inline

Are these two labels equivalent? all fields must be equal.

POTHOS_API bool Pothos::operator== ( const PluginPath lhs,
const PluginPath rhs 
)

Compare two plugin paths for equality.

Returns
true if the paths are identical
bool Pothos::operator== ( const SharedBuffer lhs,
const SharedBuffer rhs 
)
inline

Equality operator for SharedBuffer. True when the containers are identical.

bool Pothos::operator== ( const ManagedBuffer lhs,
const ManagedBuffer rhs 
)
inline

Equality operator for ManagedBuffer. True when the containers are identical.

POTHOS_API bool Pothos::operator== ( const ThreadPool lhs,
const ThreadPool rhs 
)

Are these two thread pools the same?

POTHOS_API bool Pothos::operator== ( const Proxy lhs,
const Proxy rhs 
)

The equals operators checks if two Proxies represent the same memory. Use myProxy.compareTo(other) == 0 for an equality comparison.

Parameters
lhsthe left hand object of the comparison
rhsthe right hand object of the comparison
Returns
true if the objects represent the same internal data
bool Pothos::operator== ( const DType lhs,
const DType rhs 
)
inline

Equality operator for DType (all attributes must match for equality)

POTHOS_API bool Pothos::operator== ( const Callable lhs,
const Callable rhs 
)

The equals operators checks if two Callable represent the same internal data. The actual bound functions/methods cannot be checked for equality. Two callables are only equal if they originated from the same construction.

Parameters
lhsthe left hand object of the comparison
rhsthe right hand object of the comparison
Returns
true if the objects represent the same internal data
bool Pothos::operator== ( const BufferChunk lhs,
const BufferChunk rhs 
)
inline

Equality operator for BufferChunk objects. True when the address, length, and underlying buffer are the same.

bool Pothos::operator== ( const Object lhs,
const Object rhs 
)
inline

The equals operators checks if two Objects represent the same memory. Use myObject.compareTo(other) == 0 for an equality comparison.

Parameters
lhsthe left hand object of the comparison
rhsthe right hand object of the comparison
Returns
true if the objects represent the same internal data
Pothos::POTHOS_DECLARE_EXCEPTION ( POTHOS_API  ,
ManagedClassLookupError  ,
RuntimeException   
)

A ManagedClassLookupError is thrown when the lookup call fails.

Pothos::POTHOS_DECLARE_EXCEPTION ( POTHOS_API  ,
ObjectConvertError  ,
RuntimeException   
)

An ObjectConvertError is thrown when an object is converted to the wrong type.

Pothos::POTHOS_DECLARE_EXCEPTION ( POTHOS_API  ,
ProxyEnvironmentFactoryError  ,
RuntimeException   
)

A ProxyEnvironmentFactoryError is thrown when a factory function fails.

Pothos::POTHOS_DECLARE_EXCEPTION ( POTHOS_API  ,
ManagedClassTypeError  ,
RuntimeException   
)

A ManagedClassTypeError is thrown when a registration type mismatches fails.

Pothos::POTHOS_DECLARE_EXCEPTION ( POTHOS_API  ,
ProxyEnvironmentFindError  ,
RuntimeException   
)

A ProxyEnvironmentFindError is thrown when a find method fails.

Pothos::POTHOS_DECLARE_EXCEPTION ( POTHOS_API  ,
ManagedClassNameError  ,
RuntimeException   
)

A ManagedClassNameError is thrown when a method name does not exist.

Pothos::POTHOS_DECLARE_EXCEPTION ( POTHOS_API  ,
ProxyEnvironmentConvertError  ,
RuntimeException   
)

A ProxyEnvironmentConvertError is thrown when a convert method fails.

Pothos::POTHOS_DECLARE_EXCEPTION ( POTHOS_API  ,
ProxyHandleCallError  ,
RuntimeException   
)

A ProxyHandleCallError is thrown when a call operation fails.

Pothos::POTHOS_DECLARE_EXCEPTION ( POTHOS_API  ,
ProxyExceptionMessage  ,
RuntimeException   
)

A ProxyExceptionMessage is thrown when the call itself has an exception. The exception usually comes from the proxy environment. The message from the exception will be passed through this exception, and retrieved with the what() method.

Pothos::POTHOS_DECLARE_EXCEPTION ( POTHOS_API  ,
ProxyCompareError  ,
RuntimeException   
)

A ProxyCompareError is thrown when compareTo fails.

Pothos::POTHOS_DECLARE_EXCEPTION ( POTHOS_API  ,
ProxySerializeError  ,
RuntimeException   
)

A ProxySerializeError is thrown when de/serialize fails.