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

/*
* 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>.
*/
/*************************************************************
 *
 *
 * PURPOSE:
 *   The Type class is the superclass for the classes
 *   CollectionType, BaseType, and MDDType.
 *
 *
 * COMMENTS:
 *
 ************************************************************/

#ifndef _TYPE_HH_
#define _TYPE_HH_

class Type;
class OId;

#include <iostream>
using std::ostream;
using std::cout;
using std::endl;

#include "catalogmgr/ops.hh"
#include "reladminif/dbnamedobject.hh"

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

/*@Doc:
Type is the abstract base class for CollectionType, BaseType, and MDDType.

Common to each type is the ability to get its name.
This functionality is defined as a pure virtual function here.

{\bf Interdependencies}

Each \Ref{Tile} has a pointer to its BaseType. Pointers to BaseType
are also used in subclasses of \Ref{MDDObject}.
*/

class Type : public DBNamedObject
	{
	public:
		virtual void destroy();
		/*@Doc:
		does nothing.  is neccessary to stop types from being deleted by ~DBRef<Type>
		*/
	
		/// returns the name of the type as a C string.
		virtual const char* getTypeName() const;
		/*@Doc:
		  The name of the type is the class name without the Type suffix.
		  e.g. "Bool" for \Ref{BoolType}, or "ULong" for \Ref{ULongType},
		  or "Set" for \Ref{SetType}, or "Dimension" for \Ref{DimensionType}.
		*/

		/// returns the structure of the type as a C string.
		virtual char* getTypeStructure() const;
		/*@Doc:
		  Returns a copy of getTypeName() for non-structured base types. For
		  structured types a list of the elements in the form of #struct {
		  ulong elemName1, ushort elemName2 }# is returned. MDDTypes are
		  printed in the form #marray< RGBPixel, [10:20]# (less information,
		  if domain is not specified). Sets are printed in the form
		  #set<setName>#. The char* has to be freed by the caller!
		*/

		const TypeEnum getType() const;
		/*@Doc:
		returns the type as a TypeEnum.
		*/

		virtual int compatibleWith(const Type* aType) const;
		/*@Doc:
		checks, if two types are compatible (see also \Ref{MDDType}).
		*/

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

		Type(const OId& id) throw (r_Error);
		/*@Doc:
		*/

		Type(const Type& old);
		/*@Doc:
		*/

		Type& operator=(const Type& old);
		/*@Doc:
		*/

		virtual ~Type();
		/*@Doc:
		virtual destructor.
		*/
		
	protected:
		TypeEnum myType;
		/*@Doc:
		enum for type.  this can be ULONG, USHORT, CHAR,
			BOOLTYPE, LONG, SHORT, OCTET, DOUBLE,
			FLOAT, STRUCT, CLASSTYPE, SETTYPE, MDDTYPE
		*/

		Type(const char* name);
		/*@Doc:
		*/
	};

#endif