woss-creator-container.h

Go to the documentation of this file.

/* WOSS - World Ocean Simulation System -
 * 
 * Copyright (C) 2009 2025 Federico Guerra
 * and regents of the SIGNET lab, University of Padova
 *
 * Author: Federico Guerra - WOSS@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
 */ 
 

 
 
#ifndef WOSS_CREATOR_CONTAINER_DEFINITIONS_H
#define WOSS_CREATOR_CONTAINER_DEFINITIONS_H
 
 
#include <string>
#include <map>
#include <memory>
#include <iostream>
#include <definitions-handler.h>
#include <type_traits>
 
 
namespace woss {
  
  struct CustomTransducer {
     
    CustomTransducer( const std::string& name = "", double bearing = 0.0, double vert_rot = 0.0, double horiz_rot = 0.0, double mult = 1.0, double add = 0.0 ) 
      : type(name), initial_bearing(bearing), initial_vert_rotation(vert_rot), initial_horiz_rotation(horiz_rot), multiply_costant(mult), add_costant(add) { }
 
    friend std::ostream& operator<<( std::ostream& os, const CustomTransducer& instance ) {
      os << "type name = " << instance.type <<"; initial bearing = " << instance.initial_bearing
         << "; initial vertical rotation = " << instance.initial_vert_rotation 
         << "; initial horizontal rotation = " << instance.initial_horiz_rotation
         << "; mult costant = " << instance.multiply_costant << "; add costant = "
         << instance.add_costant;
      return os;
    }
  
    std::string type;

    double initial_bearing;
    
    double initial_vert_rotation;
    
    double initial_horiz_rotation;
   
    double multiply_costant;

    double add_costant;
 
  };

  template< typename Data > 
  class WossCreatorContainer {
  
    public:

    static std::shared_ptr<Location> ALL_LOCATIONS;

    static const CoordZ ALL_COORDZ;
 
    WossCreatorContainer() = default;
    
    ~WossCreatorContainer() = default;
   
    bool isEmpty() const;

    int size() const;

    bool insert( const Data& data, const std::shared_ptr<Location>& tx, const std::shared_ptr<Location>& rx );

    bool insert( const Data& data, const CoordZ& tx, const CoordZ& rx );

    Data get( const std::shared_ptr<Location>& tx, const std::shared_ptr<Location>& rx  ) const;

    Data get( const CoordZ& tx, const CoordZ& rx ) const;

    Data& accessAllLocations();

    void erase( const std::shared_ptr<Location>& tx, const std::shared_ptr<Location>& rx );
    
    void erase( const CoordZ& tx, const CoordZ& rx );

    void replace( const Data& data, const std::shared_ptr<Location>& tx, const std::shared_ptr<Location>& rx );

    void replace( const Data& data, const CoordZ& tx, const CoordZ& rx );

    void clear();

    void setDebug( bool flag ) { debug = flag; }

    bool isUsingDebug() const { return debug; }
 
    protected:

    using InnerContainer = std::map< std::shared_ptr<Location>, Data >;
    using ICIter = typename InnerContainer::iterator;
    using ICRIter = typename InnerContainer::reverse_iterator;
    using ICCIter = typename InnerContainer::const_iterator;
    using ICCRIter = typename InnerContainer::const_reverse_iterator;

    using DataContainer = std::map< std::shared_ptr<Location>, InnerContainer >;
    using DCIter = typename DataContainer::iterator;
    using DCCIter = typename DataContainer::const_iterator;
    using DCRIter = typename DataContainer::reverse_iterator;
    using DCRCIter = typename DataContainer::const_reverse_iterator;

    DCIter find( const CoordZ& coordinates );

    ICIter find( const CoordZ& coordinates, const DCIter& iter );

    std::shared_ptr<Location> createLocation( const CoordZ& coordinates );

    DataContainer data_container;

