STK::Proxy< Type > Class Template Reference

The Proxy class allow to surdefine operators and methods for every kind of class without using dynamic_cast. More...

#include <STK_Proxy.h>

Public Member Functions
template<typename U >
	Proxy (typename hidden::If< hidden::isSame< Type const, U >::value_, Type, U >::Result &x)
	constructor : create a reference of the Real x.
	Proxy (Type const &x)
	constructor : create a reference of the Real x.
	Proxy (Proxy const &p)
	copy constructor
Proxy &	operator= (Proxy const &p)
	copy operator
	~Proxy ()
	destructor.
	operator Type & ()
	Conversion operator to Type.
	operator Type const & () const
	Constant Conversion operator to Type.

Protected Attributes
Type &	x_
	A reference on the object wrapped.
Type const &	y_
	A reference on the object wrapped.

Friends
istream &	operator>> (istream &is, Proxy< Type > p)
	Overloading of the operator >> for the type Type using a Proxy.
ostream &	operator<< (ostream &os, Proxy< Type > const &p)
	Overloading of the operator << for the type Type using a constant Proxy.

Detailed Description

template<class Type>
class STK::Proxy< Type >

The Proxy class allow to surdefine operators and methods for every kind of class without using dynamic_cast.

This class allow:

• To avoid the use of dynamic_cast
• To surdefine the predefined operators (like << and >>) for the C++ fundamental types.
• To handle in a transparent way the NA values.

Definition at line 51 of file STK_Proxy.h.

Constructor & Destructor Documentation

Proxy() [1/3]

template<class Type >

template<typename U >

STK::Proxy< Type >::Proxy ( typename hidden::If< hidden::isSame< Type const, U >::value_, Type, U >::Result &  x )

inline

constructor : create a reference of the Real x.

Avoid the case x is of type Type const and (thus ambiguity in the choice of the constructor) using sfinae.

Parameters

x	the object to wrap

Definition at line 64 of file STK_Proxy.h.

          : x_(x), y_(x) {}

Proxy() [2/3]

template<class Type >

STK::Proxy< Type >::Proxy ( Type const &  x )

inline

constructor : create a reference of the Real x.

Parameters

x	the object to wrap

Definition at line 69 of file STK_Proxy.h.

: x_(const_cast<Type&>(x)), y_(x) {}

Proxy() [3/3]

template<class Type >

STK::Proxy< Type >::Proxy ( Proxy< Type > const &  p )

inline

copy constructor

Parameters

p	the object to copy

Definition at line 73 of file STK_Proxy.h.

: x_(p.x_), y_(p.y_) {}

~Proxy()

template<class Type >

STK::Proxy< Type >::~Proxy ( )

inline

destructor.

Definition at line 79 of file STK_Proxy.h.

{}

Member Function Documentation

operator Type &()

template<class Type >

STK::Proxy< Type >::operator Type & ( )

inline

Conversion operator to Type.

Definition at line 81 of file STK_Proxy.h.

{ return x_;}

References STK::Proxy< Type >::x_.

operator Type const &()

template<class Type >

STK::Proxy< Type >::operator Type const & ( ) const

inline

Constant Conversion operator to Type.

Definition at line 83 of file STK_Proxy.h.

{ return y_;}

References STK::Proxy< Type >::y_.

operator=()

template<class Type >

Proxy & STK::Proxy< Type >::operator= ( Proxy< Type > const &  p )

inline

copy operator

Parameters

p	the proxy to copy

Definition at line 77 of file STK_Proxy.h.

{ x_ = p.x_; return *this;}

References STK::Proxy< Type >::x_.

Friends And Related Symbol Documentation

operator<<

template<class Type >

ostream & operator<< ( ostream &  os, Proxy< Type > const &  p  )

friend

Overloading of the operator << for the type Type using a constant Proxy.

All output stream should use a Proxy in a STK application. For the enumerated types, we have also to define the standard output.

Parameters

os	the output stream
p	the value to send to the stream

Definition at line 129 of file STK_Proxy.h.

     { return Arithmetic<Type>::isNA(p.y_) ? (os <<  stringNa) : (os << p.y_);}

operator>>

template<class Type >

istream & operator>> ( istream &  is, Proxy< Type >  p  )

friend

Overloading of the operator >> for the type Type using a Proxy.

All input stream should use a Proxy in a STK application. For the enumerated and String types, we have to overload the method. Due to the instruction

is >> buff

this operator will only work for the fundamental C/C++ types. For the other types, the operator

operator >> (istream& is, Type& input);

have to be implemented.

Parameters

is	the input stream
p	the value to get from the stream

Definition at line 100 of file STK_Proxy.h.

     {
       // get current file position
       std::ios::pos_type pos = is.tellg();
       // failed to read directly the Type value
       if ( (is >> p.x_).fail() )
       {
         p.x_ = Arithmetic<Type>::NA();
         // clear and reset position
         is.clear(); is.seekg(pos);
         // Try to read a NA value, in all case value is a NA object
         Char* buffer = new Char[stringNaSize+1];
 
         if (is.get(buffer,stringNaSize+1).fail())
         { is.clear(); is.seekg(pos); is.setstate(std::ios::failbit);}
         else if (!(stringNa.compare(buffer) == 0))
              { is.clear(); is.seekg(pos); is.setstate(std::ios::failbit);}
 
         delete[] buffer;
       }
       return is;
     }

Member Data Documentation

x_

template<class Type >

Type& STK::Proxy< Type >::x_

protected

A reference on the object wrapped.

Definition at line 54 of file STK_Proxy.h.

Referenced by STK::Proxy< String >::operator String &(), STK::Proxy< Type >::operator Type &(), STK::Proxy< Type >::operator=(), and STK::Proxy< String >::operator=().

y_

template<class Type >

Type const& STK::Proxy< Type >::y_

protected

A reference on the object wrapped.

Definition at line 55 of file STK_Proxy.h.

Referenced by STK::Proxy< String >::operator String const &(), and STK::Proxy< Type >::operator Type const &().

---

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

• STK_Proxy.h