mtsGenericObjectProxy< _elementType > Class Template Reference

#include <mtsGenericObjectProxy.h>

Inheritance diagram for mtsGenericObjectProxy< _elementType >:

Public Types
typedef mtsGenericObjectProxy< _elementType >	ThisType
typedef mtsGenericObjectProxyBase< _elementType >	BaseType
typedef mtsGenericObjectProxyBase< _elementType >::value_type	value_type
typedef mtsGenericObjectProxyBase< _elementType >::DeRefType	DeRefType
typedef mtsGenericObjectProxyBase< _elementType >::RefType	RefType
Public Types inherited from mtsGenericObjectProxyBase< _elementType >
enum	{ HAS_DYNAMIC_CREATION = true }
enum	{ InitialLoD = CMN_LOG_ALLOW_DEFAULT }
typedef mtsGenericObjectProxyBase< _elementType >	ThisType
typedef mtsGenericObject	BaseType
typedef mtsGenericObjectProxy< _elementType >	DeRefType
typedef mtsGenericObjectProxyRef< _elementType >	RefType
typedef _elementType	value_type

Public Member Functions
	mtsGenericObjectProxy (void)
	mtsGenericObjectProxy (const ThisType &other)
	mtsGenericObjectProxy (const value_type &data)
	~mtsGenericObjectProxy (void)
ThisType &	operator= (const ThisType &other)
value_type &	GetData (void) override
const value_type &	GetData (void) const override
ThisType &	operator= (const BaseType &data)
ThisType &	operator= (value_type data)
	operator value_type & (void)
	operator const value_type & (void) const
void	SerializeRaw (std::ostream &outputStream) const override
void	DeSerializeRaw (std::istream &inputStream) override
void	ToStream (std::ostream &outputStream) const override
void	ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const override
bool	FromStreamRaw (std::istream &inputStream, const char delimiter=' ') override
Public Member Functions inherited from mtsGenericObjectProxyBase< _elementType >
virtual const cmnClassServicesBase *	Services (void) const
	mtsGenericObjectProxyBase (void)
	mtsGenericObjectProxyBase (const ThisType &other)
	~mtsGenericObjectProxyBase (void)
ThisType &	operator= (const ThisType &data)
virtual void	Assign (const ThisType &other)
Public Member Functions inherited from mtsGenericObject
	mtsGenericObject (void)
	mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
	mtsGenericObject (const mtsGenericObject &other)
