transducer-handler.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_TRANSDUCER_HANDLER_DEFINITIONS_H
#define WOSS_TRANSDUCER_HANDLER_DEFINITIONS_H
 
 
#include <string>
#include <unordered_map>
#include <memory>
 
 
namespace woss {
 
  class Transducer;
 
  class TransducerHandler {
 
    protected:
 
    using TransducerMap = std::unordered_map< std::string, std::unique_ptr<Transducer> >;
    using TMIter = TransducerMap::iterator;
    using TMCIter = TransducerMap::const_iterator;
 
    public:
 
    TransducerHandler();
 
    TransducerHandler( const TransducerHandler& copy ) = default;
 
    TransducerHandler( TransducerHandler&& tmp ) = default;
    
    TransducerHandler( TransducerMap& transduc_map );
 
    virtual ~TransducerHandler() = default;
 
    bool insertValue( const std::string& name, const Transducer& transducer );
 
    TransducerHandler& replaceValue( const std::string& name, const Transducer& transducer );
 
    std::unique_ptr<Transducer> getValue( const std::string& name ) const;
 
    TransducerHandler& eraseValue( const std::string& name );
 
    int size() const;
 
    bool empty() const;
 
    TransducerHandler& clear();
 
    TMCIter begin() const;
 
    TMCIter end() const;
 
    virtual bool importValueAscii( const std::string& type_name, const std::string& file_name );
 
    virtual bool importValueBinary( const std::string& type_name, const std::string& file_name );
 
    virtual bool writeValueAscii( const std::string& type_name, const std::string& file_name );
 
    virtual bool writeValueBinary( const std::string& type_name, const std::string& file_name );    
 
    TransducerHandler& operator=( const TransducerHandler& copy ) = default;
 
    TransducerHandler& operator=( TransducerHandler&& copy ) = default;
 
    TransducerHandler& setDebug( bool flag );
 
    bool getDebug() const { return debug; }
 
    protected:
 
    void initializeNotValid();
 
    static const std::string TRANSDUCER_NOT_VALID;
 
    bool debug;
 
    TransducerMap transducer_map;
 
  };
    
 
  inline int TransducerHandler::size() const {
    return transducer_map.size();
  }
 
  inline bool TransducerHandler::empty() const {
    return transducer_map.empty();
  }
 
  inline TransducerHandler::TMCIter TransducerHandler::begin() const {
    return transducer_map.begin();
  }
 
  inline TransducerHandler::TMCIter TransducerHandler::end() const {
    return transducer_map.end();
  }
 
  inline TransducerHandler& TransducerHandler::setDebug( bool flag ) {
    debug = flag;
    return *this;
  }
 
}
 
#endif // WOSS_TRANSDUCER_HANDLER_DEFINITIONS_H