GetterSetter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_GETTERSETTER_H_
#define _MIRA_GETTERSETTER_H_

#include <type_traits>

#ifndef Q_MOC_RUN
#include <boost/function.hpp>
#endif

#include <utils/Bind.h>
#include <serialization/IsTransparentSerializable.h>
#include <serialization/ReflectControlFlags.h>

namespace mira {


template<typename T>
class Getter
{
public:

    typedef T value_type;

public:

    Getter(boost::function<value_type ()> f) : fn(f) {}

    value_type get() const { return fn(); }

    operator value_type() const { return get(); }

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        value_type tmp = fn();
        r.delegate(tmp, REFLECT_CTRLFLAG_TEMP_TRACKING);
    }

private:
    boost::function<value_type ()> fn;
};


template <typename T, typename SerializerTag>
class IsTransparentSerializable<Getter<T>,SerializerTag> : public std::true_type {};

template<typename T>
Getter<T> getter(T (*f)())
{
    return Getter<T>(f);
}

template<typename T>
Getter<T> getter(const T& (*f)())
{
    return Getter<T>(f);
}

template<typename T, typename Class>
Getter<T> getter( T (Class::*f) (), Class* obj)
{
    return Getter<T>( boost::bind( f, boost::ref(*obj) ) );
}

template<typename T, typename Class>
Getter<T> getter( const T& (Class::*f) (), Class* obj)
{
    return Getter<T>( boost::bind( f, boost::ref(*obj) ) );
}


template<typename T, typename Class>
Getter<T> getter( T (Class::*f) () const, Class* obj)
{
    return Getter<T>( boost::bind( f, boost::ref(*obj) ) );
}

template<typename T, typename Class>
Getter<T> getter( const T& (Class::*f) () const, Class* obj)
{
    return Getter<T>( boost::bind( f, boost::ref(*obj) ) );
}

template<typename T, typename LambdaFn>
Getter<T> getter(LambdaFn fn)
{
    return Getter<T>(fn);
}

template<typename T>
Getter<T> getter(boost::function<T ()> f)
{
    return Getter<T>(f);
}


template <typename T, typename TObject>
class GetterWithObject
{
public:

    GetterWithObject(boost::function<T (const TObject&)> f, const TObject& obj) :
        fn(f), object(obj) {}

public:

    T operator()() { return fn(object); }

private:

    boost::function<T (const TObject&)> fn;
    const TObject& object;
};



template<typename T, typename TObject>
Getter<T> getter(T (*f)(const TObject&), const TObject& object)
{
    return Getter<T>(GetterWithObject<T,TObject>(f,object));
}

template<typename T, typename TObject>
Getter<T> getter(T (*f)(TObject), const TObject& object)
{
    return Getter<T>(GetterWithObject<T,TObject>(f,object));
}

template<typename T, typename TObject>
Getter<T> getter(boost::function<T(const TObject&)> f, const TObject& object)
{
    return Getter<T>(GetterWithObject<T,TObject>(f,object));
}

template<typename T, typename TObject>
Getter<T> getter(boost::function<T(TObject)> f, const TObject& object)
{
    return Getter<T>(GetterWithObject<T,TObject>(f,object));
}


template<typename T>
class Setter
{
public:
    typedef T value_type;

public:
    Setter(boost::function<void (const value_type&)> f) : fn(f) {}

    void set(const value_type& value) { fn(value); }

    Setter& operator=(const value_type& value)
    {
        set(value);
        return *this;
    }

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        value_type tmp;
        r.delegate(tmp, REFLECT_CTRLFLAG_TEMP_TRACKING);
        set(tmp);
    }

private:

    boost::function<void (const value_type&)> fn;
};

template <typename T, typename SerializerTag>
class IsTransparentSerializable<Setter<T>,SerializerTag> : public std::true_type {};

template<typename T>
Setter<T> setter(void (*f)(const T&))
{
    return Setter<T>(f);
}

template<typename T>
Setter<T> setter(void (*f)(T))
{
    return Setter<T>(f);
}

template<typename T, typename LambdaFn>
Setter<T> setter(LambdaFn fn)
{
    return Setter<T>(fn);
}

template<typename T, typename Class>
Setter<T> setter( void (Class::*f) (const T&), Class* obj)
{
    return Setter<T>( boost::bind( f, boost::ref(*obj), _1 ) );
}

template<typename T, typename Class>
Setter<T> setter( void (Class::*f) (T), Class* obj)
{
    return Setter<T>( boost::bind( f, boost::ref(*obj), _1 ) );
}


template<typename T>
Setter<T> setter(boost::function<void (const T&)> f)
{
    return Setter<T>(f);
}

template <typename T, typename TObject>
class SetterWithObject
{
public:

    SetterWithObject(boost::function<TObject (const T&)> f, TObject& obj) :
        fn(f), object(obj) {}

public:

    void operator()(const T& value) { object = fn(value); }

private:

    boost::function<TObject (const T&)> fn;
    TObject& object;
};

template<typename T, typename TObject>
Setter<T> setter(TObject (*f)(const T&), TObject& object)
{
    return Setter<T>(SetterWithObject<T,TObject>(f,object));
}

/*
 * @ingroup SerializationModule
 *
 * Creates a Setter for a global function or static class
 * method that additionally is assigned with a certain object.
 * Same as above.
 */
template<typename T, typename TObject>
Setter<T> setter(TObject (*f)(T), TObject& object)
{
    return Setter<T>(SetterWithObject<T,TObject>(f,object));
}

/*
 * @ingroup SerializationModule
 *
 * Creates a Setter for a boost bind function
 * that additionally is assigned with a certain object.
 * Same as above.
 */
template<typename T, typename TObject>
Setter<T> setter(boost::function<TObject(const T&)> f, TObject& object)
{
    return Setter<T>(SetterWithObject<T,TObject>(f,object));
}

/*
 * @ingroup SerializationModule
 *
 * Creates a Setter for a boost bind function
 * that additionally is assigned with a certain object.
 * Same as above.
 */
template<typename T, typename TObject>
Setter<T> setter(boost::function<TObject(T)> f, TObject& object)
{
    return Setter<T>(SetterWithObject<T,TObject>(f,object));
}


} // namespace

#endif