DataSourceBase.hpp

/***************************************************************************
  tag: Peter Soetens  Wed Jan 18 14:11:39 CET 2006  DataSourceBase.hpp

                        DataSourceBase.hpp -  description
                           -------------------
    begin                : Wed January 18 2006
    copyright            : (C) 2006 Peter Soetens
    email                : peter.soetens@mech.kuleuven.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 CORELIB_DATASOURCE_BASE_HPP
#define CORELIB_DATASOURCE_BASE_HPP

#include <boost/intrusive_ptr.hpp>
#include <map>
#include <string>
#include <vector>
#include "../os/Atomic.hpp"
#include "../rtt-config.h"
#include "ActionInterface.hpp"
#include "../rtt-fwd.hpp"

namespace RTT
{ namespace base {

  class RTT_API DataSourceBase
  {
  protected:
      mutable os::AtomicInt refcount;

      virtual ~DataSourceBase();

  public:
      typedef boost::intrusive_ptr<DataSourceBase> shared_ptr;

      typedef boost::intrusive_ptr<const DataSourceBase> const_ptr;

      static shared_ptr stack_shared_ptr(DataSourceBase* dsb);

      static const_ptr stack_const_ptr(const DataSourceBase* dsb);

      DataSourceBase();
      void ref() const;
      void deref() const;

      virtual void reset();

      virtual bool evaluate() const = 0;

      virtual bool isAssignable() const;

      virtual void updated();

      virtual bool update( DataSourceBase* other );

      virtual ActionInterface* updateAction( DataSourceBase* other);

      virtual shared_ptr getMember( const std::string& member_name);

      virtual shared_ptr getMember( DataSourceBase::shared_ptr member_id, DataSourceBase::shared_ptr offset);

      virtual std::vector<std::string> getMemberNames() const;

      virtual shared_ptr getParent();

      virtual DataSourceBase* clone() const = 0;

      virtual DataSourceBase* copy( std::map<const DataSourceBase*, DataSourceBase*>& alreadyCloned ) const = 0;

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

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

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

      std::ostream& write(std::ostream& os);

      std::string toString();

      virtual void* getRawPointer();

      virtual void const* getRawConstPointer();
  };

    RTT_API std::ostream& operator<<(std::ostream& os, DataSourceBase::shared_ptr dsb );

    RTT_API void intrusive_ptr_add_ref( const RTT::base::DataSourceBase* p );
    RTT_API void intrusive_ptr_release( const RTT::base::DataSourceBase* p );

}}

#endif