summaryrefslogtreecommitdiffstats
path: root/relcatalogif/collectiontype.hh
blob: f4e49d9109729b516789edfd622c99ae5f44932a (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
/*
* 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>.
*/
// -*-C++-*- (for Emacs)

/*************************************************************
 *
 *
 * PURPOSE:
 *   The CollectionType class is the superclass for the class
 *   SetType. 
 *
 *
 * COMMENTS:
 *
 ************************************************************/

#ifndef _COLLECTIONTYPE_HH_
#define _COLLECTIONTYPE_HH_

class CollectionType;

#include <iostream>
#include "catalogmgr/ops.hh"
#include "type.hh"
#include "reladminif/externs.h"

class MDDType;

//@ManMemo: Module: {\bf relcatalogif}.

/*@Doc:
  CollectionType is the base class for classes that deal with
  collections of MDDs (the only subclass at the moment is SetType).
*/

/**
  * \ingroup Relcatalogifs
  */
class CollectionType : public Type
	{
	public:
		const MDDType* getMDDType() const;
		/*@Doc:
		returns MDDType of collection.
		*/
	/*
		MDDType* getMDDType() const;
	*/

	 
		void print_status( ostream& s ) const;
		/*@Doc:
		writes the state of the object to the specified stream:
		d_MYNAME <MYMDDTYPE->printStatus >
		*/

		CollectionType(const MDDType* newMDDType);
		/*@Doc:
		constructor receiving pointer to an MDDType (or subclass).
		*/

		CollectionType();
		/*@Doc:
		default constructor, cannot be used.
		*/

		CollectionType(const OId& id) throw (r_Error);
		/*@Doc:
		*/
		
		CollectionType(const CollectionType& old);
		/*@Doc:
		*/
	 
		CollectionType& operator=(const CollectionType& old);
		/*@Doc:
		*/

		virtual ~CollectionType();
		/*@Doc:
		virtual destructor.
		*/

		virtual int compatibleWith(const Type* aType) const;
		/*@Doc:
		overloaded from Type.
		returns true if myMDDType is compatible with the type.
		*/

		virtual r_Bytes getMemorySize() const;
		/*@Doc:
		returns DBNamedObject::getMemorySize() +
			myMDDType->getMemorySize() + sizeof(MDDType*);
		*/

	protected:
		const MDDType* myMDDType;
		/*@Doc:
		persistent pointer to MDDType of collection.
		*/

		CollectionType(const char* name);
		/*@Doc:
		*/

		CollectionType(const char* name,const MDDType* newMDDType);
		/*@Doc:
		*/
	};

#endif