PropertyBag.hpp

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

                        PropertyBag.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_BAG
#define PI_PROPERTY_BAG

#include "PropertyBase.hpp"

#include <vector>
#include <algorithm>

#ifdef ORO_PRAGMA_INTERFACE
#pragma interface
#endif

namespace RTT
{
    template< class T>
    class Property;

    class RTT_API PropertyBag
    {
    public:
        typedef std::vector<PropertyBase*> Properties;
        typedef Properties PropertyContainerType;
        typedef Properties::iterator iterator;
        typedef Properties::const_iterator const_iterator;

        typedef std::vector<std::string> Names;
        PropertyBag();

        PropertyBag( const std::string& _type);

        PropertyBag( const PropertyBag& orig);

        ~PropertyBag();

        void add(PropertyBase *p);

        void remove(PropertyBase *p);

        bool addProperty(PropertyBase *p);

        bool removeProperty(PropertyBase *p);

        bool ownProperty(PropertyBase* p);

        bool ownsProperty(PropertyBase* p);

        void clear();

        void list(Names &names) const;

        Names list() const;

        bool empty() const
        {
            return mproperties.empty();
        }

        template<class T>
        Property<T>* getProperty(const std::string& name) const
        {
            const_iterator i( std::find_if(mproperties.begin(), mproperties.end(), std::bind2nd(FindProp(), name ) ) );
            if ( i != mproperties.end() )
                return dynamic_cast< Property<T>* >( *i );
            return 0;
        }

        PropertyBase* getItem( int i) const
        {
            if ( i < 0 || i >= int(mproperties.size()) )
                return 0;
            return mproperties[i];
        }

        size_t size() const { return mproperties.size(); }

        void identify( PropertyIntrospection* pi ) const;

        void identify( PropertyBagVisitor* pi ) const;

        PropertyBase* find(const std::string& name) const;

        template<class T>
        PropertyBase* findValue(const T& value) const {
            for ( const_iterator i = mproperties.begin();
                  i != mproperties.end();
                  i++ )
                {
                    Property<T> p = *i;
                    if (p.ready() && (p.value() == value))
                        return *i;
                }
            return 0;
        }

        PropertyBag& operator=(const PropertyBag& orig);

        PropertyBag& operator<<=(const PropertyBag& source);

        PropertyBag& operator<<( PropertyBase* item) { this->add(item); return *this; }

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

        void setType(const std::string& newtype) { type = newtype; }

        Properties& getProperties() { return mproperties; }

        const Properties& getProperties() const { return mproperties; }

        Properties getProperties(const std::string& name) const;

        Names getPropertyNames() const { return list(); }

        iterator begin() { return mproperties.begin(); }
        const_iterator begin() const { return mproperties.begin(); }
        iterator end() { return mproperties.end(); }
        const_iterator end() const { return mproperties.end(); }
    protected:
        Properties mproperties;
        Properties mowned_props;

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

        std::string type;
    };

    /*
     * @defgroup BagOperations Recursive Property Bag Operations.
     *        These functions operate recursively on the contents of bags,
     *        possibly modifying, deleting or creating new Property objects
     *        in the bag or in one of its sub-bags.
     * @ingroup CoreLibProperties
     * @{
     */

    RTT_API PropertyBase* findProperty(const PropertyBag& bag, const std::string& path, const std::string& separator = std::string(".") );

    RTT_API bool refreshProperties(const PropertyBag& target, const PropertyBag& source, bool strict=false);

    RTT_API bool refreshProperty(const PropertyBag& target, const PropertyBase& source);

    RTT_API bool copyProperties(PropertyBag& target, const PropertyBag& source);

    RTT_API bool updateProperties(PropertyBag& target, const PropertyBag& source);

    RTT_API bool updateProperty(PropertyBag& target, const PropertyBag& source, const std::string& path, const std::string& separator = ".");

    RTT_API bool refreshProperty(PropertyBag& target, const PropertyBag& source, const std::string& path, const std::string& separator = ".");

    RTT_API void deleteProperties(PropertyBag& target);

    RTT_API void deletePropertyBag(PropertyBag& target);

    RTT_API void flattenPropertyBag(PropertyBag& target, const std::string& separator=".");

} // Namespace RTT
#endif