SendHandleC.hpp

Go to the documentation of this file.

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

                        SendHandleC.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_EXECUTION_SENDHANDLEC_HPP
#define ORO_EXECUTION_SENDHANDLEC_HPP

#include <string>
#include <boost/make_shared.hpp>
#include "DataSources.hpp"
#include "../Attribute.hpp"
#include "../rtt-fwd.hpp"
#include "../SendStatus.hpp"

namespace RTT
{ namespace internal {

    class RTT_API SendHandleC
    {
        class D;
        class E;
        D* d;
        E* e;
    public:
        SendHandleC();

        SendHandleC( base::DataSourceBase::shared_ptr operation, base::DataSourceBase::shared_ptr handle, OperationInterfacePart* ofp, const std::string& name );

        SendHandleC(const SendHandleC& other);

        SendHandleC& operator=(const SendHandleC& other);

        ~SendHandleC();

        SendHandleC& arg( base::DataSourceBase::shared_ptr a );

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

        SendStatus collect();

        SendStatus collectIfDone();

        void check();

        bool ready() const;

        void setAutoCollect(bool on_off);

        base::DataSourceBase::shared_ptr getSendHandleDataSource();

        OperationInterfacePart* getOrp();

    };
}}

#endif