SundanceFieldWriterFactory.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                              Sundance
//                 Copyright (2005) Sandia Corporation
// 
// Copyright (year first published) Sandia Corporation.  Under the terms 
// of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government 
// retains certain rights in this software.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library 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
// Lesser General Public License for more details.
//                                                                                 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA                                                                                
// Questions? Contact Kevin Long (krlong@sandia.gov), 
// Sandia National Laboratories, Livermore, California, USA
// 
// ************************************************************************
/* @HEADER@ */

#ifndef SUNDANCE_FIELDWRITER_FACTORY_H
#define SUNDANCE_FIELDWRITER_FACTORY_H

#include "SundanceDefs.hpp"
#include "SundanceFieldWriter.hpp"
#include "PlayaHandle.hpp"

namespace Sundance
{

/**
 * In some contexts the user can't construct a writer directly; for example, during 
 * timestepping the writer might be constructed by the step controller. 
 * FieldWriterFactory provides a way for a user to specify what kind of
 * writer should be created.
 */
class FieldWriterFactory : public Playa::Handle<FieldWriterFactoryBase>
{
public:
  /* Boilerplate handle ctors */
  HANDLE_CTORS(FieldWriterFactory, FieldWriterFactoryBase);

  /** Create a writer with the specified filename */
  FieldWriter createWriter(const string& filename) const ;
};


}

#endif