summaryrefslogtreecommitdiffstats
path: root/qlparser/qtmdd.hh
blob: bbbe195b28c89a201cb300bd81fdb8245c00fc2b (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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
#ifndef _QTMDD_
#define _QTMDD_

#include "qlparser/qtdata.hh"
#include "qlparser/qtscalardata.hh"
#include "catalogmgr/typefactory.hh"
#include "raslib/minterval.hh"

#include <string>
#include <list>

// forward declarations
class MDDObj;
class QtOperation;

/*
* 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:

  The class encapsulates a pointer to an object of type {\tt MDDObj}.
  Its purpose is to have the {\tt MDDObj} object available as a descendant
  of class {\tt QtData}. The class does not care of the memory management
  of the {\tt MDDObj} object.

  Note: The attribute lifetime of the superclass QtData ist set implicit
  in the constructor functions!
*/

class QtMDD : public QtData
{
  public:
    // list of lists of \Ref{QtScalarData} objects
    // typedef list< list<QtScalarData*>* > QtDimensionList;

    /// constructor getting the pointer to the MDDObj object
    QtMDD( MDDObj* ptr );

    /// constructor getting the pointer to the MDDObj object and an iterator name
    QtMDD( MDDObj* ptr, std::string name );

    /// constructor getting a domain expression and a literal list for initializing a transient constant object
    QtMDD( QtOperation* mintervalOp, std::list<QtScalarData*>* literalList );
    /**
      The list of literal objects is not deleted.
    */

    /// constructor getting the number of an mdd constant
    QtMDD( int constantNo );

    /// copy constructor
    QtMDD( const QtMDD& obj );

    /// destructor
    virtual ~QtMDD();

    //@Man: Read/Write methods:
    //@{
    ///
      /// gets the pointer to the MDDObj object
      inline MDDObj* getMDDObject() const;
      /// sets the pointer to the MDDObj object and it does not care about the old pointer
      inline void setMDDObject( MDDObj* ptr );
      /// read method for loadDomain
      inline const r_Minterval& getLoadDomain() const;
      /// write method for loadDomain
      inline void setLoadDomain( r_Minterval& newLoadDomain );

      /// returns a null-terminated string describing the type structure
      virtual char* getTypeStructure() const;
      /**
        The string pointer has to be free using free() by the caller.
      */
    ///
    ///
    //@}

    /// returns a pointer to the cell type
    BaseType* getCellType() const;

    /// returns size of one cell in bytes
    unsigned long getCellSize() const;

    /// returns {\tt QT_MDD}
    virtual QtDataType getDataType() const;

    /// compares data content
    virtual bool equal( const QtData* obj ) const;

    /// returns content dependent string representation 
    virtual std::string getSpelling() const;

    /// print status of the object to the specified stream
    virtual void printStatus( std::ostream& stream = std::cout ) const;

  private:
    /// prevents from using the default constructor
    QtMDD(){};

    /// pointer to the MDDObj object
    MDDObj* mddObject;

    /// load domain
    r_Minterval loadDomain;
};

#include "qlparser/qtmdd.icc"

#endif