casacore::TiledFileHelper Class Reference

Helper class for tiled access to an array in a file. More...

#include <TiledFileHelper.h>

Inheritance diagram for casacore::TiledFileHelper:

Public Member Functions
	TiledFileHelper (const String &fileName, const IPosition &shape, DataType dtype, const TSMOption &, Bool writable, Bool bigEndian)
	Create a TiledFileHelper object.
	~TiledFileHelper ()
virtual const TableDesc &	getDesc () const
	Get the table description needed for the hypercolumn description.
TSMFile *	file ()
virtual String	dataManagerType () const
	Return the class name.
virtual DataManager *	clone () const
	These functions are pure virtual, but not needed here.
virtual Bool	flush (AipsIO &, Bool)
	Flush and optionally fsync the data.
virtual void	create (uInt)
	Let the data manager initialize itself for a new table.
virtual TSMCube *	getHypercube (uInt)
virtual TSMCube *	getHypercube (uInt, IPosition &)
	Get the hypercube in which the given row is stored.
virtual void	readHeader (uInt, Bool)
	Let a derived class read the header info.
Private Member Functions
	TiledFileHelper (const TiledFileHelper &)
	Forbid copy constructor and assignment.
TiledFileHelper &	operator= (const TiledFileHelper &)
	Forbid assignment.
Private Attributes
TableDesc	itsDesc

Detailed Description

Helper class for tiled access to an array in a file.

Intended use:

Internal

Review Status

Test programs:: tTiledFileAccess

Prerequisite

Description of Tiled Storage Manager in module file Tables.h

Synopsis

TiledFileHelper is a helper class for class TiledFileAccess . It sets up a table description containing one array column to make it possible to use the tiled storage manager to access an array in an arbitrary file.

Motivation

This class was created to be able to read an image in a FITS file.

Definition at line 73 of file TiledFileHelper.h.

Constructor & Destructor Documentation

casacore::TiledFileHelper::TiledFileHelper	(	const String &	fileName,
		const IPosition &	shape,
		DataType	dtype,
		const TSMOption &	,
		Bool	writable,
		Bool	bigEndian
	)

Create a TiledFileHelper object.

Tell if the data is stored in big or little endian canonical format.

casacore::TiledFileHelper::~TiledFileHelper ( )

casacore::TiledFileHelper::TiledFileHelper ( const TiledFileHelper & ) [private]

Forbid copy constructor and assignment.

Member Function Documentation

virtual DataManager* casacore::TiledFileHelper::clone ( ) const [virtual]

These functions are pure virtual, but not needed here.

They throw an exception.

Implements casacore::DataManager.

virtual void casacore::TiledFileHelper::create ( uInt nrrow ) [virtual]

Let the data manager initialize itself for a new table.

Implements casacore::DataManager.

virtual String casacore::TiledFileHelper::dataManagerType ( ) const [virtual]

Return the class name.

Implements casacore::DataManager.

TSMFile* casacore::TiledFileHelper::file ( ) [inline]

Definition at line 86 of file TiledFileHelper.h.

References casacore::TiledStMan::fileSet_p.

virtual Bool casacore::TiledFileHelper::flush	(	AipsIO &	ios,
		Bool	fsync
	)			`[virtual]`

Flush and optionally fsync the data.

The AipsIO stream represents the main table file and can be used by virtual column engines to store SMALL amounts of data. It returns a True status if it had to flush (i.e. if data have changed).

Implements casacore::DataManager.

virtual const TableDesc& casacore::TiledFileHelper::getDesc ( ) const [virtual]

Get the table description needed for the hypercolumn description.

Reimplemented from casacore::TiledStMan.