The RemoteHandle class wrapps a ClientSideRemoteHandleControlBlock and can be used just as a Ice proxy. More...

#include <ArmarXCore/core/util/distributed/RemoteHandle/RemoteHandle.h>

Public Member Functions
template<class TargetPrxType >
RemoteHandle< TargetPrxType >	checkedCast () const

PrxType	get ()

const PrxType	get () const

const IceInternal::Handle< const ClientSideRemoteHandleControlBlockBase >	getclientSideControlBlock () const

	operator bool () const

PrxType	operator* ()

const PrxType	operator* () const

PrxType	operator-> ()

const PrxType	operator-> () const

RemoteHandle< PrxType > &	operator= (const ClientSideRemoteHandleControlBlockBasePtr &controlBlock)

RemoteHandle< PrxType > &	operator= (const RemoteHandle< PrxType > &other)=default

template<class PrxTypeB >
RemoteHandle< PrxType > &	operator= (const RemoteHandle< PrxTypeB > &other)

RemoteHandle< PrxType > &	operator= (RemoteHandle< PrxType > &&other)=default

RemoteHandle< PrxType > &	operator= (std::nullptr_t)

	RemoteHandle ()=default

	RemoteHandle (const ClientSideRemoteHandleControlBlockBasePtr &controlBlock)

	RemoteHandle (const RemoteHandle &other)=default

template<class PrxTypeB >
	RemoteHandle (const RemoteHandle< PrxTypeB > &other)

	RemoteHandle (RemoteHandle &&other)=default

	RemoteHandle (std::nullptr_t)

template<class TargetPrxType >
RemoteHandle< TargetPrxType >	uncheckedCast () const

	~RemoteHandle ()=default

Static Public Member Functions
template<class SourceType >
static RemoteHandle< PrxType >	checkedCast (const SourceType &proxyToCast)

template<class SourceType >
static RemoteHandle< PrxType >	uncheckedCast (const SourceType &proxyToCast)

Friends
template<class PrxTA >
class	armarx::RemoteHandle

template<class PrxTA , class PrxTB >
bool	operator!= (const RemoteHandle< PrxTA > &fst, const RemoteHandle< PrxTB > &snd)

template<class PrxTA , class PrxTB >
bool	operator< (const RemoteHandle< PrxTA > &fst, const RemoteHandle< PrxTB > &snd)

template<class PrxTA , class PrxTB >
bool	operator<= (const RemoteHandle< PrxTA > &fst, const RemoteHandle< PrxTB > &snd)

template<class PrxTA , class PrxTB >
bool	operator== (const RemoteHandle< PrxTA > &fst, const RemoteHandle< PrxTB > &snd)

template<class PrxTA , class PrxTB >
bool	operator> (const RemoteHandle< PrxTA > &fst, const RemoteHandle< PrxTB > &snd)

template<class PrxTA , class PrxTB >
bool	operator>= (const RemoteHandle< PrxTA > &fst, const RemoteHandle< PrxTB > &snd)

Detailed Description

template<class PrxType>
class armarx::RemoteHandle< PrxType >

The RemoteHandle class wrapps a ClientSideRemoteHandleControlBlock and can be used just as a Ice proxy.

It can be copied, casted, assigned, compared and dereferenced. (for more info: RemoteHandle tutorial)

Definition at line 45 of file RemoteHandle.h.

Constructor & Destructor Documentation

◆ RemoteHandle() [1/6]

RemoteHandle ( )

default

◆ RemoteHandle() [2/6]

RemoteHandle ( const RemoteHandle< PrxType > & other )

default

◆ RemoteHandle() [3/6]

RemoteHandle ( RemoteHandle< PrxType > && other )

default

◆ RemoteHandle() [4/6]

RemoteHandle ( const ClientSideRemoteHandleControlBlockBasePtr & controlBlock )

Definition at line 108 of file RemoteHandle.h.

◆ RemoteHandle() [5/6]

RemoteHandle ( std::nullptr_t )

Definition at line 144 of file RemoteHandle.h.

◆ RemoteHandle() [6/6]

RemoteHandle ( const RemoteHandle< PrxTypeB > & other )

Definition at line 116 of file RemoteHandle.h.

◆ ~RemoteHandle()

~RemoteHandle ( )

default

Member Function Documentation

◆ checkedCast() [1/2]

RemoteHandle< TargetPrxType > checkedCast

inline

Definition at line 171 of file RemoteHandle.h.

◆ checkedCast() [2/2]

RemoteHandle< PrxType > checkedCast ( const SourceType & proxyToCast )

inlinestatic

Definition at line 154 of file RemoteHandle.h.

