Pothos::Proxy Class Reference

#include <Proxy.hpp>

Public Member Functions
	Proxy (void)
	Proxy (const std::shared_ptr< ProxyHandle > &handle)
	Proxy (ProxyHandle *handle)
	operator bool (void) const
std::shared_ptr< ProxyHandle >	getHandle (void) const
	Get the handle held in this proxy object. More...
std::shared_ptr< ProxyEnvironment >	getEnvironment (void) const
template<typename ValueType >
ValueType	convert (void) const
template<typename ValueType >
	operator ValueType (void) const
template<typename ReturnType , typename... ArgsType>
ReturnType	call (const std::string &name, ArgsType &&... args) const
	Call a method with a return type and variable args. More...
template<typename... ArgsType>
Proxy	call (const std::string &name, ArgsType &&... args) const
	Call a method with a Proxy return and variable args. More...
template<typename... ArgsType>
Proxy	callProxy (const std::string &name, ArgsType &&... args) const
template<typename... ArgsType>
void	callVoid (const std::string &name, ArgsType &&... args) const
template<typename ReturnType >
ReturnType	get (const std::string &name) const
	Call a field getter with specified return type. More...
Proxy	get (const std::string &name) const
	Call a field getter with Proxy return type. More...
template<typename ValueType >
void	set (const std::string &name, ValueType &&value) const
	Call a field setter. More...
template<typename... ArgsType>
Proxy	operator() (ArgsType &&... args) const
	Call the function operator() with a Proxy return and variable args. More...
int	compareTo (const Proxy &other) const
size_t	hashCode (void) const
Object	toObject (void) const
std::string	toString (void) const
std::string	getClassName (void) const
bool	operator< (const Proxy &obj) const
	Comparable operator for stl containers. More...
bool	operator> (const Proxy &obj) const
	Comparable operator for stl containers. More...

Detailed Description

The Proxy is a wrapper class for making calls in a ProxyEnvironment. Proxys are created by the Environment and by using Proxy call(). The Proxy methods are simply just templated convenience methods that take any argument type provided and handle the automatic conversions.

Constructor & Destructor Documentation

Proxy() [1/3]

Pothos::Proxy::Proxy

(

void

)

Create a null Proxy.

Proxy() [2/3]

Pothos::Proxy::Proxy

(

const std::shared_ptr< ProxyHandle > &

handle

)

Create a Proxy from a handle. This constructor will typically be called by the implementation.

Parameters

handle

a ProxyHandle shared pointer created by an environment

Proxy() [3/3]

Pothos::Proxy::Proxy

(

ProxyHandle *

handle

)

Create a Proxy from a handle. The Proxy is responsible for deletion of the pointer. This constructor will typically be called by the implementation.

Parameters

handle

a ProxyHandle pointer created by an environment

Member Function Documentation

call() [1/2]

template<typename ReturnType , typename... ArgsType>

ReturnType Pothos::Proxy::call	(	const std::string &	name,
		ArgsType &&...	args
	)		const

Call a method with a return type and variable args.

call() [2/2]

template<typename... ArgsType>

Proxy Pothos::Proxy::call	(	const std::string &	name,
		ArgsType &&...	args
	)		const

Call a method with a Proxy return and variable args.

callProxy()

template<typename... ArgsType>

Proxy Pothos::Proxy::callProxy	(	const std::string &	name,
		ArgsType &&...	args
	)		const

Call a method with a Proxy return and variable args

Deprecated:

use call overload without return type

callVoid()

template<typename... ArgsType>

void Pothos::Proxy::callVoid	(	const std::string &	name,
		ArgsType &&...	args
	)		const

Call a method with a void return and variable args

Deprecated:

use call overload without return type

compareTo()

int Pothos::Proxy::compareTo

(

const Proxy &

other

)

const

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

convert()

template<typename ValueType >

ValueType Pothos::Proxy::convert

(

void

)

const

Convert this proxy to the specified ValueType.

Exceptions

ProxyEnvironmentConvertError

if conversion failed

Returns

the Proxy's value as ValueType

get() [1/2]

template<typename ReturnType >

ReturnType Pothos::Proxy::get

(

const std::string &

name

)

const

Call a field getter with specified return type.

get() [2/2]

Proxy Pothos::Proxy::get

(

const std::string &

name

)

const

Call a field getter with Proxy return type.

getClassName()

std::string Pothos::Proxy::getClassName

(

void

)

const

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()

std::shared_ptr<ProxyEnvironment> Pothos::Proxy::getEnvironment

(

void

)

const

Get the Environment that created this Object's Handle.

getHandle()

std::shared_ptr<ProxyHandle> Pothos::Proxy::getHandle

(

void

)

const

Get the handle held in this proxy object.

hashCode()

size_t Pothos::Proxy::hashCode

(

void

)

const

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

operator bool()

Pothos::Proxy::operator bool ( void  ) const

explicit

Is this Proxy have a handle?

Returns

true if the handle is set.

operator ValueType()

template<typename ValueType >

Pothos::Proxy::operator ValueType

(

void

)

const

Templated conversion operator to assign Proxy to a target type.

Exceptions

ProxyEnvironmentConvertError

if object cannot be converted

operator()()

template<typename... ArgsType>

Proxy Pothos::Proxy::operator()

(

ArgsType &&...

args

)

const

Call the function operator() with a Proxy return and variable args.

operator<()

bool Pothos::Proxy::operator<

(

const Proxy &

obj

)

const

Comparable operator for stl containers.

operator>()

bool Pothos::Proxy::operator>

(

const Proxy &

obj

)

const

Comparable operator for stl containers.

set()

template<typename ValueType >

void Pothos::Proxy::set	(	const std::string &	name,
		ValueType &&	value
	)		const

Call a field setter.

toObject()

Object Pothos::Proxy::toObject

(

void

)

const

Convert this proxy in this environment to a local object.

Exceptions

ProxyEnvironmentConvertError

if conversion failed

Returns

a new Object that contains something in local memory

toString()

std::string Pothos::Proxy::toString

(

void

)

const

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 files:

• include/Pothos/Proxy/Proxy.hpp
• include/Pothos/Proxy/ProxyImpl.hpp