ChannelRef Class Reference

The ChannelRef class is a reference to a channel on an Observer. More...

#include <ArmarXCore/observers/variant/ChannelRef.h>

Inheritance diagram for ChannelRef:

Public Member Functions
	ChannelRef (Observer *observer, std::string channelName)
	ChannelRef (ObserverInterfacePrx observerPrx, std::string channelName)
VariantDataClassPtr	clone (const Ice::Current &c=Ice::emptyCurrent) const override
void	deserialize (const ObjectSerializerBasePtr &serializer, const ::Ice::Current &=Ice::emptyCurrent) override
template<typename T>
std::enable_if_t< std::is_base_of_v< VariantDataClass, T >, IceInternal::Handle< T > >	get (const std::string &key)
template<typename T>
std::enable_if_t<!std::is_base_of_v< VariantDataClass, T >, T >	get (const std::string &key)
const std::string &	getChannelName () const
TimedVariantPtr	getDataField (const std::string &datafieldName)
DataFieldIdentifierPtr	getDataFieldIdentifier (const std::string &datafieldName)
const Ice::StringSeq &	getDataFieldNames () const
bool	getInitialized ()
const std::string &	getObserverName () const
const ObserverInterfacePrx &	getObserverProxy ()
VariantTypeId	getType (const Ice::Current &c=Ice::emptyCurrent) const override
bool	hasDatafield (const std::string &datafieldName) const
Ice::ObjectPtr	ice_clone () const override
void	ice_postUnmarshal () override
std::string	output (const Ice::Current &c=Ice::emptyCurrent) const override
void	refetchChannel ()
void	serialize (const ObjectSerializerBasePtr &serializer, const ::Ice::Current &=Ice::emptyCurrent) const override
bool	validate (const Ice::Current &c=Ice::emptyCurrent) override
	~ChannelRef () override

Protected Member Functions
	ChannelRef ()

Friends
template<class BaseClass, class VariantClass>
class	GenericFactory
std::ostream &	operator<< (std::ostream &stream, const ChannelRef &rhs)
	stream operator for DataFieldIdentifier
std::ostream &	operator<< (std::ostream &stream, const ChannelRefPtr &rhs)
	stream operator for Ice shared pointer of DataFieldIdentifier

Detailed Description

The ChannelRef class is a reference to a channel on an Observer.

It is used to access data directly from a channel or to be passed to function as an identifier for a channel.

Constructor & Destructor Documentation

ChannelRef() [1/3]

ChannelRef ( )

inlineprotected

ChannelRef() [2/3]

ChannelRef	(	Observer *	observer,
		std::string	channelName )

ChannelRef() [3/3]

ChannelRef	(	ObserverInterfacePrx	observerPrx,
		std::string	channelName )

~ChannelRef()

~ChannelRef ( )

inlineoverride

Member Function Documentation

clone()

VariantDataClassPtr clone ( const Ice::Current & c = Ice::emptyCurrent ) const

override

deserialize()

void deserialize ( const ObjectSerializerBasePtr & serializer, const ::Ice::Current & c = Ice::emptyCurrent )

override

get() [1/2]

template<typename T>

std::enable_if_t< std::is_base_of_v< VariantDataClass, T >, IceInternal::Handle< T > > get ( const std::string & key )

inline

get() [2/2]

template<typename T>

std::enable_if_t<!std::is_base_of_v< VariantDataClass, T >, T > get ( const std::string & key )

inline

getChannelName()

const std::string & getChannelName

(

)

const

getDataField()

TimedVariantPtr getDataField

(

const std::string &

datafieldName

)

getDataFieldIdentifier()

DataFieldIdentifierPtr getDataFieldIdentifier

(

const std::string &

datafieldName

)

getDataFieldNames()

const Ice::StringSeq & getDataFieldNames

(

)

const

getInitialized()

bool getInitialized

(

)

getObserverName()

const std::string & getObserverName

(

)

const

getObserverProxy()

const ObserverInterfacePrx & getObserverProxy

(

)

getType()

VariantTypeId getType ( const Ice::Current & c = Ice::emptyCurrent ) const

override

hasDatafield()

bool hasDatafield

(

const std::string &

datafieldName

)

const

ice_clone()

Ice::ObjectPtr ice_clone ( ) const

inlineoverride

ice_postUnmarshal()

void ice_postUnmarshal ( )

override

output()

std::string output ( const Ice::Current & c = Ice::emptyCurrent ) const

override

refetchChannel()

void refetchChannel

(

)

serialize()

void serialize ( const ObjectSerializerBasePtr & serializer, const ::Ice::Current & = Ice::emptyCurrent ) const

override

validate()

bool validate ( const Ice::Current & c = Ice::emptyCurrent )

override

Friends And Related Symbol Documentation

GenericFactory

template<class BaseClass, class VariantClass>

friend class GenericFactory

friend

operator<< [1/2]

std::ostream & operator<< ( std::ostream & stream, const ChannelRef & rhs )

friend

stream operator for DataFieldIdentifier

operator<< [2/2]

std::ostream & operator<< ( std::ostream & stream, const ChannelRefPtr & rhs )

friend

stream operator for Ice shared pointer of DataFieldIdentifier

---

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

• ArmarXCore/observers/variant/ChannelRef.h
• ArmarXCore/observers/variant/ChannelRef.cpp