GenericWriter.h

Go to the documentation of this file.

/*
   For more information, please see: http://software.sci.utah.edu

   The MIT License

   Copyright (c) 2009 Scientific Computing and Imaging Institute,
   University of Utah.

   
   Permission is hereby granted, free of charge, to any person obtaining a
   copy of this software and associated documentation files (the "Software"),
   to deal in the Software without restriction, including without limitation
   the rights to use, copy, modify, merge, publish, distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included
   in all copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
   DEALINGS IN THE SOFTWARE.
*/

/// 
/// @author
///    Steven G. Parker
///    Department of Computer Science
///    University of Utah
/// @date   July 1994
/// 

///@details
///  Limitations:
///    Uses .tcl file with "filename" and "filetype"
///    Input port must be of type SimpleIPort


#include <Dataflow/GuiInterface/GuiVar.h>

#include <Dataflow/Network/Module.h>
#include <Core/Persistent/Pstreams.h>
#include <Core/Datatypes/String.h>
#include <Core/Util/FullFileName.h>
#include <Dataflow/Network/Ports/StringPort.h>

namespace SCIRun {


template <class HType>
class GenericWriter : public Module {
protected:
  HType       handle_;
  GuiFilename filename_;
  GuiString   filetype_;
  GuiInt      confirm_;
    GuiInt          confirm_once_;
  bool        exporting_;

  virtual bool overwrite();
  virtual bool call_exporter(const std::string &filename);

public:
  GenericWriter(const std::string &name, GuiContext* ctx,
        const std::string &category, const std::string &package);
  virtual ~GenericWriter() { }

  virtual void execute();
};


template <class HType>
GenericWriter<HType>::GenericWriter(const std::string &name, GuiContext* ctx,
                    const std::string &cat, const std::string &pack)
  : Module(name, ctx, Sink, cat, pack),
    filename_(get_ctx()->subVar("filename"), ""),
    filetype_(get_ctx()->subVar("filetype"), "Binary"),
    confirm_(get_ctx()->subVar("confirm"), sci_getenv_p("SCIRUN_CONFIRM_OVERWRITE")),
        confirm_once_(get_ctx()->subVar("confirm-once"),0),
    exporting_(false)
{
}


template <class HType>
bool
GenericWriter<HType>::overwrite()
{
  std::string result;
  TCLInterface::eval(get_id() + " overwrite", result);
  if (result == std::string("0"))
  {
    warning("User chose to not save.");
    return false;
  }
  return true;
}
  

template <class HType>
bool
GenericWriter<HType>::call_exporter(const std::string &/*filename*/)
{
  return false;
}


template <class HType>
void
GenericWriter<HType>::execute()
{
  get_input_handle(0,handle_,true);
  
  StringHandle filename;
  if (get_input_handle("Filename",filename,false)) 
  {
        // This piece of code makes sure that the path to the output
        // file exists and that we use an absolute filename
        FullFileName ffn(filename->get());
        if (!(ffn.create_file_path()))
        {
            error("Could not create path to filename");
            return;
        }
        filename = new String(ffn.get_abs_filename());

    filename_.set(filename->get());
    get_ctx()->reset();
  }
  
  // If no name is provided, return.

  std::string fn(filename_.get());
  if (fn == "")
  {
    warning("No filename specified.");
    return;
  }

  update_state(Executing);
  remark("saving file " +fn);

  if (!overwrite()) return;
 
  if (exporting_)
  {
    if (!call_exporter(fn))
    {
      error("Export failed.");
      return;
    }
  }
  else
  {
    // Open up the output stream
    PiostreamPtr stream;
    std::string ft(filetype_.get());
    if (ft == "Binary")
    {
      stream = auto_ostream(fn, "Binary", this);
    }
    else
    {
      stream = auto_ostream(fn, "Text", this);
    }

    if (stream->error())
    {
      error("Could not open file for writing" + fn);
    }
    else
    {
      // Write the file
      Pio(*stream, handle_);
    } 
  }
}

} // End namespace SCIRun