WDataSetSingle.h 2.02 KB
Newer Older
wiebel's avatar
wiebel committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
//---------------------------------------------------------------------------
//
// Project: OpenWalnut
//
// Copyright 2009 SomeCopyrightowner
//
// This file is part of OpenWalnut.
//
// OpenWalnut 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 3 of the License, or
// (at your option) any later version.
//
// OpenWalnut 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 OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
//
//---------------------------------------------------------------------------

#ifndef WDATASETSINGLE_H
#define WDATASETSINGLE_H

#include <boost/shared_ptr.hpp>
math's avatar
math committed
28

wiebel's avatar
wiebel committed
29 30 31 32 33 34 35 36
#include "WDataSet.h"

class WValueSet;
class WGrid;

/**
 * A data set consisting of a set of values based on a grid.
 */
math's avatar
math committed
37
class WDataSetSingle : public WDataSet
wiebel's avatar
wiebel committed
38 39
{
public:
math's avatar
math committed
40 41 42
    /**
     * Constructs an instance out of a value set, grid and meta information.
     */
wiebel's avatar
wiebel committed
43 44 45
    WDataSetSingle( boost::shared_ptr<WValueSet> newValueSet,
                    boost::shared_ptr<WGrid> newGrid,
                    boost::shared_ptr<WMetaInfo> newMetaInfo );
math's avatar
math committed
46 47 48 49

    /**
     * Destroys this DataSet instance
     */
wiebel's avatar
wiebel committed
50
    virtual ~WDataSetSingle();
math's avatar
math committed
51 52 53 54

    /**
     * \return Reference to its WValueSet
     */
wiebel's avatar
wiebel committed
55
    boost::shared_ptr<WValueSet> getValueSet() const;
math's avatar
math committed
56 57 58 59

    /**
     * \return Reference to its WGrid
     */
wiebel's avatar
wiebel committed
60 61 62
    boost::shared_ptr<WGrid> getGrid() const;

private:
math's avatar
math committed
63 64 65
    /**
     * Stores the reference of the WGrid of this DataSetSingle instance.
     */
wiebel's avatar
wiebel committed
66
    boost::shared_ptr< WGrid > m_grid;
math's avatar
math committed
67 68 69 70

    /**
     * Stores the reference of the WValueSet of this DataSetSingle instance.
     */
wiebel's avatar
wiebel committed
71 72 73 74
    boost::shared_ptr< WValueSet > m_valueSet;
};

#endif  // WDATASETSINGLE_H