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 46 of file RemoteHandle.h.

Constructor & Destructor Documentation

◆ RemoteHandle() [1/6]

template<class PrxType>

RemoteHandle ( )

default

◆ RemoteHandle() [2/6]

template<class PrxType>

RemoteHandle ( const RemoteHandle< PrxType > & other )

default

◆ RemoteHandle() [3/6]

template<class PrxType>

RemoteHandle ( RemoteHandle< PrxType > && other )

default

◆ RemoteHandle() [4/6]

template<class PrxType>

RemoteHandle ( const ClientSideRemoteHandleControlBlockBasePtr & controlBlock )

Definition at line 124 of file RemoteHandle.h.

Here is the call graph for this function:

◆ RemoteHandle() [5/6]

template<class PrxType>

RemoteHandle ( std::nullptr_t )

Definition at line 169 of file RemoteHandle.h.

Here is the call graph for this function:

◆ RemoteHandle() [6/6]

template<class PrxType>

template<class PrxTypeB>

RemoteHandle ( const RemoteHandle< PrxTypeB > & other )

Definition at line 135 of file RemoteHandle.h.

Here is the call graph for this function:

◆ ~RemoteHandle()

template<class PrxType>

~RemoteHandle ( )

default

Member Function Documentation

◆ checkedCast() [1/2]

template<class PrxType>

template<class TargetPrxType>

RemoteHandle< TargetPrxType > checkedCast ( ) const

inline

Definition at line 212 of file RemoteHandle.h.

Here is the call graph for this function:

◆ checkedCast() [2/2]

template<class PrxType>

template<class SourceType>

RemoteHandle< PrxType > checkedCast ( const SourceType & proxyToCast )

inlinestatic

Definition at line 187 of file RemoteHandle.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get() [1/2]

template<class PrxType>

PrxType get ( )

inline

Definition at line 253 of file RemoteHandle.h.

◆ get() [2/2]

template<class PrxType>

const PrxType get ( ) const

inline

Definition at line 260 of file RemoteHandle.h.

◆ getclientSideControlBlock()

template<class PrxType>

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

inline

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

Definition at line 273 of file RemoteHandle.h.

◆ operator bool()

template<class PrxType>

operator bool ( ) const

inlineexplicit

Definition at line 266 of file RemoteHandle.h.

Here is the call graph for this function:

◆ operator*() [1/2]

template<class PrxType>

PrxType operator* ( )

inline

Definition at line 225 of file RemoteHandle.h.

◆ operator*() [2/2]

template<class PrxType>

const PrxType operator* ( ) const

inline

Definition at line 232 of file RemoteHandle.h.

◆ operator->() [1/2]

template<class PrxType>

PrxType operator-> ( )

inline

Definition at line 239 of file RemoteHandle.h.

◆ operator->() [2/2]

template<class PrxType>

const PrxType operator-> ( ) const

inline

Definition at line 246 of file RemoteHandle.h.

◆ operator=() [1/5]

template<class PrxType>

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

inline

Definition at line 142 of file RemoteHandle.h.

◆ operator=() [2/5]

template<class PrxType>

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

inlinedefault

◆ operator=() [3/5]

template<class PrxType>

template<class PrxTypeB>

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

inline

Definition at line 162 of file RemoteHandle.h.

Here is the call graph for this function:

◆ operator=() [4/5]

template<class PrxType>

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

inlinedefault

◆ operator=() [5/5]

template<class PrxType>

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

inline

Definition at line 152 of file RemoteHandle.h.

◆ uncheckedCast() [1/2]

template<class PrxType>

template<class TargetPrxType>

RemoteHandle< TargetPrxType > uncheckedCast ( ) const

inline

Definition at line 198 of file RemoteHandle.h.

Here is the call graph for this function:

◆ uncheckedCast() [2/2]

template<class PrxType>

template<class SourceType>

RemoteHandle< PrxType > uncheckedCast ( const SourceType & proxyToCast )

inlinestatic

Definition at line 176 of file RemoteHandle.h.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ armarx::RemoteHandle

template<class PrxType>

template<class PrxTA>

friend class armarx::RemoteHandle

friend

Definition at line 117 of file RemoteHandle.h.

◆ operator!=

template<class PrxType>

template<class PrxTA, class PrxTB>

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

friend

Definition at line 288 of file RemoteHandle.h.

◆ operator<

template<class PrxType>

template<class PrxTA, class PrxTB>

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

friend

Definition at line 295 of file RemoteHandle.h.

◆ operator<=

template<class PrxType>

template<class PrxTA, class PrxTB>

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

friend

Definition at line 303 of file RemoteHandle.h.

◆ operator==

template<class PrxType>

template<class PrxTA, class PrxTB>

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

friend

Definition at line 280 of file RemoteHandle.h.

◆ operator>

template<class PrxType>

template<class PrxTA, class PrxTB>

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

friend

Definition at line 312 of file RemoteHandle.h.

◆ operator>=

template<class PrxType>

template<class PrxTA, class PrxTB>

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

friend

Definition at line 320 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

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 Symbol Documentation

◆ armarx::RemoteHandle

◆ operator!=

◆ operator<

◆ operator<=

◆ operator==

◆ operator>

◆ operator>=