PortInterface.cpp
Go to the documentation of this file.
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 #include "../internal/ConnFactory.hpp"
00043 
00044 using namespace RTT;
00045 using namespace RTT::detail;
00046 using namespace std;
00047 
00048 PortInterface::PortInterface(const std::string& name)
00049     : name(name), iface(0) {}
00050 
00051 bool PortInterface::setName(const std::string& name)
00052 {
00053     if ( !connected() ) {
00054         this->name = name;
00055         return true;
00056     }
00057     return false;
00058 }
00059 
00060 PortInterface& PortInterface::doc(const std::string& desc) {
00061     mdesc = desc;
00062     if (iface)
00063         iface->setPortDescription(name, desc);
00064     return *this;
00065 }
00066 
00067 bool PortInterface::isLocal() const
00068 { return serverProtocol() == 0; }
00069 int PortInterface::serverProtocol() const
00070 { return 0; }
00071 
00072 ConnID* PortInterface::getPortID() const
00073 { return new LocalConnID(this); }
00074 
00075 Service* PortInterface::createPortObject()
00076 {
00077 #ifndef ORO_EMBEDDED
00078     Service* to = new Service( this->getName(), iface->getOwner() );
00079     to->addSynchronousOperation( "name",&PortInterface::getName, this).doc(
00080             "Returns the port name.");
00081     to->addSynchronousOperation("connected", &PortInterface::connected, this).doc("Check if this port is connected and ready for use.");
00082 
00083     typedef void (PortInterface::*disconnect_all)();
00084     to->addSynchronousOperation("disconnect", static_cast<disconnect_all>(&PortInterface::disconnect), this).doc("Disconnects this port from any connection it is part of.");
00085     return to;
00086 #else
00087     return 0;
00088 #endif
00089 }
00090 
00091 void PortInterface::setInterface(DataFlowInterface* dfi) {
00092     iface = dfi;
00093 }
00094 
00095 DataFlowInterface* PortInterface::getInterface() const
00096 {
00097     return iface;
00098 }
00099 


rtt
Author(s): RTT Developers
autogenerated on Wed Aug 26 2015 16:15:51