Orocos Real-Time Toolkit  2.6.0
PortInterface.cpp
00001 /***************************************************************************
00002   tag: Peter Soetens  Thu Oct 22 11:59:07 CEST 2009  PortInterface.cpp
00003 
00004                         PortInterface.cpp -  description
00005                            -------------------
00006     begin                : Thu October 22 2009
00007     copyright            : (C) 2009 Sylvain Joyeux
00008     email                : sylvain.joyeux@m4x.org
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 
00039 #include "PortInterface.hpp"
00040 #include "../Service.hpp"
00041 #include "../OperationCaller.hpp"
00042 
00043 using namespace RTT;
00044 using namespace RTT::detail;
00045 using namespace std;
00046 
00047 PortInterface::PortInterface(const std::string& name)
00048     : name(name), iface(0) {}
00049 
00050 bool PortInterface::setName(const std::string& name)
00051 {
00052     if ( !connected() ) {
00053         this->name = name;
00054         return true;
00055     }
00056     return false;
00057 }
00058 
00059 PortInterface& PortInterface::doc(const std::string& desc) {
00060     mdesc = desc;
00061     if (iface)
00062         iface->setPortDescription(name, desc);
00063     return *this;
00064 }
00065 
00066 bool PortInterface::isLocal() const
00067 { return serverProtocol() == 0; }
00068 int PortInterface::serverProtocol() const
00069 { return 0; }
00070 
00071 ConnID* PortInterface::getPortID() const
00072 { return new LocalConnID(this); }
00073 
00074 Service* PortInterface::createPortObject()
00075 {
00076 #ifndef ORO_EMBEDDED
00077     Service* to = new Service( this->getName(), iface->getOwner() );
00078     to->addSynchronousOperation( "name",&PortInterface::getName, this).doc(
00079             "Returns the port name.");
00080     to->addSynchronousOperation("connected", &PortInterface::connected, this).doc("Check if this port is connected and ready for use.");
00081 
00082     typedef void (PortInterface::*disconnect_all)();
00083     to->addSynchronousOperation("disconnect", static_cast<disconnect_all>(&PortInterface::disconnect), this).doc("Disconnects this port from any connection it is part of.");
00084     return to;
00085 #else
00086     return 0;
00087 #endif
00088 }
00089 
00090 void PortInterface::setInterface(DataFlowInterface* dfi) {
00091     iface = dfi;
00092 }
00093 
00094 DataFlowInterface* PortInterface::getInterface() const
00095 {
00096     return iface;
00097 }
00098