ObjectGenerator.h

Go to the documentation of this file.

// -*- C++ -*-

// ObjectGenerator.h
// Copyright (C) 2004 Rejean Ducharme
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
// 
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
// 
//  3. The name of the authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
// NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org

/* *******************************************************      
   * $Id: ObjectGenerator.h,v 1.4 2004/07/21 16:30:53 chrish42 Exp $
   ******************************************************* */

#include <plearn/base/Object.h>
#include <plearn/math/TVec.h>

#ifndef ObjectGenerator_INC
#define ObjectGenerator_INC

namespace PLearn {
using namespace std;

class ObjectGenerator: public Object
{
private:
  typedef Object inherited;

protected:

  bool generation_began;

public:

  PP<Object> template_object;


 // ******************
 // * Object methods *
 // ******************

private:
  void build_();

protected:
  static void declareOptions(OptionList& ol);

public:

  ObjectGenerator();

  virtual PP<Object> generateNextObject() = 0;

  virtual TVec< PP<Object> > generateAllObjects();

  virtual void build();

  virtual void forget();

  PLEARN_DECLARE_ABSTRACT_OBJECT(ObjectGenerator);
};

// Declares a few other classes and functions related to this class
DECLARE_OBJECT_PTR(ObjectGenerator);

} // end of namespace PLearn

#endif // ObjectGenerator_INC

---