woss-manager.h

Go to the documentation of this file.

/* WOSS - World Ocean Simulation System -
 * 
 * Copyright (C) 2009 Federico Guerra
 * and regents of the SIGNET lab, University of Padova
 *
 * Author: Federico Guerra - federico@guerra-tlc.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * 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
 */ 
 
/*
 * This software has been developed by Federico Guerra and SIGNET lab,
 * University of Padova, in collaboration with the NATO Centre for 
 * Maritime Research and Experimentation (http://www.cmre.nato.int ; 
 * E-mail: pao@cmre.nato.int), whose support is gratefully acknowledged.
 */
 
 
#ifndef WOSS_MANAGER_DEFINITIONS_H
#define WOSS_MANAGER_DEFINITIONS_H
 
 
#include <definitions-handler.h>
#include <time-arrival-definitions.h>
#include "woss-creator.h"
#include <woss-db-manager.h>
 
 
namespace woss {
 
  
  typedef ::std::pair< CoordZ, CoordZ > CoordZPair;
  
  typedef ::std::vector< CoordZPair > CoordZPairVect;
  
  
  typedef ::std::pair< double, double > SimFreq;
  
  typedef ::std::vector< SimFreq > SimFreqVector;
 
  
  typedef ::std::vector< Pressure* > PressureVector;
 
  typedef ::std::vector< TimeArr* > TimeArrVector;
  
    
  class WossManager {
 
                
    public:
      
    
    WossManager();   
    
    virtual ~WossManager();
    
        
    virtual const Woss& getActiveWoss( const CoordZ& tx, const CoordZ& rx, double start_frequency, double end_frequency ) const;        
    
    virtual WossManager& eraseActiveWoss( const CoordZ& tx, const CoordZ& rx, double start_frequency, double end_frequency ) = 0;
    
    virtual WossManager& eraseAllWoss() = 0;
        
    virtual Pressure* getWossPressure( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, const Time& time_value ) = 0;
    
    virtual Pressure* getWossPressure( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, double time_value = 0.0 );
    
    virtual PressureVector getWossPressure( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, const Time& time_value );
    
    virtual PressureVector getWossPressure( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, double time_value = 0.0 );
        
    virtual TimeArr* getWossTimeArr( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, const Time& time_value ) = 0;
    
    virtual TimeArr* getWossTimeArr( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, double time_value = 0.0 );
        
    virtual TimeArrVector getWossTimeArr( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, const Time& time_value );
   
    virtual TimeArrVector getWossTimeArr( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, double time_value = 0.0 );
   
    
    virtual bool reset() = 0;
 
 
    virtual bool timeEvolve( const Time& time_value ) = 0;
 
 
    WossManager& setWossCreator( const WossCreator* const ptr ) { woss_creator = ptr; return *this; }
        
    void setTimeEvolutionActiveFlag( bool flag ) { is_time_evolution_active = flag; }
  
    void setDebugFlag( bool flag ) { debug = flag; }
    
    
    const WossCreator* const getWossCreator() { return woss_creator; }
    
    bool getTimeEvolutionActiveFlag() { return (bool)is_time_evolution_active; }
    
    bool getDebugFlag() { return (bool)debug; }
    
    
    protected:
      
    
    static const Time NO_EVOLUTION_TIME;
    
    
    const WossCreator* woss_creator;
    
  
    bool debug;
  
                
    bool is_time_evolution_active;  
    
                
    virtual Woss* const getWoss( const CoordZ& tx, const CoordZ& rx, double start_frequency, double end_frequency ) = 0;
    
    
  };
 
 
  class WossManagerResDb : public WossManager {
 
    
    public:
      
      
    WossManagerResDb();
    
    virtual ~WossManagerResDb() {}
    
 
    virtual Pressure* getWossPressure( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, const Time& time_value );
    
//     virtual Pressure* getWossPressure( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, double time_value );
        
    virtual TimeArr* getWossTimeArr( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, const Time& time_value );
    
//     virtual TimeArr* getWossTimeArr( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, double time_value );
    
    
    WossManagerResDb& setWossDbManager( const WossDbManager* const ptr ) { woss_db_manager = ptr; return *this; }
    
    
    protected:
      
      
    const WossDbManager* woss_db_manager;
    
    
    TimeArr* dbGetTimeArr( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value ) const;
    
    void dbInsertTimeArr( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value, const TimeArr& channel ) const;
    
    
    Pressure* dbGetPressure( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value ) const;
 
