FlattenedNetwork.hxx

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2007 MUSIC TECHNOLOGY GROUP (MTG)
 *                         UNIVERSITAT POMPEU FABRA
 *
 *
 * This program 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; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */



#ifndef _FlattenedNetwork_hxx_
#define _FlattenedNetwork_hxx_

#include "Processing.hxx"
#include "InPort.hxx"
#include "OutPort.hxx"
#include "InControl.hxx"
#include "OutControl.hxx"
#include <string>
#include <list>
#include <map>
#include <set>

//#include "Component.hxx"
//#include "Storage.hxx"
#include "BaseNetwork.hxx"

namespace CLAM
{
class NetworkPlayer;
class FlowControl;

class FlattenedNetwork : public BaseNetwork
{

public:
        // constructor / destructor
        FlattenedNetwork();
        virtual ~FlattenedNetwork();

        // Methods related to network itself
        const std::string& GetName() const { return _name; }
        void SetName( const std::string& name ) { _name=name; }
        virtual const char * GetClassName() const
        {
                return "FlattenedNetwork";
        }

        // Methods related with player and flow
        bool IsStopped() const;
        void Start();
        void Stop();
        void Do();
        void AddFlowControl( FlowControl* );
        void Clear();
        void SetPlayer( NetworkPlayer* player);
        unsigned BackendBufferSize();
        unsigned BackendSampleRate();


        virtual void StoreOn( Storage & storage) const;
        virtual void LoadFrom( Storage & storage);

        bool UpdateSelections (const NamesList & processingsNamesList);
        void setPasteMode() { _setPasteMode=true; }

        bool SetProcessingsGeometries (const ProcessingsGeometriesMap & processingsGeometries);
        const ProcessingsGeometriesMap GetAndClearGeometries();

/*// TODO: make individual geometries loadings/storings??
        const Geometry GetAndEraseGeometry(std::string name);*/
        bool ConnectPorts( const std::string &, const std::string & );
        bool ConnectControls( const std::string &, const std::string & );
        bool DisconnectPorts( const std::string &, const std::string & );
        bool DisconnectControls( const std::string &, const std::string & );

        Processing& GetProcessing( const std::string & name ) const;
        void AddProcessing( const std::string &, Processing* );
        void AddProcessing( const std::string & name, const std::string & key );
        std::string AddProcessing( const std::string& key );
        std::string GetUnusedName( const std::string& prefix ) const;
        void RemoveProcessing ( const std::string & );
        bool HasProcessing( const std::string & name ) const;
        bool ConfigureProcessing( const std::string &, const ProcessingConfig & );
        void ReconfigureAllProcessings();
        bool RenameProcessing( const std::string & oldName, const std::string & newName );      
        
        const std::string & GetNetworkId(const Processing * proc) const;
        
        // accessors to nodes and processing
        ProcessingsMap::iterator BeginProcessings();
        ProcessingsMap::iterator EndProcessings();
        ProcessingsMap::const_iterator BeginProcessings() const;
        ProcessingsMap::const_iterator EndProcessings() const;

        InPortBase & GetInPortByCompleteName( const std::string& ) const;
        OutPortBase & GetOutPortByCompleteName( const std::string& ) const;
        InControl & GetInControlByCompleteName( const std::string& ) const;
        OutControl & GetOutControlByCompleteName( const std::string& ) const;

        NamesList GetInPortsConnectedTo( const std::string & ) const;
        NamesList GetInControlsConnectedTo( const std::string & ) const;
        InPortsList GetInPortsConnectedTo( OutPortBase & ) const;

        std::string GetConnectorIdentifier( const std::string& ) const;
        std::string GetProcessingIdentifier( const std::string& ) const;

        bool IsReady() const;

        bool IsEmpty() const;

        bool HasMisconfiguredProcessings() const;

        bool HasUnconnectedInPorts() const;

        bool HasSyncSource() const;

        std::string GetConfigurationErrors() const;
        std::string GetUnconnectedInPorts() const;

private:
        // fields
        std::string _name;
        ProcessingsMap _processings;
        FlowControl* _flowControl;
        NetworkPlayer* _player;

        // attributes for canvas copy & paste
        mutable NamesSet _selectedProcessings;
        bool _setPasteMode;
        
        bool HasSelectionAndContains(const std::string & name) const;

        // attributes for canvas processing geometries
        mutable ProcessingsGeometriesMap _processingsGeometries;
        void StringPairToInts(const std::string & geometryInString, int & a, int & b);
        const std::string IntsToString (const int & a, const int & b) const;

};

}// namespace
#endif

---