    bool debug = false;
 
  };
 
 
  template< typename Data > 
  std::shared_ptr<Location> WossCreatorContainer< Data >::ALL_LOCATIONS = nullptr;
 
 
  template< typename Data > 
  const CoordZ WossCreatorContainer< Data >::ALL_COORDZ = CoordZ();
 
 
  template< typename Data >
  inline bool WossCreatorContainer< Data >::isEmpty() const {
    return data_container.empty();
  }
 
 
  template< typename Data >
  inline int WossCreatorContainer< Data >::size() const {
    return data_container.size();
  }
 
 
  template< typename Data >
  inline std::shared_ptr<Location> WossCreatorContainer< Data >::createLocation( const CoordZ& coordinates ) {
    if ( coordinates == ALL_COORDZ ) 
      return nullptr;
    return std::move( SDefHandler::instance().createLocation(coordinates) );
  }
 
 
  template< typename Data >
  typename WossCreatorContainer< Data >::DCIter WossCreatorContainer< Data >::find( const CoordZ& coordinates ) {
    auto it_all_loc = data_container.end();
 
    for ( auto it = data_container.begin(); it != data_container.end(); it++ ) {
      if ( it->first == ALL_LOCATIONS ) {
        it_all_loc = it;
        if ( coordinates == ALL_COORDZ ) 
          break;
        else 
          continue;
      }
      if ( it->first->isEquivalentTo( coordinates ) ) {
        if (debug) 
          std::cout << "WossCreatorContainer::find() tx coordinates found = " 
                    << coordinates << std::endl;
        return it;
      }
    }
   
    if ( coordinates == ALL_COORDZ && it_all_loc != data_container.end() ) {
      if (debug) 
        std::cout << "WossCreatorContainer::find() tx ALL_COORDZ found" << std::endl;
      return it_all_loc;
    }
    
    if (debug && coordinates != ALL_COORDZ ) 
      std::cout << "WossCreatorContainer::find() tx coordinates not found = " 
                << coordinates << std::endl; 
    
    if (debug && coordinates == ALL_COORDZ ) 
      std::cout << "WossCreatorContainer::find() tx ALL_COORDZ not found" << std::endl;
    return data_container.end();
  } 
 
 
  template< typename Data >  
  typename WossCreatorContainer< Data >::ICIter WossCreatorContainer< Data >::find( const CoordZ& coordinates, const DCIter& iter ) {
    auto it_all_loc = iter->second.end();
    
    for ( auto it = iter->second.begin(); it != iter->second.end(); it++ ) {
      if ( it->first == ALL_LOCATIONS ) {
        it_all_loc = it;
        if ( coordinates == ALL_COORDZ ) 
          break;
        else 
          continue;
      }
      if ( it->first->isEquivalentTo( coordinates ) ) {
        if (debug) 
          std::cout << "WossCreatorContainer::find() rx coordinates found = " 
                    << coordinates << std::endl;
        return it;
      }
    }
   
    if ( coordinates == ALL_COORDZ && it_all_loc != iter->second.end() ) {
      if (debug) 
        std::cout << "WossCreatorContainer::find() rx ALL_COORDZ found" << std::endl;
      return it_all_loc;
    }
    
    if (debug && coordinates != ALL_COORDZ ) 
      std::cout << "WossCreatorContainer::find() rx coordinates not found = " 
                << coordinates << std::endl; 
    
    if (debug && coordinates == ALL_COORDZ ) 
      std::cout << "WossCreatorContainer::find() rx ALL_COORDZ not found" << std::endl;
    return iter->second.end(); 
  }
  
  
  template< typename Data >  
  inline bool WossCreatorContainer< Data >::insert( const Data& data, const std::shared_ptr<Location>& tx, const std::shared_ptr<Location>& rx ) { 
    auto it = data_container.find(tx);
    if ( it == data_container.end() ) {
      data_container[tx][rx] = data;
      return true;
    }
    auto it2 = it->second.find(rx);
    if ( it2 == it->second.end() ) {
      (it->second)[rx] = data;
      return true;
    }
    return false;
  }
 
 
  template< typename Data >
  inline bool WossCreatorContainer< Data >::insert( const Data& data, const CoordZ& tx, const CoordZ& rx ) { 
    auto it = find( tx );
    if ( it == data_container.end() ) {
      data_container[ createLocation(tx) ][ createLocation(rx) ] = data; 
      return true;
    }
    auto it2 = find( rx, it );
    if ( it2 == it->second.end() ) {
      (it->second)[ createLocation(rx) ] = data;
      return true;
    }
    return false;
  }
 
 
  template< typename Data >
  inline Data WossCreatorContainer< Data >::get( const std::shared_ptr<Location>& tx, const std::shared_ptr<Location>& rx ) const { 
    auto it = const_cast< typename WossCreatorContainer< Data >::DataContainer& >(data_container).find( tx );
    bool tx_changed_to_all_locations = false;
 
    if ( tx != ALL_LOCATIONS ) {
      if ( it == data_container.end() ) {
        if ( debug ) 
          std::cout << "WossCreatorContainer::get() no tx location found = " << *tx 
                    << "; trying ALL_LOCATIONS"<< std::endl;
 
        it = const_cast< typename WossCreatorContainer< Data >::DataContainer& >(data_container).find( ALL_LOCATIONS );
        tx_changed_to_all_locations = true;
      }
 
      if ( debug ) 
        std::cout << "WossCreatorContainer::get() tx location found = " << *tx << std::endl;
    }
    
    if ( it != data_container.end() ) {
      auto it2 = it->second.find( rx );
 
      if ( rx != ALL_LOCATIONS ) {
        if ( it2 == it->second.end() ) {
          if ( debug ) 
            std::cout << "WossCreatorContainer::get() no rx location found = " << *rx 
                      << "; trying ALL_LOCATIONS"<< std::endl;
 
          it2 = it->second.find( ALL_LOCATIONS );
        }
 
        if ( debug ) 
          std::cout << "WossCreatorContainer::get() rx location found = " << *rx << std::endl;
      }
      
      if ( it2 != it->second.end() ) {
        // Special handling for CustomTransducer
        if constexpr (std::is_same_v<Data, CustomTransducer>) {
          // If we're getting a CustomTransducer, we need to rotate the angles based on location orientation
          const auto& original_data = it2->second;
          if (tx_changed_to_all_locations == true) {
            return CustomTransducer(original_data);
          } else {
            if ( debug ) 
              std::cout << "WossCreatorContainer::get() rotating angle" << std::endl;
 
            return CustomTransducer(
              original_data.type,
              it->first->getBearing(),
              (original_data.initial_vert_rotation + it->first->getVerticalOrientation()),
              (original_data.initial_horiz_rotation + it->first->getHorizontalOrientation()),
              original_data.multiply_costant,
              original_data.add_costant
            );
          }
        } else {
          return it2->second;
        }
      }
    }
     
    std::cerr << "WARNING: WossCreatorContainer::get() no tx nor rx location found, returning default constructor!!" << std::endl;
 
    return Data();
  }
 
 
  template< typename Data >
  inline Data& WossCreatorContainer< Data >::accessAllLocations() {
    return data_container[ALL_LOCATIONS][ALL_LOCATIONS];
  }
 
  
  template< typename Data >
  inline Data WossCreatorContainer< Data >::get( const CoordZ& tx, const CoordZ& rx ) const { 
    auto it = const_cast< WossCreatorContainer< Data >& >(*this).find( tx );
    bool tx_changed_to_all_coordz = false;
 
    if ( tx != ALL_COORDZ ) {
      if ( it == data_container.end() ) {
        if ( debug ) 
          std::cout << "WossCreatorContainer::get() no tx coord found = " << tx 
                    << "; trying ALL_COORDZ"<< std::endl;
 
        it = const_cast< WossCreatorContainer< Data >& >(*this).find( ALL_COORDZ );
        tx_changed_to_all_coordz = true;
      }
 
      if ( debug ) 
        std::cout << "WossCreatorContainer::get() tx coord found = " << tx << std::endl;
    }
    
    if ( it != data_container.end() ) {
      auto it2 = const_cast< WossCreatorContainer< Data >& >(*this).find( rx, it );
 
      if ( rx != ALL_COORDZ ) {
        if ( it2 == it->second.end() ) {
          if ( debug ) 
            std::cout << "WossCreatorContainer::get() no rx coord found = " << rx 
                      << "; trying ALL_COORDZ"<< std::endl;
 
          it2 = const_cast< WossCreatorContainer< Data >& >(*this).find( ALL_COORDZ, it );
        }
 
        if ( debug ) 
          std::cout << "WossCreatorContainer::get() rx coord found = " << rx << std::endl;
      }
 
      if ( it2 != it->second.end() ) {
        if ( debug ) 
          std::cout << "WossCreatorContainer::get() value found = " << it2->second << std::endl;
 
        // Special handling for CustomTransducer
        if constexpr (std::is_same_v<Data, CustomTransducer>) {
          // If we're getting a CustomTransducer, we need to rotate the angles based on location orientation
          const auto& original_data = it2->second;
          if (tx_changed_to_all_coordz == true) {
            return CustomTransducer(original_data);
          } else {
            if ( debug ) 
              std::cout << "WossCreatorContainer::get() rotating angle" << std::endl;
 
            return CustomTransducer(
              original_data.type,
              it->first->getBearing(),
              (original_data.initial_vert_rotation + it->first->getVerticalOrientation()),
              (original_data.initial_horiz_rotation + it->first->getHorizontalOrientation()),
              original_data.multiply_costant,
              original_data.add_costant
            );
          }
        } else {
          return it2->second;
        }
      }
    }
    std::cerr << "WARNING: WossCreatorContainer::get() no tx nor rx coordinates found, returning default constructor!!" << std::endl;
 
    return Data();
  }
 
 
  template< typename Data >
  inline void WossCreatorContainer< Data >::erase( const std::shared_ptr<Location>& tx, const std::shared_ptr<Location>& rx ) { 
    auto it = data_container.find(tx);
    if ( it != data_container.end() ) {
      it->second.erase( rx );
      if ( it->second.empty() ) 
        data_container.erase(it);
    }
  }
 
 
  template< typename Data >
  inline void WossCreatorContainer< Data >::erase( const CoordZ& tx, const CoordZ& rx ) { 
    for ( auto it = data_container.begin(); it != data_container.end();  ) {
      bool tx_found = false;
 
      if ( it->first != ALL_LOCATIONS ) {
         if ( it->first->isEquivalentTo( tx ) ) 
            tx_found = true;
      } else {
         if ( tx == ALL_COORDZ ) 
            tx_found = true;
      }
 
      if ( tx_found ) {
        for ( auto it2 = it->second.begin(); it2 != it->second.end(); ) {
           bool rx_found = false;
 
           if ( it2->first != ALL_LOCATIONS ) {
              if ( it2->first->isEquivalentTo( rx ) ) 
                rx_found = true;
           } else {
              if ( rx == ALL_COORDZ ) 
                rx_found = true;
           }
 
          if ( rx_found ) 
            it->second.erase(it2++);
          else 
            ++it2;
        }
        
      } 
        
      if ( it->second.empty() ) 
        data_container.erase(it++);
      else ++it;
    }  
  }
 
 
  template< typename Data >
  inline void WossCreatorContainer< Data >::replace( const Data& data, const std::shared_ptr<Location>& tx, const std::shared_ptr<Location>& rx ) { 
    data_container[tx][rx] = data;
  }
 
 
  template< typename Data >
  inline void WossCreatorContainer< Data >::replace( const Data& data, const CoordZ& tx, const CoordZ& rx ) { 
    auto it = find( tx );
    if ( it == data_container.end() ) {
      data_container[ createLocation(tx) ][ createLocation(rx) ] = data; 
      return;
    }
    auto it2 = find( rx, it );
    if ( it2 == it->second.end() ) {
      (it->second)[ createLocation(rx) ] = data;
      return;
    }
    it2->second = data;
  }
 
 
  template< typename Data >
  inline void WossCreatorContainer< Data >::clear() { 
    data_container.clear();
  }
 
 
} // namespace woss
 
 
#endif // WOSS_CREATOR_CONTAINER_DEFINITIONS_H