PropertyBase.hpp

Go to the documentation of this file.

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

                        PropertyBase.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_PROPERTYBASE
#define PI_PROPERTYBASE

#include <string>
#include "ActionInterface.hpp"
#include "DataSourceBase.hpp"

#ifdef ORO_PRAGMA_INTERFACE
#pragma interface
#endif

namespace RTT
{ namespace base {

    class RTT_API PropertyBase
    {
    public:
        virtual ~PropertyBase();

        PropertyBase( std::string name, std::string description);

        PropertyBase();

        const std::string& getName() const { return _name; }

        void setName(const std::string& name);

        const std::string& getDescription() const { return _description; }

        void setDescription(const std::string& desc);

        bool ready() const { return this->getDataSource().get() != 0; }

        virtual void identify( PropertyIntrospection* pi) = 0;

        virtual void identify( PropertyBagVisitor* pi);

        virtual bool update( const PropertyBase* other ) = 0;

        virtual bool refresh( const PropertyBase* other ) = 0;

        virtual bool copy( const PropertyBase* other ) = 0;

        virtual bool compose( const PropertyBag& source);

        virtual PropertyBase* clone() const = 0;

        virtual PropertyBase* copy() const = 0;

        virtual PropertyBase* create() const = 0;

        virtual DataSourceBase::shared_ptr getDataSource() const = 0;

        virtual std::string getType() const = 0;

        virtual const types::TypeInfo* getTypeInfo() const = 0;

    protected:
        std::string _name;

        std::string _description;
    };

    RTT_API std::ostream& operator<<(std::ostream &os, PropertyBase* p);


    }
} // namespace RTT
#endif