#include <Handle.hpp>
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.
◆ ~ProxyHandle()
| virtual Pothos::ProxyHandle::~ProxyHandle |
( |
void |
| ) |
|
|
virtual |
Virtual destructor for subclassing.
◆ call()
| 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
-
| ProxyHandleCallError | if the call fails for some reason |
- Parameters
-
| name | the name of the method |
| args | an array of Proxy object arguments |
| numArgs | the number of arguments in the array |
- Returns
- a Proxy representing the result of the call
◆ compareTo()
| 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
-
| ProxyCompareError | when the compare isnt possible |
- Parameters
-
| other | the other proxy object to compare against |
- Returns
- an int representing less than, equal to, or greater than
◆ getClassName()
| 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.
◆ getEnvironment()
| virtual std::shared_ptr<ProxyEnvironment> Pothos::ProxyHandle::getEnvironment |
( |
void |
| ) |
const |
|
pure virtual |
Get the Environment that created this Handle.
◆ hashCode()
| 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.
◆ toString()
| 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:
1.8.13