X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FSetup.hh;h=f7b2e8619fd1aa77f5a9d96b68ebdd4579ac4e0b;hb=2246ca853064965a7b263c49597c4e74397b989b;hp=ae9c743722ec32f8a5f3907cb1f16b82649c9e6b;hpb=a479735a65e334af538b895f182f8efd36a541c5;p=senf.git diff --git a/PPI/Setup.hh b/PPI/Setup.hh index ae9c743..f7b2e86 100644 --- a/PPI/Setup.hh +++ b/PPI/Setup.hh @@ -1,8 +1,8 @@ // $Id$ // // Copyright (C) 2007 -// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS) -// Kompetenzzentrum fuer Satelitenkommunikation (SatCom) +// Fraunhofer Institute for Open Communication Systems (FOKUS) +// Competence Center NETwork research (NET), St. Augustin, GERMANY // Stefan Bund // // This program is free software; you can redistribute it and/or modify @@ -37,11 +37,27 @@ namespace senf { namespace ppi { -#ifndef DOXYGEN + /** \brief Connect modules + + senf::ppi::connect() establishes a connection between two modules or, to be more precise, + between two connectors. It will connect any input to any output connector as long as one is + active and the other passive. + If a module has an output connector called \c output, the module may be directly specified + as \a source argument. In the same way, if a module has an input connector called \c input, + the module may be given directly as \a target argument. This simplifies the most common case + of a module with one input and one output connector. + + \see \ref ppi_connections + */ void connect(connector::ActiveOutput & source, connector::PassiveInput & target); + + /** \brief Connect modules + \see connect() */ void connect(connector::PassiveOutput & source, connector::ActiveInput & target); - + +#ifndef DOXYGEN + template void connect(T & source, C & target, typename boost::disable_if< boost::is_base_of >::type * = 0, @@ -57,27 +73,6 @@ namespace ppi { typename boost::disable_if< boost::is_base_of >::type * = 0, typename boost::disable_if< boost::is_base_of >::type * = 0); -#else - - /** \brief Connect modules - - senf::ppi::connect() establishes a connection between two modules or, to be more precise, - between two connectors. It will connect any input to any output connector as long as one is - active and the other passive. - - If a module has an output connector called \c output, the module may be directly specified - as \a source argument. In the same way, if a module has an input connector called \c input, - the module may be given directly as \a target argument. This simplifies the most common case - of a module with one input and one output connector. - - \see \ref ppi_connections - */ - void connect(connector::ActiveInput & source, connector::PassiveOutput & target); - - /** \brief Connect modules - \see connect() */ - void connect(connector::PassiveInput & source, connector::ActiveOutput & target); - #endif /** \brief Start the network