summaryrefslogtreecommitdiffstats
path: root/qlparser/qtmddaccess.hh
blob: 433f8058f5fb84439ce8c9c763e7f9d7e85736bf (plain)
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
#ifndef _QTMDDACCESS_
#define _QTMDDACCESS_

#include "qlparser/qtoncstream.hh"

#ifndef CPPSTDLIB
#include <ospace/string.h> // STL<ToolKit>
#else
#include <string>
#endif

// forward declarations
class MDDColl;
class MDDCollIter;

/*
* This file is part of rasdaman community.
*
* Rasdaman community is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Rasdaman community 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with rasdaman community.  If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009 Peter Baumann /
rasdaman GmbH.
*
* For more information please see <http://www.rasdaman.org>
* or contact Peter Baumann via <baumann@rasdaman.com>.
*/
/*************************************************************
 *
 *
 * COMMENTS:
 *
 ************************************************************/

//@ManMemo: Module: {\bf qlparser}

/*@Doc:

This class encapsulates a MDDCollection. It gives access to the elements
through the ONC protocol. The list returned by next() consists of just one
element.

*/

class QtMDDAccess : public QtONCStream
{
  public:
    /// constructor getting the collection name if no iterator name is specified
    QtMDDAccess( const std::string& collectionName );

    /// constructor getting collection and iterator name
    QtMDDAccess( const std::string& collectionName, const std::string& iteratorName );

    /// destructor
    virtual ~QtMDDAccess();

    //@Man: Operations of the ONC protocol
    //@{
    ///
    void        open();
    ///
    QtDataList* next();
    ///
    void        close();
    ///
    void        reset();
    //@}

    /// prints the tree 
    virtual void printTree( int tab, std::ostream& s = std::cout, QtChildType mode = QT_ALL_NODES );

    /// prints the algebraic expression
    virtual void printAlgebraicExpression( std::ostream& s = std::cout );

    /// method for identification of nodes
    inline virtual const QtNodeType getNodeType() const;

    /// method for retrieving the current MDD collection
    inline MDDColl* getMDDColl();

    /// type checking
    virtual const QtTypeTuple& checkType();

  private:
    /// name of the MDD collection
    std::string collectionName;

    /// name of the iterator
    std::string iteratorName;

    /// pointer to the MDD collection
    MDDColl* mddColl;

    /// pointer to the curent iterator
    MDDCollIter* mddIter;

    /// attribute for identification of nodes
    static const QtNodeType nodeType;
};

#include "qlparser/qtmddaccess.icc"

#endif