PropertyBase.hpp

00001 /***************************************************************************
00002   tag: Peter Soetens  Mon Jan 19 14:11:20 CET 2004  PropertyBase.hpp
00003 
00004                         PropertyBase.hpp -  description
00005                            -------------------
00006     begin                : Mon January 19 2004
00007     copyright            : (C) 2004 Peter Soetens
00008     email                : peter.soetens@mech.kuleuven.ac.be
00009 
00010  ***************************************************************************
00011  *   This library is free software; you can redistribute it and/or         *
00012  *   modify it under the terms of the GNU General Public                   *
00013  *   License as published by the Free Software Foundation;                 *
00014  *   version 2 of the License.                                             *
00015  *                                                                         *
00016  *   As a special exception, you may use this file as part of a free       *
00017  *   software library without restriction.  Specifically, if other files   *
00018  *   instantiate templates or use macros or inline functions from this     *
00019  *   file, or you compile this file and link it with other files to        *
00020  *   produce an executable, this file does not by itself cause the         *
00021  *   resulting executable to be covered by the GNU General Public          *
00022  *   License.  This exception does not however invalidate any other        *
00023  *   reasons why the executable file might be covered by the GNU General   *
00024  *   Public License.                                                       *
00025  *                                                                         *
00026  *   This library is distributed in the hope that it will be useful,       *
00027  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00028  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00029  *   Lesser General Public License for more details.                       *
00030  *                                                                         *
00031  *   You should have received a copy of the GNU General Public             *
00032  *   License along with this library; if not, write to the Free Software   *
00033  *   Foundation, Inc., 59 Temple Place,                                    *
00034  *   Suite 330, Boston, MA  02111-1307  USA                                *
00035  *                                                                         *
00036  ***************************************************************************/
00037 
00038 #ifndef PI_PROPERTYBASE
00039 #define PI_PROPERTYBASE
00040 
00041 #include <string>
00042 #include "CommandInterface.hpp"
00043 #include "DataSourceBase.hpp"
00044 
00045 #ifdef ORO_PRAGMA_INTERFACE
00046 #pragma interface
00047 #endif
00048 
00049 namespace RTT
00050 {
00051     namespace detail {
00052         class PropertyOperation;
00053     }
00054     class PropertyBagVisitor;
00055     class PropertyIntrospection;
00056 
00061     class RTT_API PropertyBase
00062     {
00063     public:
00067         virtual ~PropertyBase();
00068 
00076         PropertyBase( std::string name, std::string description);
00077 
00081         PropertyBase();
00082 
00087         const std::string& getName() const { return _name; }
00088 
00093         void setName(const std::string& name);
00094 
00099         const std::string& getDescription() const { return _description; }
00100 
00105         void setDescription(const std::string& desc);
00106 
00113         bool ready() const { return this->getDataSource(); }
00114 
00119         virtual void identify( PropertyIntrospection* pi) = 0;
00120 
00125         virtual void identify( PropertyBagVisitor* pi);
00126 
00134         virtual bool update( const PropertyBase* other ) = 0;
00135 
00142         virtual CommandInterface* updateCommand( const PropertyBase* other) = 0;
00143 
00151         virtual bool refresh( const PropertyBase* other ) = 0;
00152 
00159         virtual CommandInterface* refreshCommand( const PropertyBase* other) = 0;
00160 
00168         virtual bool copy( const PropertyBase* other ) = 0;
00169 
00175         virtual CommandInterface* copyCommand( const PropertyBase* other) = 0;
00176 
00182         virtual PropertyBase* clone() const = 0;
00183 
00189         virtual PropertyBase* create() const = 0;
00190 
00195         virtual DataSourceBase::shared_ptr getDataSource() const = 0;
00196 
00201         virtual std::string getType() const = 0;
00202 
00206         virtual const TypeInfo* getTypeInfo() const = 0;
00207 
00208     protected:
00212         std::string _name;
00213 
00217         std::string _description;
00218     };
00219 
00225     RTT_API std::ostream& operator<<(std::ostream &os, PropertyBase* p);
00226 
00227 
00228 } // namespace RTT
00229 #endif
Generated on Thu Dec 23 13:22:38 2010 for Orocos Real-Time Toolkit by  doxygen 1.6.3