/usr/include/casacore/tables/DataMan/BitFlagsEngine.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 | //# BitFlagsEngine.h: Templated virtual column engine to map bit flags to a Bool
//# Copyright (C) 2009
//# 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_BITFLAGSENGINE_H
#define TABLES_BITFLAGSENGINE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/DataMan/BaseMappedArrayEngine.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary> Non-templated Helper class to handle the mask. </summary>
// <use visibility=local>
class BFEngineMask
{
public:
// Form the mask as given.
explicit BFEngineMask (uInt mask=0xffffffff);
// Form the mask from the given keywords defining the bits.
BFEngineMask (const Array<String>& keys, uInt defaultMask);
// Make the mask from the given keywords defining the bits.
void makeMask (const TableColumn& column);
// Form the read mask from the specification.
// If keywords are given, the mask is formed from them.
void fromRecord (const RecordInterface& spec, const TableColumn& column,
const String& prefix);
// Store the info in a Record.
void toRecord (RecordInterface& spec, const String& prefix) const;
// Get the mask.
uInt getMask() const
{ return itsMask; }
// Get the mask keywords.
const Array<String>& getKeys() const
{ return itsMaskKeys; }
private:
Array<String> itsMaskKeys;
uInt itsMask;
};
// <summary>
// Templated virtual column engine to map bit flags to a Bool.
// </summary>
// <use visibility=export>
// <reviewed reviewer="Gareth Hunt" date="94Nov17" tests="">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> VirtualColumnEngine
// <li> VirtualArrayColumn
// </prerequisite>
// <synopsis>
// BitFlagsEngine is a virtual column engine which maps an integer column
// containing flag bits to a Bool column. It can be used in a MeasurementSet
// to have multiple flag categories, yet use all existing software that
// deals with the Bool FLAG column.
//
// The engine support read as well as write access.
// For both cases a mask can be defined telling which bits have to be taken
// into account. For example, when writing to the Bool FLAG column, the data
// in the bitflags column twill be or-ed with the bits as defined in the
// writemask. Similary when reading FLAG, only the bits of the readmask are
// taken into account.
//
// The masks can be defined in two ways:
// <ul>
// <li> The mask can be given directly as an integer value.
// The default write mask is 1 (thus only bit 0), while the default
// read mask is all bits.
// <li> Symbolic names for mask bits can be defined as keywords in the
// flagbits column. They define the bit value, not the bit number.
// It makes it possible to combine bits in a keyword.
// The keywords are stored in a subrecord of keyword FLAGSETS.
// Example of keyword and their values could be:
// <br>RFI=1, CAL=2, CLIP=4, OTHER=8, RFICAL=3
// <br>Note that in this example RFICAL is defined such that it
// contains RFI and CAL.
// </ul>
// A mask can be set at construction time, but it can be changed at runtime
// using the <src>setProperties</src> function.
// The masks are kept in special keywords (which are different from the
// keywords defining the flag bits), so it is possible to change a mask
// by changing those keywords before opening a table. However, that is
// not recommended.
//
// BitFlagsEngine is known to the table system for data types uChar, Short,
// and Int.
// </synopsis>
// <motivation>
// The FLAG_CATEGORY defined the Measurement does not work because adding
// an extra flag means resizing the entire array which is slow.
// This class makes it possible to use an integer column to store flags
// and map it directly to a Bool column.
// </motivation>
// <example>
// <srcblock>
// // Create the table description and 2 columns with indirect arrays in it.
// // The Int column will be stored, while the Bool will be used as virtual.
// TableDesc tableDesc ("", TableDesc::Scratch);
// tableDesc.addColumn (ArrayColumnDesc<Int> ("BitBlags"));
// tableDesc.addColumn (ArrayColumnDesc<Bool> ("FLAG"));
//
// // Create a new table using the table description.
// SetupNewTable newtab (tableDesc, "tab.data", Table::New);
//
// // Create the engine and bind the FLAG column to it.
// BitFlagsEngine<Int> flagsEngine("FLAG", "BitFlags");
// newtab.bindColumn ("FLAG", flagsEngine);
// // Create the table.
// Table table (newtab);
//
// // Store a 3-D array (with dim. 2,3,4) into each row of the column.
// // The shape of each array in the column is implicitly set by the put
// // function. This will also set the shape of the underlying Int array.
// ArrayColumn data (table, "virtualArray");
// Array<Bool> someArray(IPosition(4,2,3,4));
// someArray = True;
// for (uInt i=0, i<10; i++) { // table will have 10 rows
// table.addRow();
// data.put (i, someArray)
// }
// </srcblock>
// The underlying integer array will be stored according to the writemask
// which defaults to 1.
// </example>
// <templating arg=StoredType>
// <li> only suited for built-in integer data types
// </templating>
template<typename StoredType> class BitFlagsEngine : public BaseMappedArrayEngine<Bool, StoredType>
{
//# Make members of parent class known.
public:
using BaseMappedArrayEngine<Bool,StoredType>::virtualName;
protected:
using BaseMappedArrayEngine<Bool,StoredType>::storedName;
using BaseMappedArrayEngine<Bool,StoredType>::table;
using BaseMappedArrayEngine<Bool,StoredType>::column;
using BaseMappedArrayEngine<Bool,StoredType>::setNames;
public:
// Construct an engine to map integer arrays in a column to Bool arrays.
// StoredColumnName is the name of the column where the integer
// data will be put and must have data type StoredType.
// The virtual column using this engine must have data type Bool.
// <br>A mask can be given that specifies which bits to use in the mapping
// from StoredType to Bool. Similarly a mask can be given defining which
// bits to set when mapping from Bool to StoredType.
BitFlagsEngine (const String& virtualColumnName,
const String& storedColumnName,
StoredType readMask=StoredType(0xffffffff),
StoredType writeMask=1);
// Construct an engine to map integer arrays in a column to Bool arrays.
// StoredColumnName is the name of the column where the scaled
// data will be put and must have data type StoredType.
// The virtual column using this engine must have data type Bool.
// <br>A mask can be given that specifies which bits to use in the mapping
// from StoredType to Bool. Similarly a mask can be given defining which
// bits to set when mapping from Bool to StoredType.
// The masks are given using the values of keywords in the stored column.
// Each keyword should be an integer defining one or more bits and can be
// seen as a symbolic name. The keyword values are or-ed to form the mask.
// The keywords are stored in a subrecord of keyword FLAGSETS.
BitFlagsEngine (const String& virtualColumnName,
const String& storedColumnName,
const Array<String>& readMaskKeys,
const Array<String>& writeMaskKeys);
// Construct from a record specification as created by dataManagerSpec().
BitFlagsEngine (const Record& spec);
// Destructor is mandatory.
~BitFlagsEngine();
// Return the type name of the engine (i.e. its class name).
virtual String dataManagerType() const;
// Get the name given to the engine (is the virtual column name).
virtual String dataManagerName() const;
// Record a record containing data manager specifications.
virtual Record dataManagerSpec() const;
// Get data manager properties that can be modified.
// These are ReadMask, WriteMask, ReadMaskKeys, and WriteMaskKeys.
// It is a subset of the data manager specification.
virtual Record getProperties() const;
// Modify data manager properties.
// These are ReadMask, WriteMask, ReadMaskKeys, and/or WriteMaskKeys.
// Mask keys should be given as an array of strings giving the keyword
// names defining mask bits (similar to the constructor). Mask keys are
// only used if not empty.
virtual void setProperties (const Record& spec);
// Return the name of the class.
// This includes the names of the template arguments.
static String className();
// Register the class name and the static makeObject "constructor".
// This will make the engine known to the table system.
// The automatically invoked registration function in DataManReg.cc
// contains BitFlagsEngine<Int>.
// Any other instantiation of this class must be registered "manually"
// (or added to DataManReg.cc).
static void registerClass();
private:
// Copy constructor is only used by clone().
// (so it is made private).
BitFlagsEngine (const BitFlagsEngine<StoredType>&);
// Assignment is not needed and therefore forbidden
// (so it is made private and not implemented).
BitFlagsEngine<StoredType>& operator= (const BitFlagsEngine<StoredType>&);
// Clone the engine object.
DataManager* clone() const;
// Initialize the object for a new table.
// It defines the keywords containing the engine parameters.
void create (uInt initialNrrow);
// Preparing consists of setting the writable switch and
// adding the initial number of rows in case of create.
// Furthermore it reads the keywords containing the engine parameters.
void prepare();
// Get an array in the given row.
// This will scale and offset from the underlying array.
void getArray (uInt rownr, Array<Bool>& array);
// Put an array in the given row.
// This will scale and offset to the underlying array.
void putArray (uInt rownr, const Array<Bool>& array);
// Get a section of the array in the given row.
// This will scale and offset from the underlying array.
void getSlice (uInt rownr, const Slicer& slicer, Array<Bool>& array);
// Put into a section of the array in the given row.
// This will scale and offset to the underlying array.
void putSlice (uInt rownr, const Slicer& slicer,
const Array<Bool>& array);
// Get an entire column.
// This will scale and offset from the underlying array.
void getArrayColumn (Array<Bool>& array);
// Put an entire column.
// This will scale and offset to the underlying array.
void putArrayColumn (const Array<Bool>& array);
// Get some array values in the column.
// This will scale and offset from the underlying array.
virtual void getArrayColumnCells (const RefRows& rownrs,
Array<Bool>& data);
// Put some array values in the column.
// This will scale and offset to the underlying array.
virtual void putArrayColumnCells (const RefRows& rownrs,
const Array<Bool>& data);
// Get a section of all arrays in the column.
// This will scale and offset from the underlying array.
void getColumnSlice (const Slicer& slicer, Array<Bool>& array);
// Put a section of all arrays in the column.
// This will scale and offset to the underlying array.
void putColumnSlice (const Slicer& slicer, const Array<Bool>& array);
// Get a section of some arrays in the column.
// This will scale and offset from the underlying array.
virtual void getColumnSliceCells (const RefRows& rownrs,
const Slicer& slicer,
Array<Bool>& data);
// Put into a section of some arrays in the column.
// This will scale and offset to the underlying array.
virtual void putColumnSliceCells (const RefRows& rownrs,
const Slicer& slicer,
const Array<Bool>& data);
// Map bit flags array to Bool array.
// This is meant when reading an array from the stored column.
void mapOnGet (Array<Bool>& array,
const Array<StoredType>& stored);
// Map Bool array to bit flags array.
// This is meant when writing an array into the stored column.
void mapOnPut (const Array<Bool>& array,
Array<StoredType>& stored);
// Functor to and an array and mask and convert to Bool.
struct FlagsToBool : public std::unary_function<StoredType,Bool>
{
explicit FlagsToBool(StoredType readMask) : itsMask(readMask) {}
Bool operator() (StoredType value) const
{ return (value & itsMask) != 0; }
private:
StoredType itsMask;
};
// Functor to convert Bools to flags using a mask.
// By default only bit 0 is set.
// Flag bits not affected are kept.
struct BoolToFlags : public std::binary_function<Bool,StoredType,StoredType>
{
explicit BoolToFlags(StoredType writeMask) : itsMask(writeMask) {}
StoredType operator() (Bool flag, StoredType value) const
{ return (flag ? value&itsMask : value); }
private:
StoredType itsMask;
};
public:
// Define the "constructor" to construct this engine when a
// table is read back.
// This "constructor" has to be registered by the user of the engine.
// If the engine is commonly used, its registration can be added
// to the registerAllCtor function in DataManReg.cc.
// That function gets automatically invoked by the table system.
static DataManager* makeObject (const String& dataManagerType,
const Record& spec);
private:
BFEngineMask itsBFEReadMask;
BFEngineMask itsBFEWriteMask;
StoredType itsReadMask;
StoredType itsWriteMask;
Bool itsIsNew; //# True = new table
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/tables/DataMan/BitFlagsEngine.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|