summaryrefslogtreecommitdiffstats
path: root/indexmgr/keyobject.hh
blob: 030acc625a8615d546f33a0287827d91d6296b7a (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
/*
* 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>.
*/

#ifndef _KEYOBJECT_HH_
#define _KEYOBJECT_HH_

class Tile;
class KeyObject;

#include "reladminif/dbobject.hh"
#include "raslib/minterval.hh"
#include "reladminif/dbref.hh"

/**
 *	@file keyobject.hh
 *
 *	@ingroup indexmgr
 *
 * @Doc:
 * This class is a carrier structure which carries objects and their domains
 * through the different levels of the index.
*/
class KeyObject
	{
	public:
		KeyObject();

		KeyObject(const KeyObject& old);
		/*@Doc:
			Copy constructor.  Copies the tile pointer.
		*/
	
		KeyObject(const Tile* p);
		/*@Doc:
			Construccts a new KeyObject.  The type (persistent/transinet)
			is deremined based on the Tile.  The domain also.
			This constructor is sometimes misused by the compiler in statements like KeyObject p = 0.
			This will cause a crash because the domain is read from the tile which is NULL : )
		*/

		KeyObject(const DBObjectId& obj, const r_Minterval& dom);
		/*@Doc:
			Constructs a new KeyObject for a persistent object.
		*/

		const DBObjectId& getObject() const;
		/*@Doc:
			Returns a smartpointer to the persistent object attribute.
			If this is a transient object carrier the returned smart-
			pointer is invalid.
		*/

		Tile* getTransObject() const;
		/*@Doc:
			Returns the transient object.  If this KeyObject carries
			a persistent object a NULL is returned.
		*/

		r_Minterval getDomain() const;
		/*@Doc:
			Returns the domain which is associated with the objects that
			is carried.
		*/
	
		~KeyObject();
		/*@Doc:
			Does not delete the TransTile!!
		*/

		bool isInitialised() const;
		/*@Doc:
			Returns true if trans object is initialised or the dbref is initialised.
		*/

		bool isPersCarrier() const;
		/*@Doc:
			Returns true if the transobject attribute is NULL.
		*/

		void setDomain(const r_Minterval& dom);
		/*@Doc:
			Alters the domain the KeyObject carries.
		*/

		void setTransObject(const Tile* tile);
		/*@Doc:
			makes the KeyObject a transient carrier and copies the pointer.
		*/

		void setObject(const DBObjectId& obj);
		/*@Doc:
			makes the KeyObject a persistent carrier and copies object.
		*/

	protected:
		DBObjectId persobject;
		/*@Doc:
			A smartpointer to the carried object if it is persistent.
		*/

		r_Minterval domain;
		/*@Doc:
			The domain which the carried object belongs to.
		*/

		Tile* transobject;
		/*@Doc:
			Attribute for storing a transtile.  is NULL if a persistent
			object is carried.
		*/
	};

/*@Doc:
	Prints the status of KeyObject object.
*/
extern std::ostream& operator<<(std::ostream& in,  const KeyObject& d);

#endif