    void dbInsertPressure( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value, const Pressure& press ) const;
 
    
  };
 
 
  //inline functions
  inline void WossManagerResDb::dbInsertTimeArr( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value, const TimeArr& channel ) const {
    if ( woss_db_manager ) woss_db_manager->insertTimeArr( tx, rx, frequency, time_value, channel ) ;
  }
 
 
  inline TimeArr* WossManagerResDb::dbGetTimeArr( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value ) const {
    if ( woss_db_manager ) return( woss_db_manager->getTimeArr( tx, rx, frequency, time_value ) );
    return( SDefHandler::instance()->getTimeArr()->create( TimeArr::createNotValid() ) );
  }
 
 
  inline void WossManagerResDb::dbInsertPressure( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value, const Pressure& press ) const {
    if ( woss_db_manager ) woss_db_manager->insertPressure( tx, rx, frequency, time_value, press );
  }
 
 
  inline Pressure* WossManagerResDb::dbGetPressure( const CoordZ& tx, const CoordZ& rx, double frequency, const Time& time_value ) const {
    if ( woss_db_manager ) return( woss_db_manager->getPressure( tx, rx, frequency, time_value ) );
    return( SDefHandler::instance()->getPressure()->create( Pressure::createNotValid() ) );
  }
 
 
  #ifdef WOSS_MULTITHREAD
  
  
  #include <set>
  
  
  #define MAX_TOTAL_PTHREAD 32 
  
  
  class WossManagerResDbMT : public WossManagerResDb {
 
 
    public:
 
 
    WossManagerResDbMT();
    
    virtual ~WossManagerResDbMT();
    
    
    virtual Pressure* getWossPressure( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, const Time& time_value );
    
    virtual Pressure* getWossPressure( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, double time_value );
        
 
    virtual TimeArr* getWossTimeArr( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, const Time& time_value );
 
    virtual TimeArr* getWossTimeArr( const CoordZ& tx_coordz, const CoordZ& rx_coordz, double start_frequency, double end_frequency, double time_value );
    
    
    virtual PressureVector getWossPressure( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, const Time& time_value );
        
    virtual PressureVector getWossPressure( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, double time_value );
            
    virtual TimeArrVector getWossTimeArr( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, const Time& time_value );
 
    virtual TimeArrVector getWossTimeArr( const CoordZPairVect& coordinates, double start_frequency, double end_frequency, double time_value );
    
    void setConcurrentThreads( int number ) { concurrent_threads = number; checkConcurrentThreads(); }
 
    int getConcurrentThreads() { return concurrent_threads; }
    
    
    friend void* WMSMTcreateThreadTimeArr( void* ptr );
      
    friend void* WMSMTcreateThreadPressure( void* ptr );       
 
    
    protected:   
    
    
    //typedef ::std::pair< CoordZPairVect, SimFreq > ThreadQuery;
    struct ThreadQuery {
      
      
      CoordZPairVect coordz_pair_vect;
      
      SimFreq sim_freq;
 
      int curr_index;
      
      struct {
          bool is_time_object;
          
          Time time_cal;
          
          double time_double;
          
      } time_data;
      
    };
    
    
//     typedef ::std::pair< CoordZPair, SimFreq > ThreadParam;
    struct ThreadParam {
      
      
      CoordZPair coordz_pair;
      
      SimFreq sim_freq;
      
      struct {
          bool is_time_object;
          
          Time time_cal;
          
          double time_double;
          
      } time_data;
      
      
    };
    
    
    typedef ::std::pair< int, ThreadParam > ThreadParamIndex;
    
    
    struct ThreadCondSignal {
    
      
      ThreadCondSignal() { pthread_mutex_init( &mutex, NULL ); pthread_cond_init( &condition, NULL );  }
      
      ~ThreadCondSignal() { pthread_mutex_destroy( &mutex ); pthread_cond_destroy( &condition ); }
      
      
      pthread_mutex_t mutex;
      
      pthread_cond_t condition;
      
      
    };
    
    
    typedef ::std::map< Woss*, ThreadCondSignal* > ActiveWoss;
    typedef ActiveWoss::iterator AWIter;
    typedef ActiveWoss::reverse_iterator AWRIter;
    typedef ActiveWoss::const_iterator AWCIter;
    typedef ActiveWoss::const_reverse_iterator AWCRIter;
    
    
    int max_thread_number;    
    
    int total_queries;
 
    int concurrent_threads;
    
       
    volatile int total_thread_created;
       
    volatile int total_thread_ended;
        
 
    pthread_t thread_controller;
    
    pthread_t thread_arr[MAX_TOTAL_PTHREAD];
    
 
    pthread_spinlock_t mutex;
    
    pthread_spinlock_t request_mutex;
   
    
    ThreadQuery thread_query;
      
    
    TimeArrVector thread_time_arr_reply;
    
    PressureVector thread_pressure_reply;
      
    ActiveWoss active_woss;
    
    void checkConcurrentThreads();
    
    void initThreadVars();
 
 
    ThreadParamIndex popThreadParamIndex();
 
    
    void insertThreadReplyTimeArr( int index, woss::TimeArr* time_arr );
    
    void insertThreadReplyPressure( int index, woss::Pressure* pressure );
         
   
  };
  
  
  void* WMSMTcreateThreadTimeArr( void* ptr );
  
  void* WMSMTcreateThreadPressure( void* ptr );
  
  
#endif // WOSS_MULTITHREAD
  
  
}
 
 
#endif /* WOSS_MANAGER_DEFINITIONS_H */