virtual	~mtsGenericObject (void)
mtsGenericObject &	operator= (const mtsGenericObject &other)
bool	SetTimestampIfAutomatic (double timestamp)
size_t	ScalarNumber (void) const
bool	ScalarNumberIsFixed (void) const
Public Member Functions inherited from cmnGenericObject
virtual	~cmnGenericObject (void)
bool	ReconstructFrom (const cmnGenericObject &other)
std::string	ToString (void) const
virtual cmnLogger::StreamBufType *	GetLogMultiplexer (void) const
virtual double	Scalar (const size_t CMN_UNUSED(index)) const CISST_THROW(std
virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Public Attributes
value_type	Data

Additional Inherited Members
Static Public Member Functions inherited from mtsGenericObjectProxyBase< _elementType >
static cmnClassServicesBase *	ClassServices (void)

Member Typedef Documentation

BaseType

template<class _elementType>

typedef mtsGenericObjectProxyBase<_elementType> mtsGenericObjectProxy< _elementType >::BaseType

DeRefType

template<class _elementType>

typedef mtsGenericObjectProxyBase<_elementType>::DeRefType mtsGenericObjectProxy< _elementType >::DeRefType

RefType

template<class _elementType>

typedef mtsGenericObjectProxyBase<_elementType>::RefType mtsGenericObjectProxy< _elementType >::RefType

ThisType

template<class _elementType>

typedef mtsGenericObjectProxy<_elementType> mtsGenericObjectProxy< _elementType >::ThisType

value_type

template<class _elementType>

typedef mtsGenericObjectProxyBase<_elementType>::value_type mtsGenericObjectProxy< _elementType >::value_type

Constructor & Destructor Documentation

mtsGenericObjectProxy() [1/3]

template<class _elementType>

mtsGenericObjectProxy< _elementType >::mtsGenericObjectProxy ( void )

inline

Default constructor. The data member is initialized using its default constructor.

mtsGenericObjectProxy() [2/3]

template<class _elementType>

mtsGenericObjectProxy< _elementType >::mtsGenericObjectProxy ( const ThisType & other )

inline

Copy constructor.

mtsGenericObjectProxy() [3/3]

template<class _elementType>

mtsGenericObjectProxy< _elementType >::mtsGenericObjectProxy ( const value_type & data )

inline

Conversion constructor. This allows to construct the proxy object using an object of the actual type. This method will set the Valid flag to true.

~mtsGenericObjectProxy()

template<class _elementType>

mtsGenericObjectProxy< _elementType >::~mtsGenericObjectProxy ( void )

inline

Member Function Documentation

DeSerializeRaw()

template<class _elementType>

void mtsGenericObjectProxy< _elementType >::DeSerializeRaw ( std::istream & inputStream )

inlineoverridevirtual

DeSerialization. Relies on the specialization, if any, of cmnDeSerializeRaw.

Reimplemented from mtsGenericObject.

FromStreamRaw()

template<class _elementType>

bool mtsGenericObjectProxy< _elementType >::FromStreamRaw ( std::istream & inputStream, const char delimiter = ' ' )

inlineoverridevirtual

From stream raw.

Reimplemented from mtsGenericObject.

GetData() [1/2]

template<class _elementType>

const value_type & mtsGenericObjectProxy< _elementType >::GetData ( void ) const

inlineoverridevirtual

Implements mtsGenericObjectProxyBase< _elementType >.

GetData() [2/2]

template<class _elementType>

value_type & mtsGenericObjectProxy< _elementType >::GetData ( void )

inlineoverridevirtual

Return pointer to data

Implements mtsGenericObjectProxyBase< _elementType >.

operator const value_type &()

template<class _elementType>

mtsGenericObjectProxy< _elementType >::operator const value_type & ( void ) const

inline

operator value_type &()

template<class _elementType>

mtsGenericObjectProxy< _elementType >::operator value_type & ( void )

inline

Cast operator. This allows to assign to an object of the actual type without explicitly referencing the public data member "Data".

operator=() [1/3]

template<class _elementType>

ThisType & mtsGenericObjectProxy< _elementType >::operator= ( const BaseType & data )

inline

Conversion assignment, from base type (i.e., Proxy or ProxyRef) to Proxy.

operator=() [2/3]

template<class _elementType>

ThisType & mtsGenericObjectProxy< _elementType >::operator= ( const ThisType & other )

inline

Assignment operator

operator=() [3/3]

template<class _elementType>

ThisType & mtsGenericObjectProxy< _elementType >::operator= ( value_type data )

inline

Conversion assignment. This allows to assign from an object of the actual type without explicitly referencing the public data member "Data".

SerializeRaw()

template<class _elementType>

void mtsGenericObjectProxy< _elementType >::SerializeRaw ( std::ostream & outputStream ) const

inlineoverridevirtual

Serialization. Relies on the specialization, if any, of cmnSerializeRaw.

Reimplemented from mtsGenericObject.

ToStream()

template<class _elementType>

void mtsGenericObjectProxy< _elementType >::ToStream ( std::ostream & outputStream ) const

inlineoverridevirtual

To stream method. Uses the default << operator as defined for the actual type.

Reimplemented from mtsGenericObject.

ToStreamRaw()

template<class _elementType>

void mtsGenericObjectProxy< _elementType >::ToStreamRaw ( std::ostream & outputStream, const char delimiter = ' ', bool headerOnly = false, const std::string & headerPrefix = "" ) const

inlineoverridevirtual

To stream raw data.

Reimplemented from mtsGenericObject.

Member Data Documentation

Data

template<class _elementType>

value_type mtsGenericObjectProxy< _elementType >::Data

---

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

• tmp/cisst-saw/cisst/cisstMultiTask/mtsGenericObjectProxy.h