SamplePointsGeneratorRandom.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file terralib/sa/core/SamplePointsGeneratorRandom.h
22 
23  \brief This file contains a class to generate samples points using random strategy.
24 
25  \reference Adapted from TerraLib4.
26 */
27 
28 #ifndef __TERRALIB_SA_INTERNAL_SAMPLEPOINTSGENERATORRANDOM_H
29 #define __TERRALIB_SA_INTERNAL_SAMPLEPOINTSGENERATORRANDOM_H
30 
31 // Terralib Includes
33 
34 // STL Includes
35 #include <memory>
36 
37 namespace te
38 {
39  //forward declarations
40  namespace da { class DataSetType; }
41  namespace mem { class DataSet; }
42 
43  namespace sa
44  {
45  /*!
46  \class SamplePointsGeneratorRandom
47 
48  \brief Class to generate samples points using random strategy.
49 
50  */
52  {
53  public:
54 
55  /*! \brief Default constructor. */
57 
58  /*! \brief Virtual destructor. */
59  virtual ~SamplePointsGeneratorRandom();
60 
61  public:
62 
63  /*! Function used to set the number of points to be generated */
64  void setNumberOfPoints(int nPoints);
65 
66  protected:
67 
68  /*! Function used to create the output dataset type */
69  virtual std::auto_ptr<te::da::DataSetType> createDataSetType();
70 
71  /*! Function used to create the output data */
72  virtual std::auto_ptr<te::mem::DataSet> generateSamples(te::da::DataSetType* dsType);
73 
74  protected:
75 
76  int m_nPoints; //!< Attribute used to define the number of points to be generated.
77  };
78  } // end namespace sa
79 } // end namespace te
80 
81 
82 #endif // __TERRALIB_SA_INTERNAL_SAMPLEPOINTSGENERATORRANDOM_H
A class that models the description of a dataset.
Definition: DataSetType.h:72
int m_nPoints
Attribute used to define the number of points to be generated.
URI C++ Library.
Virtual class to generate samples points.
Class to generate samples points using random strategy.
#define TESAEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:133
This file contains a virtual class to generate samples points.