Orocos Real-Time Toolkit  2.5.0
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 "ActionInterface.hpp"
00043 #include "DataSourceBase.hpp"
00044 
00045 #ifdef ORO_PRAGMA_INTERFACE
00046 #pragma interface
00047 #endif
00048 
00049 namespace RTT
00050 { namespace base {
00051 
00056     class RTT_API PropertyBase
00057     {
00058     public:
00062         virtual ~PropertyBase();
00063 
00071         PropertyBase( std::string name, std::string description);
00072 
00076         PropertyBase();
00077 
00082         const std::string& getName() const { return _name; }
00083 
00088         void setName(const std::string& name);
00089 
00094         const std::string& getDescription() const { return _description; }
00095 
00100         void setDescription(const std::string& desc);
00101 
00108         bool ready() const { return this->getDataSource(); }
00109 
00115         virtual void identify( PropertyIntrospection* pi) = 0;
00116 
00122         virtual void identify( PropertyBagVisitor* pi);
00123 
00134         virtual bool update( const PropertyBase* other ) = 0;
00135 
00146         virtual bool refresh( const PropertyBase* other ) = 0;
00147 
00158         virtual bool copy( const PropertyBase* other ) = 0;
00159 
00166         virtual bool compose( const PropertyBag& source);
00167 
00173         virtual PropertyBase* clone() const = 0;
00174 
00180         virtual PropertyBase* create() const = 0;
00181 
00186         virtual DataSourceBase::shared_ptr getDataSource() const = 0;
00187 
00192         virtual std::string getType() const = 0;
00193 
00197         virtual const types::TypeInfo* getTypeInfo() const = 0;
00198 
00199     protected:
00203         std::string _name;
00204 
00208         std::string _description;
00209     };
00210 
00216     RTT_API std::ostream& operator<<(std::ostream &os, PropertyBase* p);
00217 
00218 
00219     }
00220 } // namespace RTT
00221 #endif