WModuleInputConnector.cpp

//---------------------------------------------------------------------------
//
// Project: OpenWalnut ( http://www.openwalnut.org )
//
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
// For more information see http://www.openwalnut.org/copying
//
// This file is part of OpenWalnut.
//
// OpenWalnut is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut 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 Lesser General Public License
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------
 
#include <memory>
#include <string>
 
#include "../common/WCondition.h"
#include "WModuleConnectorSignals.h"
#include "WModuleInputConnector.h"
#include "WModuleOutputConnector.h"
 
WModuleInputConnector::WModuleInputConnector( std::shared_ptr< WModule > module, std::string name, std::string description ):
    WModuleConnector( module, name, description ),
    m_updated( false )
{
    // connect some signals
    // This signal is some kind of "forwarder" for the data_changed signal of an output connector.
    signal_DataChanged.connect( getSignalHandler( DATA_CHANGED ) );
 
    // if connection is closed, also fire "data change"
    signal_ConnectionClosed.connect( boost::bind( &WModuleInputConnector::setUpdated, this ) );
    signal_ConnectionClosed.connect( boost::bind( &WCondition::notify, m_dataChangedCondition ) );
}
 
WModuleInputConnector::~WModuleInputConnector()
{
    // cleanup
    m_DataChangedConnection.disconnect();
    signal_ConnectionClosed.disconnect_all_slots();
}
 
bool WModuleInputConnector::connectable( std::shared_ptr<WModuleConnector> con )
{
    // output connectors are just allowed to get connected with input connectors
    if( dynamic_cast<WModuleOutputConnector*>( con.get() ) )   // NOLINT - since we really need them here
    {
        return true;
    }
    return false;
}
 
bool WModuleInputConnector::lazyConnectable( std::shared_ptr<WModuleConnector> con )
{
    // output connectors are just allowed to get connected with input connectors
    if( dynamic_cast<WModuleOutputConnector*>( con.get() ) )   // NOLINT - since we really need them here
    {
        return true;
    }
    return false;
}
 
void WModuleInputConnector::connectSignals( std::shared_ptr<WModuleConnector> con )
{
    WModuleConnector::connectSignals( con );
 
    // connect dataChange signal with an internal handler to ensure we can add the "input" connector pointer, since the output
    // connector does not set this information.
    // NOTE: con will be a WModuleOutputConnector
    m_DataChangedConnection = con->subscribeSignal( DATA_CHANGED,
        boost::bind( &WModuleInputConnector::notifyDataChange, this, boost::placeholders::_1, boost::placeholders::_2 )
    );
}
 
void WModuleInputConnector::disconnectSignals( std::shared_ptr<WModuleConnector> con )
{
    m_DataChangedConnection.disconnect();
 
    WModuleConnector::disconnectSignals( con );
}
 
boost::signals2::connection WModuleInputConnector::subscribeSignal( MODULE_CONNECTOR_SIGNAL signal,
                                                                    t_GenericSignalHandlerType notifier )
{
    // connect DataChanged signal
    switch( signal )
    {
        case DATA_CHANGED:
            return signal_DataChanged.connect( notifier );
        default:    // we do not know this signal: maybe the base class knows it
            return WModuleConnector::subscribeSignal( signal, notifier );
    }
}
 
void WModuleInputConnector::notifyDataChange( std::shared_ptr<WModuleConnector> /*input*/,
                                              std::shared_ptr<WModuleConnector> output )
{
    setUpdated();
 
    // since the output connector is not able to fill the parameter "input" we need to forward this message and fill it with the
    // proper information
    signal_DataChanged( shared_from_this(), output );
    m_dataChangedCondition->notify();
}
 
void WModuleInputConnector::notifyConnectionEstablished( std::shared_ptr<WModuleConnector> here, std::shared_ptr<WModuleConnector> there )
{
    // since the output connector is not able to fill the parameter "input" we need to forward this message and fill it with the
    // proper information
    // NOTE: connection established also emits a data changed signal since the data available at the connector has changed.
    notifyDataChange( here, there );
 
    // forward
    WModuleConnector::notifyConnectionEstablished( here, there );
}
 
bool WModuleInputConnector::isInputConnector() const
{
    return true;
}
 
bool WModuleInputConnector::isOutputConnector() const
{
    return false;
}
 
bool WModuleInputConnector::updated()
{
    boost::lock_guard<std::shared_mutex> lock( m_updatedLock );
    return m_updated;
}
 
void WModuleInputConnector::setUpdated()
{
    boost::lock_guard<std::shared_mutex> lock( m_updatedLock );
    m_updated = true;
}
 
bool WModuleInputConnector::handledUpdate()
{
    boost::lock_guard<std::shared_mutex> lock( m_updatedLock );
    bool old = m_updated;
    m_updated = false;
    return old;
}