OMK::AccessorAccT< T, T2 > Class Template Reference
[Attribute feature]

The implementation class for accessor through accessors method of an associated object. More...

#include <OMKIAccessor.h>

Inheritance diagram for OMK::AccessorAccT< T, T2 >:

[legend]Collaboration diagram for OMK::AccessorAccT< T, T2 >:

[legend]List of all members.

Public Member Functions
	AccessorAccT (IAccessorT< T2 > *accessor)
	Constructor.
virtual	~AccessorAccT ()
	Destructor.
virtual const T &	get () const
	Get the value.
virtual void	set (const T &value)
	Set the value.
void	setAccessor (IAccessorT< T2 > *accessor)
	Set the new accessor.
Protected Attributes
IAccessorT< T2 > *	_accessor
	The accessor to the value.
Private Attributes
T	_tmpValue
	Temporary value.

---

Detailed Description

template<typename T, typename T2>
class OMK::AccessorAccT< T, T2 >

The implementation class for accessor through accessors method of an associated object.

Date:

2007-01-19

Author:

Benoît Chanclou

This class defines a class which accesses to a value through an accessor. This accessor class is a template one, the parameters are:

• T, it is the type of the value.
• T2, it is the type of the associated accessor.

Because the types of the two accessors can be different, you must be certain there is a convertion between the two types, so that you can write:

 T a ;
 T2 b = (T2)a ;
 T c = (T)b ;

The other way to use this accessor is to switch between different cases with the setAccessor method. For example to defined different behavior for an object. The following code switches between an AccessorT and an AccessorFctT (which integrate the value):

class MyAccessor : public AccessorAccT< int, int >
{
public:
  MyAccessor( int value = 0 ) 
    : AccessorAccT< int, int >( &_default ), 
      _integrator( this, &OMK::MyAccessor::integrateValue, &OMK::MyAccessor::get ), 
      _default( value )
    {}
  virtual ~MyAccessor() {}
  void toggleBehavior() { setAccessor( _accessor == &_default ? (IAccessorT< int >*)&_default : (IAccessorT< int >*)&_integrator ) ; }
private:
  AccessorT< int > _default ;
  AccessorFctT< int, MyAccessor > _integrator ;
  virtual void integrateValue( const int& value ) { _default.set( _default.get() + value ) ; }
  const int& getValue() const { return _default.get() ; }
} ;

See

Definition at line 207 of file OMKIAccessor.h.

---

Constructor & Destructor Documentation

template<typename T, typename T2>

OMK::AccessorAccT< T, T2 >::AccessorAccT

(

IAccessorT< T2 > *

accessor

)

[inline]

Constructor.

Stores the pointers on the object to get and set the value.

Definition at line 212 of file OMKIAccessor.h.

    : _accessor( accessor ) 
  { 
    OMASSERTM( _accessor, "Must be valid" ) ;
  }

template<typename T, typename T2>

virtual OMK::AccessorAccT< T, T2 >::~AccessorAccT

(

)

[inline, virtual]

Destructor.

Definition at line 218 of file OMKIAccessor.h.

{}

---

Member Function Documentation

template<typename T, typename T2>

virtual const T& OMK::AccessorAccT< T, T2 >::get

(

)

const [inline, virtual]

Get the value.

Returns:

The current value

Uses _tmpValue to avoid return of a temporary object. The returned value is not a reference on the genuine value, so don't use as a reference, only use its value.

Implements OMK::IAccessorT< T >.

Definition at line 226 of file OMKIAccessor.h.

  { 
    // Gets and cast the value
    _tmpValue = (T)_accessor->get() ; 
    // Returns the cast value
    return _tmpValue ; 
  }

template<typename T, typename T2>

virtual void OMK::AccessorAccT< T, T2 >::set

(

const T &

value

)

[inline, virtual]

Set the value.

Parameters:

[in]

value

The new value of the value.

Implements OMK::IAccessorT< T >.

Definition at line 235 of file OMKIAccessor.h.

  { // Casts and sets the value
    _accessor->set( (T2)value ) ; 
  }

template<typename T, typename T2>

void OMK::AccessorAccT< T, T2 >::setAccessor

(

IAccessorT< T2 > *

accessor

)

[inline]

Set the new accessor.

Parameters:

[in]

accessor

The new accessor to the value.

Use this method to change the current accessor. See example in the class description.

Definition at line 244 of file OMKIAccessor.h.

  {
    _accessor = accessor ;
    OMASSERTM( _accessor, "Must be valid" ) ;
  }

---

Member Data Documentation

template<typename T, typename T2>

IAccessorT< T2 >* OMK::AccessorAccT< T, T2 >::_accessor [protected]

The accessor to the value.

Definition at line 251 of file OMKIAccessor.h.

Referenced by OMK::AccessorAccT< Type, AttributType >::AccessorAccT(), OMK::AccessorAccT< Type, AttributType >::get(), OMK::AccessorAccT< Type, AttributType >::set(), and OMK::AccessorAccT< Type, AttributType >::setAccessor().

template<typename T, typename T2>

T OMK::AccessorAccT< T, T2 >::_tmpValue [mutable, private]

Temporary value.

Only used in get method.

mutable because get is a const method.

Definition at line 257 of file OMKIAccessor.h.

Referenced by OMK::AccessorAccT< Type, AttributType >::get().

---