MethodC.hpp

/***************************************************************************
  tag: Peter Soetens  Wed Jan 18 14:11:40 CET 2006  MethodC.hpp

                        MethodC.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 ORO_EXECUTION_METHODC_HPP
#define ORO_EXECUTION_METHODC_HPP

#include <string>
#include "DataSources.hpp"
#include "Attribute.hpp"
#include "OperationFactory.hpp"

namespace RTT
{
    class RTT_API MethodC
    {
        class D;
        D* d;
        DataSourceBase::shared_ptr m;
    public:
        MethodC();

        MethodC( const MethodFactory* mr, const std::string& name);

        MethodC(const MethodC& other);

        MethodC& operator=(const MethodC& other);

        ~MethodC();

        MethodC& arg( DataSourceBase::shared_ptr a );

        template< class ArgT >
        MethodC& argC( const ArgT a )
        {
            return this->arg(DataSourceBase::shared_ptr( new ConstantDataSource<ArgT>( a ) ) );
        }

        template< class ArgT >
        MethodC& arg( ArgT& a )
        {
            return this->arg(DataSourceBase::shared_ptr( new ReferenceDataSource<ArgT>( a ) ) );
        }

        MethodC& ret( AttributeBase* r );

        MethodC& ret( DataSourceBase::shared_ptr r);

        template< class RetT >
        MethodC& ret( RetT& r )
        {
            // this is semantically valid wrt Attribute::copy().
            AttributeBase* ta = new Attribute<RetT>("ret", new ReferenceDataSource<RetT>(r));
            this->ret( ta );
            delete ta;
            return *this;
        }

        bool execute();

        void reset();

        bool ready() const;

        DataSourceBase::shared_ptr getDataSource();
    };
}

#endif