/usr/include/casacore/tables/Tables/ScaRecordColData.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 | //# ScaRecordColData.h: Access to a table column containing scalar records
//# Copyright (C) 1998
//# 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_SCARECORDCOLDATA_H
#define TABLES_SCARECORDCOLDATA_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/tables/Tables/PlainColumn.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class ColumnSet;
class ScalarRecordColumnDesc;
class AipsIO;
template<class T> class Vector;
// <summary>
// Access to a table column containing scalar records.
// </summary>
// <use visibility=local>
// <reviewed reviewer="Wim Brouw" date="1998/12/09" tests="tRecordColumn.cc">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// <li> <linkto class=PlainColumn>PlainColumn</linkto>
// <li> <linkto class=ScalarRecordColumnDesc>ScalarRecordColumnDesc</linkto>
// <li> <linkto class=Table>Table</linkto>
// </prerequisite>
// <etymology>
// ScalarRecordColumnData represents a table column containing scalars.
// </etymology>
// <synopsis>
// The class ScalarRecordColumnData is derived from PlainColumn.
// It implements the virtual functions accessing a table column
// containing scalars holding records.
// <br>
// It is possible to access an scalar in an individual cell (i.e. table row)
// or in the entire column.
// <p>
// The main task of this class is to communicate with the data manager
// column object. This consists of:
// <ul>
// <li> Binding itself to a data manager.
// <li> Letting the data manager create its column object.
// <li> Closing the data manager column object (in putFileDerived).
// <li> Reconstructing the data manager object for an existing table
// (in getFileDerived).
// <li> Transferring get/put calls to the data manager column object.
// </ul>
//
// The class is hidden from the user by the envelope class ScalarColumn.
// If used directly by other Table classes, it should be done with care.
// It assumes that the arrays in the various get and put functions have
// the correct length. ScalarColumn does that check.
// </synopsis>
// <todo asof="$DATE:$">
//# A List of bugs, limitations, extensions or planned refinements.
// <li> Introduce a class ArrayRecordColumnData to support arrays of records.
// </todo>
class ScalarRecordColumnData : public PlainColumn
{
public:
// Construct a scalar column object from the given description
// in the given column set.
// This constructor is used by ScalarRecordColumnDesc::makeColumn.
ScalarRecordColumnData (const ScalarRecordColumnDesc*, ColumnSet*);
~ScalarRecordColumnData();
// Ask if the data manager can handle a column.
virtual Bool canAccessScalarColumn (Bool& reask) const;
// Ask if the data manager can handle some cells in a column.
virtual Bool canAccessScalarColumnCells (Bool& reask) const;
// Initialize the rows from startRownr till endRownr (inclusive)
// with the default value defined in the column description.
virtual void initialize (uInt startRownr, uInt endRownr);
// Test if the given cell contains a defined value.
virtual Bool isDefined (uInt rownr) const;
// Get the value from a particular cell.
virtual void get (uInt rownr, void*) const;
// Get the array of all values in the column.
// The length of the buffer pointed to by dataPtr must match
// the actual length. This is checked by ScalarColumn.
virtual void getScalarColumn (void* dataPtr) const;
// Get the array of some values in the column (on behalf of RefColumn).
// The length of the buffer pointed to by dataPtr must match
// the actual length. This is checked by ScalarColumn.
virtual void getScalarColumnCells (const RefRows& rownrs,
void* dataPtr) const;
// Put the value in a particular cell.
// The length of the buffer pointed to by dataPtr must match
// the actual length. This is checked by ScalarColumn.
virtual void put (uInt rownr, const void* dataPtr);
// Put the array of all values in the column.
// The length of the buffer pointed to by dataPtr must match
// the actual length. This is checked by ScalarColumn.
virtual void putScalarColumn (const void* dataPtr);
// Put the array of some values in the column (on behalf on RefColumn).
// The length of the buffer pointed to by dataPtr must match
// the actual length. This is checked by ScalarColumn.
virtual void putScalarColumnCells (const RefRows& rownrs,
const void* dataPtr);
// Add this column and its data to the Sort object.
// Sorting on records is not supported, so an exception is thrown.
// <group>
virtual void makeSortKey (Sort&, CountedPtr<BaseCompare>& cmpObj,
Int order,
const void*& dataSave);
// Do it only for the given row numbers.
virtual void makeRefSortKey (Sort&, CountedPtr<BaseCompare>& cmpObj,
Int order,
const Vector<uInt>& rownrs,
const void*& dataSave);
// </group>
// Free storage on the heap allocated by makeSortkey().
// The pointer will be set to zero.
virtual void freeSortKey (const void*& dataSave);
// Allocate value buffers for the table iterator.
// Iteration based on records is not supported, so an exception is thrown.
virtual void allocIterBuf (void*& lastVal, void*& curVal,
CountedPtr<BaseCompare>& cmpObj);
// Free the value buffers allocated by allocIterBuf.
virtual void freeIterBuf (void*& lastVal, void*& curVal);
// Create a data manager column object for this column.
virtual void createDataManagerColumn();
private:
// Pointer to column description.
const ScalarRecordColumnDesc* scaDescPtr_p;
// Copy constructor cannot be used.
ScalarRecordColumnData (const ScalarRecordColumnData&);
// Assignment cannot be used.
ScalarRecordColumnData& operator= (const ScalarRecordColumnData&);
// Write the column data.
// The control information is written into the given AipsIO object,
// while the data is written/flushed by the data manager.
virtual void putFileDerived (AipsIO&);
// Read the column data back.
// The control information is read from the given AipsIO object.
// This is used to bind the column to the appropriate data manager.
// Thereafter the data manager gets opened.
virtual void getFileDerived (AipsIO&, const ColumnSet&);
// Handle getting and putting a record.
// It is stored as a Vector of uChar.
// <group>
void getRecord (uInt rownr, TableRecord& rec) const;
void putRecord (uInt rownr, const TableRecord& rec);
// </group>
};
} //# NAMESPACE CASACORE - END
#endif
|