PropertySequence.hpp

/***************************************************************************
  tag: Peter Soetens  Mon Jan 19 14:11:19 CET 2004  PropertySequence.hpp

                        PropertySequence.hpp -  description
                           -------------------
    begin                : Mon January 19 2004
    copyright            : (C) 2004 Peter Soetens
    email                : peter.soetens@mech.kuleuven.ac.be

 ***************************************************************************
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU General Public                   *
 *   License as published by the Free Software Foundation;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/

#ifndef PI_PROPERTY_SEQUENCE_HPP
#define PI_PROPERTY_SEQUENCE_HPP

#include "PropertyBase.hpp"
#include <vector>

#ifdef ORO_PRAGMA_INTERFACE
#pragma interface
#endif

namespace RTT
{
    template< class T >
    class PropertySequence
    {
        public:
            typedef std::vector<T*> PropertyContainerType;
            typedef typename PropertyContainerType::iterator iterator;
            typedef typename PropertyContainerType::const_iterator const_iterator;

            PropertySequence( )
                : _properties(), type("type_less")
            {}

            PropertySequence( const std::string& _type)
                : _properties(), type(_type)
            {}

            PropertySequence( const PropertySequence<T>& orig)
                : _properties( orig.getProperties() ), type( orig.getType() )
            {
            }

            void add(T *p)
            {
                _properties.push_back(p);
            }

            void remove(T *p)
            {
                iterator i = std::find(_properties.begin(), _properties.end(), p);
                if ( i != _properties.end() )
                    _properties.erase(i);
            }

            void clear()
            {
                _properties.clear();
            }


            void list(std::vector<std::string> &names) const
            {
                for (
                    const_iterator i = _properties.begin();
                    i != _properties.end();
                    i++ )
                {
                    names.push_back( (*i)->getName() );
                }
            }

            T* find(const std::string& name) const
            {
                const_iterator i( std::find_if(_properties.begin(), _properties.end(), std::bind2nd(FindProp(), name ) ) );
                if ( i != _properties.end() )
                    return ( *i );
                return 0;
            }

            PropertySequence<T>& operator=(const PropertySequence<T>& orig)
            {
                _properties.clear();

                const_iterator i = orig.getProperties().begin();
                while (i != orig.getProperties().end() )
                {
                    add( (*i) );
                    ++i;
                }
                return *this;
            }

            PropertySequence<T>& operator<<=(const PropertySequence<T>& source)
            {
                //iterate over orig, update or clone Ts
                const_iterator it(source.getProperties().begin());
                while ( it != source.getProperties().end() )
                {
                    T* mine = find( (*it)->getName() );
                    if (mine != 0)
                        remove(mine);
                    add( (*it) );
                    ++it;
                }
                return *this;
            }

            const std::string& getType() const { return type;}

            const PropertyContainerType& getProperties() const { return _properties; }

        protected:
            PropertyContainerType _properties;

            struct FindProp : public std::binary_function<const T*,const std::string, bool>
            {
                bool operator()(const T* b1, const std::string& b2) const { return b1->getName() == b2; }
            };

            const std::string type;
    };


    template< class T>
    void refreshProperties(PropertySequence<T>& target, const PropertySequence<T>& source);

    template< class T>
    void copyProperties(PropertySequence<T>& target, const PropertySequence<T>& source);

    template< class T>
    void deleteProperties(PropertySequence<T>& target);

    template< class T>
    inline
    void update(PropertySequence<T>& a, const PropertySequence<T>& b)
    {
        refreshProperties(a,b);
    }

    template< class T>
    inline
    void copy(PropertySequence<T>& a, const PropertySequence<T>& b)
    {
        copyProperties(a,b);
    }

} // Namespace RTT
#endif