Pothos  0.4.1-gb758ed46
The Pothos dataflow programming software suite
Public Member Functions | List of all members
Pothos::ProxyHandle Class Referenceabstract

#include <Handle.hpp>

Public Member Functions

virtual ~ProxyHandle (void)
 
virtual std::shared_ptr< ProxyEnvironmentgetEnvironment (void) const =0
 
virtual Proxy call (const std::string &name, const Proxy *args, const size_t numArgs)=0
 
virtual int compareTo (const Proxy &other) const =0
 
virtual size_t hashCode (void) const =0
 
virtual std::string toString (void) const =0
 
virtual std::string getClassName (void) const =0
 

Detailed Description

The ProxyHandle is a pure interface class for creating ProxyObjects. The templated calls from ProxyObject are convenience methods that ultimately call into the ProxyHandle's call() method. A ProxyHandle knows how to make proxy calls given arguments, and then how to fetch and convert the return result from the call.

Constructor & Destructor Documentation

virtual Pothos::ProxyHandle::~ProxyHandle ( void  )
virtual

Virtual destructor for subclassing.

Member Function Documentation

virtual Proxy Pothos::ProxyHandle::call ( const std::string &  name,
const Proxy args,
const size_t  numArgs 
)
pure virtual

Make a call on this handle given method name and args.

Argument note: If one of the argument Proxy Objects is not in this environment, it will be converted to a local Object and back into a ProxyObject of the correct environment using the Environment convert calls.

Exceptions
ProxyHandleCallErrorif the call fails for some reason
Parameters
namethe name of the method
argsan array of Proxy object arguments
numArgsthe number of arguments in the array
Returns
a Proxy representing the result of the call
virtual int Pothos::ProxyHandle::compareTo ( const Proxy other) const
pure virtual

Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Exceptions
ProxyCompareErrorwhen the compare isnt possible
Parameters
otherthe other proxy object to compare against
Returns
an int representing less than, equal to, or greater than
virtual std::string Pothos::ProxyHandle::getClassName ( void  ) const
pure virtual

Get the class name of the underlying object. The class name should be a unique identifier for objects of the same type as the one contained. This name is used to help convert proxies to local objects.

virtual std::shared_ptr<ProxyEnvironment> Pothos::ProxyHandle::getEnvironment ( void  ) const
pure virtual

Get the Environment that created this Handle.

virtual size_t Pothos::ProxyHandle::hashCode ( void  ) const
pure virtual

Get a hash code for the underlying object. The hash code should be identical for equivalent objects.

virtual std::string Pothos::ProxyHandle::toString ( void  ) const
pure virtual

Get the string representation of the Proxy. The format of the string is highly specific, depending upon the underlying object.


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