controller.h

Go to the documentation of this file.

//--------------------------------------------------
//---------------------------------------------------

#ifndef IMEDGINE_CONTROLLER_H
#define IMEDGINE_CONTROLLER_H

#include "data_view_mediator.h"
#include "../datasets/dataset.h"
#include "../viewer/view.h"
#include "../datasets/data_io_factory.h"

#include "../algorithms/algorithm_factory.h"
#include "../algorithms/algorithm_config.h"
#include "../global/global_definitions.h"
#include "../exceptions/null_pointer_exception.h"
#include "../exceptions/algorithm_not_found_exception.h"
#include "../exceptions/dataset_not_found_exception.h"
#include "../exceptions/null_pointer_exception.h"
#include "../exceptions/format_not_supported_exception.h"
#include "../exceptions/invalid_cast_exception.h"

#include <boost/shared_ptr.hpp>

#include <memory>
#include <string>
#include <vector>
#include <itkImage.h>

#include <QObject>

namespace imedgine 
{

  //--------------------------------------------------

  //--------------------------------------------------
  //---------------------------------------------------

  class Controller : public QObject
  {        
    Q_OBJECT
        
  public:
    
    //--------------------------------------------------
    
    typedef std::string dataset_key_type;
   
    //--------------------------------------------------

    static Controller& getInstance();
    
    //--------------------------------------------------
 
    std::pair<dataset_key_type, dataset_type>  loadDataset(std::string filename)
        throw(FormatNotSupportedException, NullPointerException); 
    
    //--------------------------------------------------
 
    void writeDataset(dataset_key_type dataset_key, std::string filename)
        throw(DatasetNotFoundException, FormatNotSupportedException); 
    
    //--------------------------------------------------
    
    bool removeDataset(dataset_key_type dataset_key);
    
    //--------------------------------------------------
       
    std::string const& getDatasetFilename(dataset_key_type dataset_key)
        throw(DatasetNotFoundException);
    
    //--------------------------------------------------
    
    void getLoadedDatasetKeys(std::vector<dataset_key_type>& key_container) const;
    
    //--------------------------------------------------

    dataset_pointer_type getDataset(dataset_key_type dataset_key) const
        throw(DatasetNotFoundException);
    
    //--------------------------------------------------

    metadata_pointer_type getMetadataFor(dataset_key_type dataset_key) const
        throw(DatasetNotFoundException, NullPointerException);
    
    //--------------------------------------------------
    
    void getDatasetKeysOfType(dataset_type type, 
                              dataset_key_container_type& dataset_key_container)
        throw(NullPointerException);
    
    //--------------------------------------------------
    
    void getDatasetKeysOfTypes(AlgorithmDefinition::accepted_datasets_type types, 
                               dataset_key_container_type& dataset_key_container)
        throw(NullPointerException);
     
    //--------------------------------------------------

    view_pointer_type getViewOfDataset(
        view_type type, dataset_key_type dataset_key)
        throw(DatasetNotFoundException);
    
    //--------------------------------------------------
    
    void getDependentViewIDsOfDataset(
        dataset_key_type dataset_key, view_id_container_type& target_container) const
        throw(DatasetNotFoundException, NullPointerException);
    
    //--------------------------------------------------
    
    view_type getViewTypeForDatasetSlice(dataset_key_type dataset_key, slice_type slice)
        throw(DatasetNotFoundException);
    
    //--------------------------------------------------
    
    slice_type getDatasetSliceForViewType(
        dataset_key_type dataset_key, view_type type)
        throw(DatasetNotFoundException);
    
    //--------------------------------------------------
    
    void deleteViews(view_id_container_type view_ids)
        throw(NullPointerException);  
    
    //--------------------------------------------------
    
    void loadConfiguration(std::string config_file_name);
    
    //--------------------------------------------------
    
    algorithm_name_container_type getLoadedAlgorithmNames() const;

    //--------------------------------------------------
    
