OffsetPartDataSource.hpp

/***************************************************************************
  tag: The SourceWorks  Tue Sep 7 00:55:18 CEST 2010  OffsetPartDataSource.hpp

                        OffsetPartDataSource.hpp -  description
                           -------------------
    begin                : Tue September 07 2010
    copyright            : (C) 2010 The SourceWorks
    email                : peter@thesourceworks.com

 ***************************************************************************
 *   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 ORO_OFFSETPARTDATASOURCE_HPP_
#define ORO_OFFSETPARTDATASOURCE_HPP_

#include "DataSource.hpp"

namespace RTT
{
    namespace internal
    {
        class OffsetDataSource
        : public DataSource<unsigned int>
        {
        public:
            typedef unsigned int offset_type;

            ~OffsetDataSource() {}

            typedef boost::intrusive_ptr<OffsetDataSource > shared_ptr;

            OffsetDataSource( offset_type size,
                              DataSource<unsigned int>::shared_ptr index,
                              DataSource<offset_type>::shared_ptr parent_offset)
                : msize(size), mindex(index), mparent_offset(parent_offset)
            {
            }

            DataSource<offset_type>::result_t get() const
            {
                // calculates the location of the element sequence.
                if (mparent_offset)
                    return mdata = msize * mindex->get() + mparent_offset->get();
                return mdata = msize * mindex->get();
            }

            DataSource<offset_type>::result_t value() const
            {
                return mdata;
            }

            DataSource<offset_type>::const_reference_t rvalue() const
            {
                return mdata;
            }

            virtual OffsetDataSource* clone() const {
                return new OffsetDataSource(msize, mindex, mparent_offset);
            }

            virtual OffsetDataSource* copy( std::map<const base::DataSourceBase*, base::DataSourceBase*>& replace ) const {
                // if somehow a copy exists, return the copy, otherwise return this (see Attribute copy)
                if ( replace[this] != 0 ) {
                    assert ( dynamic_cast<OffsetDataSource*>( replace[this] ) == static_cast<OffsetDataSource*>( replace[this] ) );
                    return static_cast<OffsetDataSource*>( replace[this] );
                }
                // Other pieces in the code rely on insertion in the map :
                replace[this] = new OffsetDataSource(msize, mindex->copy(replace), mparent_offset->copy(replace));
                // return this instead of a copy.
                return static_cast<OffsetDataSource*>(replace[this]);

            }
        private:
            // size of one element.
            const unsigned int msize;
            mutable unsigned int mdata;
            // [] index
            DataSource<unsigned int>::shared_ptr mindex;
            // parent offset
            DataSource<offset_type>::shared_ptr mparent_offset;
        };

        template<typename T>
        class OffsetPartDataSource
        : public AssignableDataSource<T>
        {
            // a reference to a value_t
            typename AssignableDataSource<T>::value_t* mref;
            // [] index
            DataSource<unsigned int>::shared_ptr mindex;
            // parent data source, for updating after set().
            base::DataSourceBase::shared_ptr mparent;
            // offset in memory, calculated by external means.
            DataSource<unsigned int>::shared_ptr moffset;
        public:
            ~OffsetPartDataSource();

            typedef boost::intrusive_ptr<OffsetPartDataSource<T> > shared_ptr;

            OffsetPartDataSource( typename AssignableDataSource<T>::reference_t ref,
                                    DataSource<unsigned int>::shared_ptr index,
                                    base::DataSourceBase::shared_ptr parent,
                                    DataSource<unsigned int>::shared_ptr offset)
                : mref(&ref), mindex(index), mparent(parent), moffset( offset)
            {
            }

            typename DataSource<T>::result_t get() const
            {
                // calculates the location of the element sequence.
                return static_cast<T*>( static_cast<void*>(mref) + moffset->get() )[ mindex->get() ];
            }

            typename DataSource<T>::result_t value() const
            {
                return get();
            }

            void set( typename AssignableDataSource<T>::param_t t )
            {
                set() = t;
                updated();
            }

            typename AssignableDataSource<T>::reference_t set()
            {
                // calculates the location of the element sequence.
                return static_cast<T*>( static_cast<void*>(mref) + moffset->get() )[ mindex->get() ];
            }

            typename AssignableDataSource<T>::const_reference_t rvalue() const
            {
                // calculates the location of the element sequence.
                return static_cast<T*>( static_cast<void*>(mref) + moffset->get() )[ mindex->get() ];
            }

            void updated() {
                mparent->updated();
            }

            virtual shared_ptr getParent() {
                return mparent;
            }


            virtual OffsetPartDataSource<T>* clone() const {
                return new OffsetPartDataSource<T>(mref, mindex, mparent, moffset);
            }

            virtual OffsetPartDataSource<T>* copy( std::map<const base::DataSourceBase*, base::DataSourceBase*>& replace ) const {
                // if somehow a copy exists, return the copy, otherwise return this (see Attribute copy)
                if ( replace[this] != 0 ) {
                    assert ( dynamic_cast<OffsetPartDataSource<T>*>( replace[this] ) == static_cast<OffsetPartDataSource<T>*>( replace[this] ) );
                    return static_cast<OffsetPartDataSource<T>*>( replace[this] );
                }
                // Other pieces in the code rely on insertion in the map :
                replace[this] = new OffsetPartDataSource<T>(mref, mindex->copy(replace), mparent->copy(replace), moffset->copy(replace));
                // return this instead of a copy.
                return static_cast<OffsetPartDataSource<T>*>(replace[this]);

            }
        };

    }
}

#endif /* ORO_PARTDATASOURCE_HPP_ */