Loading...
Searching...
No Matches
ImageAttrGroupHDF5.h
Go to the documentation of this file.
//# ImageAttrGroupHDF5.h: Attribute group for a HDF5 image
//# Copyright (C) 2012
//# 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 IMAGES_IMAGEATTRGROUPHDF5_H
#define IMAGES_IMAGEATTRGROUPHDF5_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/images/Images/ImageAttrGroup.h>
#include <casacore/tables/Tables/TableProxy.h>
#include <casacore/casa/HDF5/HDF5Group.h>
namespace casacore {
// <summary>
// Attribute group for a HDF5 image.
// </summary>
//
// <use visibility=export>
//
// <reviewed reviewer="" date="" tests="tPagedmage.cc" demos="dPagedImage.cc">
// </reviewed>
//
// <prerequisite>
// <li> <linkto class=ImageAttrGroup>ImageAttrGroup</linkto>
// </prerequisite>
//
// <synopsis>
// This is the implementation of base class class ImageAttrGroup for an image
// stored in the HDF5 format.
// See the base class for more information.
// </synopsis>
class ImageAttrGroupHDF5 : public ImageAttrGroup
{
public:
// The default constructor creates a null object.
explicit ImageAttrGroupHDF5 (Bool isWritable=False)
: itsChanged (False),
itsCanWrite (isWritable)
{}
// Construct the object for an attribute group in the image.
// If present, it reads all attributes.
ImageAttrGroupHDF5 (const HDF5Group& image, const String& attrGroupName,
Bool writable);
virtual ~ImageAttrGroupHDF5();
// Test if it is a null object.
Bool isNull() const
{ return itsRecord.empty(); }
// Flush the attibrutes if needed.
void flush (HDF5Group& image, const String& attrGroupName);
// Get the number of rows in the group.
virtual uInt nrows() const;
// Test if an attribute exists.
virtual Bool hasAttr (const String& attrName) const;
// Get all attribute names.
virtual Vector<String> attrNames() const;
// Get the datatype of a attribute.
// It returns TpOther if the attribute is not defined.
virtual DataType dataType (const String& attrName) const;
// Get the data of the given attribute in the given row.
virtual ValueHolder getData (const String& attrName, uInt rownr);
// Get the data of all attributes in a rows.
virtual Record getDataRow (uInt rownr);
// Get the possible units of the values (stored as attrName_UNIT).
// An empty vector is returned if the attribute has no units.
virtual Vector<String> getUnit (const String& attrName);
// Get the possible measure info as type,Ref (stored as attrName_MEASINFO).
// An empty vector is returned if the attribute has no MEASINFO.
virtual Vector<String> getMeasInfo (const String& attrName);
// Put the data of the given attribute.
// If the table does not contain data yet, it will be sized to the size
// of the vector. Otherwise the vector size has to match the table size.
// <br>If not empty, the units and MEASINFO will be put as column keywords.
// The MEASINFO vector must be given as type,Ref.
virtual void putData (const String& attrName, uInt rownr,
const ValueHolder& data,
const Vector<String>& units = Vector<String>(),
const Vector<String>& measInfo = Vector<String>());
private:
// Check the rownr and add a row if needed.
void checkRows (const String& attrName, uInt rownr);
//# Data members.
Record itsRecord; //# Record containing all attributes (subrecord per row)
Bool itsChanged; //# Has the Record changed?
Bool itsCanWrite; //# Can attributes be written?
};
} //# NAMESPACE CASACORE - END
#endif
casacore::HDF5Group
Definition HDF5Group.h:53
casacore::ImageAttrGroupHDF5::nrows
virtual uInt nrows() const
Get the number of rows in the group.
casacore::ImageAttrGroupHDF5::itsCanWrite
Bool itsCanWrite
Definition ImageAttrGroupHDF5.h:123
casacore::ImageAttrGroupHDF5::hasAttr
virtual Bool hasAttr(const String &attrName) const
Test if an attribute exists.
casacore::ImageAttrGroupHDF5::ImageAttrGroupHDF5
ImageAttrGroupHDF5(const HDF5Group &image, const String &attrGroupName, Bool writable)
Construct the object for an attribute group in the image.
casacore::ImageAttrGroupHDF5::flush
void flush(HDF5Group &image, const String &attrGroupName)
Flush the attibrutes if needed.
casacore::ImageAttrGroupHDF5::putData
virtual void putData(const String &attrName, uInt rownr, const ValueHolder &data, const Vector< String > &units=Vector< String >(), const Vector< String > &measInfo=Vector< String >())
Put the data of the given attribute.
casacore::ImageAttrGroupHDF5::checkRows
void checkRows(const String &attrName, uInt rownr)
Check the rownr and add a row if needed.
casacore::ImageAttrGroupHDF5::itsRecord
Record itsRecord
Definition ImageAttrGroupHDF5.h:121
casacore::ImageAttrGroupHDF5::getMeasInfo
virtual Vector< String > getMeasInfo(const String &attrName)
Get the possible measure info as type,Ref (stored as attrName_MEASINFO).
casacore::ImageAttrGroupHDF5::itsChanged
Bool itsChanged
Definition ImageAttrGroupHDF5.h:122
casacore::ImageAttrGroupHDF5::attrNames
virtual Vector< String > attrNames() const
Get all attribute names.
casacore::ImageAttrGroupHDF5::~ImageAttrGroupHDF5
virtual ~ImageAttrGroupHDF5()
casacore::ImageAttrGroupHDF5::ImageAttrGroupHDF5
ImageAttrGroupHDF5(Bool isWritable=False)
The default constructor creates a null object.
Definition ImageAttrGroupHDF5.h:60
casacore::ImageAttrGroupHDF5::dataType
virtual DataType dataType(const String &attrName) const
Get the datatype of a attribute.
casacore::ImageAttrGroupHDF5::isNull
Bool isNull() const
Test if it is a null object.
Definition ImageAttrGroupHDF5.h:73
casacore::ImageAttrGroupHDF5::getDataRow
virtual Record getDataRow(uInt rownr)
Get the data of all attributes in a rows.
casacore::ImageAttrGroupHDF5::getData
virtual ValueHolder getData(const String &attrName, uInt rownr)
Get the data of the given attribute in the given row.
casacore::ImageAttrGroupHDF5::getUnit
virtual Vector< String > getUnit(const String &attrName)
Get the possible units of the values (stored as attrName_UNIT).
casacore::ImageAttrGroup::ImageAttrGroup
ImageAttrGroup()
Default constructor.
Definition ImageAttrGroup.h:117
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::ValueHolder
Definition ValueHolder.h:66
casacore::Vector
Definition Vector.h:82
casacore::Record
Record()
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::False
const Bool False
Definition aipstype.h:42
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40