◆ get() [1/2]

const PrxType get

inline

Definition at line 196 of file RemoteHandle.h.

◆ get() [2/2]

const PrxType get ( ) const

inline

◆ getclientSideControlBlock()

const IceInternal::Handle< const ClientSideRemoteHandleControlBlockBase > getclientSideControlBlock

inline

Returns: Returns the internal ClientSideRemoteHandleControlBlock. This should only be used when it has to be send per ice.

Definition at line 211 of file RemoteHandle.h.

◆ operator bool()

operator bool

inlineexplicit

Definition at line 205 of file RemoteHandle.h.

◆ operator*() [1/2]

const PrxType operator*

inline

Definition at line 180 of file RemoteHandle.h.

◆ operator*() [2/2]

const PrxType operator* ( ) const

inline

◆ operator->() [1/2]

const PrxType operator->

inline

Definition at line 188 of file RemoteHandle.h.

◆ operator->() [2/2]

const PrxType operator-> ( ) const

inline

◆ operator=() [1/5]

RemoteHandle< PrxType > & operator= ( const ClientSideRemoteHandleControlBlockBasePtr & controlBlock )

inline

Definition at line 121 of file RemoteHandle.h.

◆ operator=() [2/5]

RemoteHandle<PrxType>& operator= ( const RemoteHandle< PrxType > & other )

inlinedefault

◆ operator=() [3/5]

RemoteHandle< PrxType > & operator= ( const RemoteHandle< PrxTypeB > & other )

inline

Definition at line 137 of file RemoteHandle.h.

◆ operator=() [4/5]

RemoteHandle<PrxType>& operator= ( RemoteHandle< PrxType > && other )

inlinedefault

◆ operator=() [5/5]

RemoteHandle< PrxType > & operator= ( std::nullptr_t )

inline

Definition at line 129 of file RemoteHandle.h.

◆ uncheckedCast() [1/2]

RemoteHandle< TargetPrxType > uncheckedCast

inline

Definition at line 161 of file RemoteHandle.h.

◆ uncheckedCast() [2/2]

RemoteHandle< PrxType > uncheckedCast ( const SourceType & proxyToCast )

inlinestatic

Definition at line 147 of file RemoteHandle.h.

Friends And Related Function Documentation

◆ armarx::RemoteHandle

friend class armarx::RemoteHandle

friend

Definition at line 101 of file RemoteHandle.h.

◆ operator!=

bool operator!=	(	const RemoteHandle< PrxTA > &	fst,
		const RemoteHandle< PrxTB > &	snd
	)

friend

Definition at line 220 of file RemoteHandle.h.

◆ operator<

bool operator<	(	const RemoteHandle< PrxTA > &	fst,
		const RemoteHandle< PrxTB > &	snd
	)

friend

Definition at line 224 of file RemoteHandle.h.

◆ operator<=

bool operator<=	(	const RemoteHandle< PrxTA > &	fst,
		const RemoteHandle< PrxTB > &	snd
	)

friend

Definition at line 228 of file RemoteHandle.h.

◆ operator==

bool operator==	(	const RemoteHandle< PrxTA > &	fst,
		const RemoteHandle< PrxTB > &	snd
	)

friend

Definition at line 216 of file RemoteHandle.h.

◆ operator>

bool operator>	(	const RemoteHandle< PrxTA > &	fst,
		const RemoteHandle< PrxTB > &	snd
	)

friend

Definition at line 232 of file RemoteHandle.h.

◆ operator>=

bool operator>=	(	const RemoteHandle< PrxTA > &	fst,
		const RemoteHandle< PrxTB > &	snd
	)

friend

Definition at line 236 of file RemoteHandle.h.

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

ArmarXCore/core/util/distributed/RemoteHandle/RemoteHandle.h

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

template<class PrxType> class armarx::RemoteHandle< PrxType >

Constructor & Destructor Documentation

◆ RemoteHandle() [1/6]

◆ RemoteHandle() [2/6]

◆ RemoteHandle() [3/6]

◆ RemoteHandle() [4/6]

◆ RemoteHandle() [5/6]

◆ RemoteHandle() [6/6]

◆ ~RemoteHandle()

Member Function Documentation

◆ checkedCast() [1/2]

◆ checkedCast() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ getclientSideControlBlock()

◆ operator bool()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ uncheckedCast() [1/2]

◆ uncheckedCast() [2/2]

Friends And Related Function Documentation

◆ armarx::RemoteHandle

◆ operator!=

◆ operator<

◆ operator<=

◆ operator==

◆ operator>

◆ operator>=

template<class PrxType>
class armarx::RemoteHandle< PrxType >