/usr/include/casacore/tables/Tables/ColumnSet.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 | //# ColumnSet.h: Class to manage a set of table columns
//# Copyright (C) 1994,1995,1996,1997,1998,1999,2000,2001,2002,2003
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library 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 Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//# $Id$
#ifndef TABLES_COLUMNSET_H
#define TABLES_COLUMNSET_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/Tables/TableLockData.h>
#include <casacore/tables/Tables/BaseTable.h>
#include <casacore/tables/Tables/StorageOption.h>
#include <casacore/casa/Containers/SimOrdMap.h>
#include <casacore/casa/BasicSL/String.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class SetupNewTable;
class Table;
class TableDesc;
class TSMOption;
class BaseTable;
class TableAttr;
class ColumnDesc;
class PlainColumn;
class DataManager;
class MultiFile;
class Record;
class IPosition;
class AipsIO;
template<class T> class Vector;
// <summary>
// Class to manage a set of table columns
// </summary>
// <use visibility=local>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> PlainTable
// <li> DataManager
// </prerequisite>
// <etymology>
// ColumnSet represent the set of columns in a table.
// </etymology>
// <synopsis>
// ColumnSet contains all columns in a plain table (thus not in a RefTable).
// Furthermore it contains the set of data managers used by the columns
// in the table.
//
// The main purpose of the class is to deal with constructing, writing
// and reading the column objects. It is used by classes SetupNewTable
// and Table.
// </synopsis>
// <todo asof="$DATE:$">
//# A List of bugs, limitations, extensions or planned refinements.
// </todo>
class ColumnSet
{
public:
// Construct from the table description.
// This creates all underlying filled and virtual column objects.
ColumnSet (TableDesc*, const StorageOption& = StorageOption());
~ColumnSet();
// Reopen the data managers for read/write.
void reopenRW();
// Rename the necessary subtables in the column keywords.
void renameTables (const String& newName, const String& oldName);
// Get the storage option.
const StorageOption& storageOption() const
{ return storageOpt_p; }
// Are subtables used in other processes.
Bool areTablesMultiUsed() const;
// Get a column by name.
PlainColumn* getColumn (const String& columnName) const;
// Get a column by index.
PlainColumn* getColumn (uInt columnIndex) const;
// Add a data manager.
// It increments seqCount_p and returns that as a unique sequence number.
// This can, for instance, be used to create a unique file name.
void addDataManager (DataManager*);
// Initialize the data managers for a new table.
// It creates the data manager column objects for each column
// and it allows the data managers to link themselves to the
// Table object and to initialize themselves.
void initDataManagers (uInt nrrow, Bool bigEndian,
const TSMOption& tsmOption,
Table& tab);
// Link the ColumnSet object to the BaseTable object.
void linkToTable (BaseTable* baseTableObject);
// Link the ColumnSet object to the TableLockData object.
void linkToLockObject (TableLockData* lockObject);
// Check if the table is locked for read or write.
// If manual or permanent locking is in effect, it checks if the
// table is properly locked.
// If autolocking is in effect, it locks the table when needed.
// <group>
void checkReadLock (Bool wait);
void checkWriteLock (Bool wait);
// </group>
// Inspect the auto lock when the inspection interval has expired and
// release it when another process needs the lock.
void autoReleaseLock();
// If needed, get a temporary user lock.
// It returns False if the lock was already there.
Bool userLock (FileLocker::LockType, Bool wait);
// Release a temporary user lock if the given release flag is True.
void userUnlock (Bool releaseFlag);
// Do all data managers and engines allow to add rows?
Bool canAddRow() const;
// Do all data managers and engines allow to remove rows?
Bool canRemoveRow() const;
// Can the given columns be removed from the data manager?
Bool canRemoveColumn (const Vector<String>& columnNames) const;
// Can a column be renamed in the data manager?
Bool canRenameColumn (const String& columnName) const;
// Add rows to all data managers.
void addRow (uInt nrrow);
// Remove a row from all data managers.
// It will throw an exception if not possible.
void removeRow (uInt rownr);
// Remove the columns from the map and the data manager.
void removeColumn (const Vector<String>& columnNames);
// Rename the column in the map.
void renameColumn (const String& newName, const String& oldName);
// Add a column to the table.
// The default implementation throws an "invalid operation" exception.
// <group>
void addColumn (const ColumnDesc& columnDesc,
Bool bigEndian, const TSMOption& tsmOption, Table& tab);
void addColumn (const ColumnDesc& columnDesc,
const String& dataManager, Bool byName,
Bool bigEndian, const TSMOption& tsmOption, Table& tab);
void addColumn (const ColumnDesc& columnDesc,
const DataManager& dataManager,
Bool bigEndian, const TSMOption& tsmOption, Table& tab);
void addColumn (const TableDesc& tableDesc,
const DataManager& dataManager,
Bool bigEndian, const TSMOption& tsmOption, Table& tab);
// </group>
// Get nr of rows.
uInt nrow() const;
// Get the actual table description.
TableDesc actualTableDesc() const;
// Get the data manager info.
// Optionally only the virtual engines are retrieved.
Record dataManagerInfo (Bool virtualOnly=False) const;
// Get the trace-id of the table.
int traceId() const
{ return baseTablePtr_p->traceId(); }
// Initialize rows startRownr till endRownr (inclusive).
void initialize (uInt startRownr, uInt endRownr);
// Write all the data and let the data managers flush their data.
// This function is called when a table gets written (i.e. flushed).
// It returns True if any data manager wrote something.
Bool putFile (Bool writeTable, AipsIO&, const TableAttr&, Bool fsync);
// Read the data, reconstruct the data managers, and link those to
// the table object.
// This function gets called when an existing table is read back.
// It returns the number of rows in case a data manager thinks there are
// more. That is in particular used by LofarStMan.
uInt getFile (AipsIO&, Table& tab, uInt nrrow, Bool bigEndian,
const TSMOption& tsmOption);
// Set the table to being changed.
void setTableChanged();
// Get the data manager change flags (used by PlainTable).
Block<Bool>& dataManChanged();
// Synchronize the data managers when data in them have changed.
// It returns the number of rows it think it has, which is needed for
// storage managers like LofarStMan.
// <src>forceSync=True</src> means that the data managers are forced
// to do a sync. Otherwise the contents of the lock file tell if a data
// manager has to sync.
uInt resync (uInt nrrow, Bool forceSync);
// Invalidate the column caches for all columns.
void invalidateColumnCaches();
// Get the correct data manager.
// This is used by the column objects to link themselves to the
// correct datamanagers when they are read back.
DataManager* getDataManager (uInt seqnr) const;
// Check if no double data manager names have been given.
void checkDataManagerNames (const String& tableName) const;
// Find the data manager with the given name or for the given column.
// If the data manager or column is unknown, an exception is thrown.
// A blank name means the data manager is unknown.
DataManager* findDataManager (const String& name,
Bool byColumn=False) const;
// Make a unique data manager name by appending a suffix _n if needed
// where n is a number that makes the name unique.
String uniqueDataManagerName (const String& name) const;
// Synchronize the columns after it appeared that data in the
// main table file have changed.
// It cannot deal with changes in number of columns, so it throws an
// exception when they have changed.
// Keywords in all columns are updated.
// The other ColumnSet gives the new data.
void syncColumns (const ColumnSet& other, const TableAttr& defaultAttr);
private:
// Remove the last data manager (used by addColumn after an exception).
// It does the opposite of addDataManager.
void removeLastDataManager();
// Let the data managers (from the given index on) initialize themselves.
void initSomeDataManagers (uInt from, Table& tab);
// Let the data managers (from the given index on) prepare themselves.
void prepareSomeDataManagers (uInt from);
// Open or create the MultiFile if needed.
void openMultiFile (uInt from, const Table& tab,
ByteIO::OpenOption);
// Check if a data manager name has not already been used.
// Start checking at the given index in the array.
// It returns False if the name has already been used.
// By default an exception is thrown if the name has already been used.
Bool checkDataManagerName (const String& name, uInt from,
const String& tableName,
Bool doTthrow=True) const;
// Do the actual addition of a column.
void doAddColumn (const ColumnDesc& columnDesc, DataManager* dataManPtr);
// Check if columns to be removed can be removed.
// It returns a map of DataManager* telling how many columns for
// a data manager have to be removed. A count of -1 means that all
// columns have to be removed. For such columns the flag in the
// returned Block is False, otherwise True.
SimpleOrderedMap<void*,Int> checkRemoveColumn
(const Vector<String>& columnNames);
// Check if the table is locked for read or write.
// If manual or permanent locking is in effect, it checks if the
// table is properly locked.
// If autolocking is in effect, it locks the table when needed.
void doLock (FileLocker::LockType, Bool wait);
//# Declare the variables.
TableDesc* tdescPtr_p;
StorageOption storageOpt_p;
MultiFileBase* multiFile_p;
Int64 nrrow_p; //# #rows
BaseTable* baseTablePtr_p;
TableLockData* lockPtr_p; //# lock object
SimpleOrderedMap<String,void*> colMap_p; //# list of PlainColumns
uInt seqCount_p; //# sequence number count
//# (used for unique seqnr)
Block<void*> blockDataMan_p; //# list of data managers
Block<Bool> dataManChanged_p; //# data has changed
};
inline uInt ColumnSet::nrow() const
{
return nrrow_p;
}
inline void ColumnSet::linkToTable (BaseTable* baseTableObject)
{
baseTablePtr_p = baseTableObject;
}
inline void ColumnSet::setTableChanged()
{
baseTablePtr_p->setTableChanged();
}
inline void ColumnSet::linkToLockObject (TableLockData* lockObject)
{
lockPtr_p = lockObject;
}
inline void ColumnSet::checkReadLock (Bool wait)
{
if (lockPtr_p->readLocking()
&& ! lockPtr_p->hasLock (FileLocker::Read)) {
doLock (FileLocker::Read, wait);
}
}
inline void ColumnSet::checkWriteLock (Bool wait)
{
if (! lockPtr_p->hasLock (FileLocker::Write)) {
doLock (FileLocker::Write, wait);
}
}
inline void ColumnSet::userUnlock (Bool releaseFlag)
{
if (releaseFlag) {
lockPtr_p->release();
}
}
inline void ColumnSet::autoReleaseLock()
{
lockPtr_p->autoRelease();
}
inline Block<Bool>& ColumnSet::dataManChanged()
{
return dataManChanged_p;
}
} //# NAMESPACE CASACORE - END
#endif
|