Loading...
Searching...
No Matches
SDObservationHandler.h
Go to the documentation of this file.
//# SDObservationFiller.h: fills the OBSERVATION table for the SDFITS filler
//# Copyright (C) 2000
//# 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: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef MS_SDOBSERVATIONHANDLER_H
#define MS_SDOBSERVATIONHANDLER_H
#include <casacore/casa/aips.h>
#include <casacore/casa/Containers/RecordField.h>
#include <casacore/tables/Tables/ScalarColumn.h>
#include <casacore/casa/Arrays/ArrayFwd.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class ColumnsIndex;
class MeasurementSet;
class MSObservation;
class MSObservationColumns;
class Record;
class String;
// <summary>
// </summary>
// <use visibility=local> or <use visibility=export>
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> SomeClass
// <li> SomeOtherClass
// <li> some concept
// </prerequisite>
//
// <etymology>
// </etymology>
//
// <synopsis>
// </synopsis>
//
// <example>
// </example>
//
// <motivation>
// </motivation>
//
// <templating arg=T>
// <li>
// <li>
// </templating>
//
// <thrown>
// <li>
// <li>
// </thrown>
//
// <todo asof="yyyy/mm/dd">
// <li> add this feature
// <li> fix this bug
// <li> start discussion of this possible extension
// </todo>
class SDObservationHandler
{
public:
// default ctor is not attached to a MS and hence is useless until attached
SDObservationHandler();
// attach this to a MS, mark the appropriate columns as handled given
// the indicated row
SDObservationHandler(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
// copy ctor
SDObservationHandler(const SDObservationHandler &other);
~SDObservationHandler() {clearAll();}
// assignment operator, uses copy semantics
SDObservationHandler &operator=(const SDObservationHandler &other);
// attach to a MS, mark the appropriate columns as handled given the row
void attach(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
// reset internals given indicated row, use the same MS
void resetRow(const Record &row);
// fill - a new row is added only when necessary
void fill(const Record &row, const String &telescopeName, const Vector<Double> &timeRange);
// get the current observation ID
Int observationId() {return rownr_p;}
// update the time range
void updateTimeRange(const Vector<Double> &timeRange);
private:
ColumnsIndex *index_p;
RecordFieldPtr<String> telescopeKey_p, observerKey_p, projectKey_p, ns_obsidKey_p;
RecordFieldPtr<Double> releaseDateKey_p;
RecordFieldPtr<Bool> flagRowKey_p;
MSObservation *msObs_p;
MSObservationColumns *msObsCols_p;
Int rownr_p;
ScalarColumn<String> nsObsIdCol_p;
// pointers to fields in record, only used if attached
RORecordFieldPtr<String> observer_p, projid_p, obsid_p;
RORecordFieldPtr<Double> releaseDate_p;
RORecordFieldPtr<Bool> flagRow_p;
RORecordFieldPtr<Array<Double> > timeRange_p;
// cleanup everything
void clearAll();
// cleanup things which depend on the row description being fixed
void clearRow();
// initialize everything
void initAll(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
// initialize the things which depend on the row
void initRow(Vector<Bool> &handledCols, const Record &row);
// initialize the index
void makeIndex();
};
} //# NAMESPACE CASACORE - END
#endif
casacore::ColumnsIndex
Definition ColumnsIndex.h:226
casacore::MSObservationColumns
Definition MSObsColumns.h:79
casacore::MSObservation
Definition MSObservation.h:77
casacore::MeasurementSet
Definition MeasurementSet.h:278
casacore::RORecordFieldPtr
Read-Only access to an individual field from a Record.
Definition RecordField.h:209
casacore::RecordFieldPtr
Definition ColumnsIndex.h:42
casacore::SDObservationHandler::operator=
SDObservationHandler & operator=(const SDObservationHandler &other)
assignment operator, uses copy semantics
casacore::SDObservationHandler::msObs_p
MSObservation * msObs_p
Definition SDObservationHandler.h:124
casacore::SDObservationHandler::timeRange_p
RORecordFieldPtr< Array< Double > > timeRange_p
Definition SDObservationHandler.h:135
casacore::SDObservationHandler::projectKey_p
RecordFieldPtr< String > projectKey_p
Definition SDObservationHandler.h:120
casacore::SDObservationHandler::clearRow
void clearRow()
cleanup things which depend on the row description being fixed
casacore::SDObservationHandler::~SDObservationHandler
~SDObservationHandler()
Definition SDObservationHandler.h:99
casacore::SDObservationHandler::telescopeKey_p
RecordFieldPtr< String > telescopeKey_p
Definition SDObservationHandler.h:120
casacore::SDObservationHandler::nsObsIdCol_p
ScalarColumn< String > nsObsIdCol_p
Definition SDObservationHandler.h:129
casacore::SDObservationHandler::msObsCols_p
MSObservationColumns * msObsCols_p
Definition SDObservationHandler.h:125
casacore::SDObservationHandler::SDObservationHandler
SDObservationHandler(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
attach this to a MS, mark the appropriate columns as handled given the indicated row
casacore::SDObservationHandler::observationId
Int observationId()
get the current observation ID
Definition SDObservationHandler.h:114
casacore::SDObservationHandler::observer_p
RORecordFieldPtr< String > observer_p
pointers to fields in record, only used if attached
Definition SDObservationHandler.h:132
casacore::SDObservationHandler::observerKey_p
RecordFieldPtr< String > observerKey_p
Definition SDObservationHandler.h:120
casacore::SDObservationHandler::makeIndex
void makeIndex()
initialize the index
casacore::SDObservationHandler::projid_p
RORecordFieldPtr< String > projid_p
Definition SDObservationHandler.h:132
casacore::SDObservationHandler::flagRowKey_p
RecordFieldPtr< Bool > flagRowKey_p
Definition SDObservationHandler.h:122
casacore::SDObservationHandler::obsid_p
RORecordFieldPtr< String > obsid_p
Definition SDObservationHandler.h:132
casacore::SDObservationHandler::releaseDate_p
RORecordFieldPtr< Double > releaseDate_p
Definition SDObservationHandler.h:133
casacore::SDObservationHandler::clearAll
void clearAll()
cleanup everything
casacore::SDObservationHandler::resetRow
void resetRow(const Record &row)
reset internals given indicated row, use the same MS
casacore::SDObservationHandler::index_p
ColumnsIndex * index_p
Definition SDObservationHandler.h:119
casacore::SDObservationHandler::fill
void fill(const Record &row, const String &telescopeName, const Vector< Double > &timeRange)
fill - a new row is added only when necessary
casacore::SDObservationHandler::SDObservationHandler
SDObservationHandler()
default ctor is not attached to a MS and hence is useless until attached
casacore::SDObservationHandler::SDObservationHandler
SDObservationHandler(const SDObservationHandler &other)
copy ctor
casacore::SDObservationHandler::ns_obsidKey_p
RecordFieldPtr< String > ns_obsidKey_p
Definition SDObservationHandler.h:120
casacore::SDObservationHandler::initAll
void initAll(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
initialize everything
casacore::SDObservationHandler::releaseDateKey_p
RecordFieldPtr< Double > releaseDateKey_p
Definition SDObservationHandler.h:121
casacore::SDObservationHandler::rownr_p
Int rownr_p
Definition SDObservationHandler.h:127
casacore::SDObservationHandler::flagRow_p
RORecordFieldPtr< Bool > flagRow_p
Definition SDObservationHandler.h:134
casacore::SDObservationHandler::initRow
void initRow(Vector< Bool > &handledCols, const Record &row)
initialize the things which depend on the row
casacore::SDObservationHandler::updateTimeRange
void updateTimeRange(const Vector< Double > &timeRange)
update the time range
casacore::SDObservationHandler::attach
void attach(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
attach to a MS, mark the appropriate columns as handled given the row
casacore::ScalarColumn
Definition ScalarColumn.h:83
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::Vector
Definition Vector.h:82
casacore::Record
Record()
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::Int
int Int
Definition aipstype.h:48