    AlgorithmConfig::algorithm_definition_pointer_type
      getAlgorithmDefinition(std::string name) const
      throw(AlgorithmNotFoundException);
  
    //--------------------------------------------------
    
    void runAlgorithm(std::string key, configuration_pointer_type algorithm_config)
      throw(AlgorithmNotFoundException, NullPointerException);

    //--------------------------------------------------

    config_widget_pointer_type createConfigWidget(
      std::string key) const
        throw(AlgorithmNotFoundException, NullPointerException);
    
    //--------------------------------------------------
    
    configuration_pointer_type createConfiguration(std::string key) const
      throw(AlgorithmNotFoundException, NullPointerException);

    //--------------------------------------------------
    
    void loadAlgorithm(std::string name) 
      throw(AlgorithmNotFoundException);
  
    //--------------------------------------------------

    bool isAlgorithmLoaded(std::string name);

    //--------------------------------------------------

    metadata_pointer_type getMetadataForDataset(std::string dataset_key) const
      throw(DatasetNotFoundException, NullPointerException);

    //--------------------------------------------------

    void setGuiInteractionMode(gui_interaction_mode_type gui_interaction_mode);

    //--------------------------------------------------

    gui_interaction_mode_type getGuiInteractionMode();
    
    //--------------------------------------------------
    
    void setInputDatasetsInConfiguration(configuration_pointer_type configuration, 
      config_dataset_id_to_input_map_type input_datasets,
      std::map<config_dataset_id_type, std::pair<dataset_key_type, dataset_type> >& 
          new_dataset_keys_and_types)
        throw(NullPointerException, DatasetNotFoundException, InvalidCastException);
    
    //--------------------------------------------------
    
    void setOutputDatasetsInConfiguration(configuration_pointer_type configuration,
      config_dataset_id_to_output_map_type output_datasets,
      std::map<config_dataset_id_type, std::pair<dataset_key_type, dataset_type> >& 
          new_dataset_keys_and_types)
        throw(NullPointerException);
    
  public slots:
   
    //--------------------------------------------------
    void datasetChangedSlot(dataset_key_type const& dataset_key);
  
  private:
    
    //--------------------------------------------------
    
    Controller();

    //--------------------------------------------------
    
    ~Controller();
    
    //--------------------------------------------------
    
    Controller( const Controller& );

    //--------------------------------------------------
    
    Controller& operator=( const Controller& );

    //--------------------------------------------------
    
    std::string extractExtension(std::string filename) const;
    
    //--------------------------------------------------
    
    dataset_key_type generateDatasetKeyFromFilename(
        std::string filename) const;
      
    
    //--------------------------------------------------
    
    void makeDatasetKeyUnique(dataset_key_type& key) const;
    
    //--------------------------------------------------
    
    slice_type datasetPartToSliceType(dataset_part_type dataset_part);
    
    typedef std::map<dataset_key_type, dataset_pointer_type> 
        dataset_pointer_map_type;
    typedef dataset_pointer_map_type::iterator 
        dataset_pointer_map_iterator_type;
    typedef dataset_pointer_map_type::const_iterator 
        dataset_pointer_map_const_iterator_type;
    typedef std::map<dataset_key_type, std::string> dataset_filename_map_type;
    typedef dataset_filename_map_type::const_iterator
        dataset_filename_map_const_iterator_type;
    
    //--------------------------------------------------
    DataIOFactory data_io_factory_;
    
    //--------------------------------------------------
    AlgorithmConfig::algorithm_config_pointer_type algorithm_config_;
    
    //--------------------------------------------------
    AlgorithmFactory algorithm_factory_;
     
    //--------------------------------------------------
    dataset_pointer_map_type dataset_pointer_map_;
    
    //--------------------------------------------------
    dataset_filename_map_type dataset_filename_map_;

    //--------------------------------------------------
    DataViewMediator data_view_mediator_;

    //--------------------------------------------------
    gui_interaction_mode_type gui_interaction_mode_;
  };
}

#endif // IMEDGINE_CONTROLLER_H

---