Class for storing Table blobs information. More...

#include <Table.h>

Inheritance diagram for Isis::Table:

Collaboration diagram for Isis::Table:

Public Types
enum	Association { None, Samples, Lines, Bands }

Public Member Functions
	Table (const QString &tableName, TableRecord &rec)
	This constructor creates a new table using the given name and record.

	Table (const QString &tableName)
	This constructor creates an empty table from an existing table name to be read in when the Read() method is called.

	Table (const QString &tableName, const QString &file)
	This constructor reads an existing table using the given table name and file containing the table.

	Table (const QString &tableName, const QString &file, const Pvl &fileHeader)
	This constructor reads an existing table using the given table name and file containing the table and pvl labels.

	Table (const Table &other)
	Copy constructor for an Table object.

Table &	operator= (const Isis::Table &other)
	Sets the Table equal to the input Table object.

	~Table ()
	Destroys the Table object.

void	SetAssociation (const Table::Association assoc)
	Sets the association to the input parameter.

bool	IsSampleAssociated ()
	Checks to see if association is Samples.

bool	IsLineAssociated ()
	Checks to see if association is Lines.

bool	IsBandAssociated ()
	Checks to see if association is Bands.

int	Records () const
	Returns the number of records.

int	RecordFields () const
	Returns the number of fields per record.

int	RecordSize () const
	Returns the number of bytes per record.

TableRecord &	operator[] (const int index)
	Reads a TableRecord from the Table.

void	operator+= (TableRecord &rec)
	Adds a TableRecord to the Table.

void	Update (const TableRecord &rec, const int index)
	Updates a TableRecord.

void	Delete (const int index)
	Deletes a TableRecord from the Table.

void	Clear ()
	Clear the table of all records.

QString	Type () const
	Accessor method that returns a string containing the Blob type.

QString	Name () const
	Accessor method that returns a string containing the Blob name.

int	Size () const
	Accessor method that returns the number of bytes in the blob data.

PvlObject &	Label ()
	Accessor method that returns a PvlObject containing the Blob label.

void	Read (const QString &file)
	This method reads Pvl values from a specified file.

void	Read (const QString &file, const Pvl &pvlLabels)
	This method reads the given a file and labels.

virtual void	Read (const Pvl &pvl, std::istream &is)
	This method reads the Blob data from an open input file stream.

void	Write (const QString &file)
	Write the blob data out to a file.

void	Write (Pvl &pvl, std::fstream &stm, const QString &detachedFileName="")
	Write the blob data out to a Pvl object.

Protected Member Functions
void	ReadInit ()
	Virtual function to validate PVL table information.

void	ReadData (std::istream &stream)
	Virtual function to Read the data.

void	WriteInit ()
	Virtual Function to prepare labels for writing.

void	WriteData (std::fstream &os)
	Virtual function to write the data.

void	Find (const Pvl &pvl)
	This method searches the given Pvl for the Blob by the Blob's type and name.

Protected Attributes
TableRecord	p_record
	The current table record.

std::vector< char * >	p_recbufs
	Buffers containing record values.

int	p_records
	Holds record count read from labels, may differ from the size of p_recbufs.

Association	p_assoc
	Association Type of the table.

bool	p_swap
	Only used for reading.

PvlObject	p_blobPvl
	Pvl Blob object.

QString	p_blobName
	Name of the Blob object.

char *	p_buffer
	Buffer blob data is stored in.

BigInt	p_startByte
	Byte blob data starts at in buffer.

int	p_nbytes
	Size of blob data (in bytes)

QString	p_type
	Type of data stored in the buffer.

QString	p_detached
	Used for reading detached blobs.

QString	p_labelFile
	The file containing the labels.

Detailed Description

Class for storing Table blobs information.

This class can create new Tables or read table blobs from files. In general, records correspond to rows and fields correspond to columns. Thus the TableRecord class corresponds to a vector of row entries and TableField class corresponds to a specific entry of the table for a given record. Isis3 Table objects are record based, N records in a table. Each record will have the same number of fields, F. The fields can be of different types including Integer, Double, Text, and Real. The class uses PVL to store the structure of the table N, F, and Field types and binary to store the table data.

See the classes TableRecord and TableField for more information.

If you would like to see Table being used in implementation, see histats.cpp

Author: 2004-09-01 Jeff Anderson

History:

2005-03-18 Elizabeth Ribelin - Added documentation to class

2006-09-19 Jeff Anderson - Added clear method

2006-09-19 Jeff Anderson - Fixed bug in ReadInit method which needed to cleanup pointers to records if a re-read occurred.

2009-02-18 Steven Lambright - Added copy constructor and assignment operator.

2011-05-25 Janet Barrett and Steven Lambright Added a Constructor that takes the pvl labels so they do not have to be re-read, which is a very expensive operation.

2012-10-04 Jeannie Backer Changed references to TableField methods to lower camel case. Ordered includes. Added documentation. Added error check to operator+=(TableRecord) if the Table's record size does not match the added TableRecord's size. Fixed header definition statement. Added forward declaration and includes. Fixed indentation of history entries. Moved method implementation to cpp file. Ordered includes in unitTest. Added RecordFields() accessor method. Improved test coverage in all categories. Added padding to control statements. References #1169.

Definition at line 77 of file Table.h.

Constructor & Destructor Documentation

Isis::Table::Table	(	const QString &	tableName,
		Isis::TableRecord &	rec
	)

This constructor creates a new table using the given name and record.

The Table::Association is set to None, the ByteOrder keyword in the labels is set to NULL, and the record information is added to the table.

This constructor also calls the parent constructor Blob(tableName, "Table").

Parameters

tableName	Name of the Table to be read
rec	Name of the TableRecord to be read into the Table

Definition at line 47 of file Table.cpp.

References Isis::PvlObject::addGroup(), Isis::TableRecord::Fields(), p_assoc, Isis::Blob::p_blobPvl, and p_record.

Isis::Table::Table ( const QString & tableName )

This constructor creates an empty table from an existing table name to be read in when the Read() method is called.

It should not be used to construct a new table object whose data will be filled in later since the record size will be set to 0. This constructor sets the Table::Association to None.

This constructor also calls the parent constructor Blob(tableName, "Table").

Parameters

tableName Name of the Table to be read

Definition at line 68 of file Table.cpp.

References p_assoc.

Isis::Table::Table	(	const QString &	tableName,
		const QString &	file
	)

This constructor reads an existing table using the given table name and file containing the table.

This constructor sets the Table::Association to the Association keyword value in the Blob Pvl read from the file, if the keyword exists.

This constructor also calls the parent constructor Blob(tableName, "Table").

Parameters

tableName	Name of the Table to be read
file	Name of the file to be read into the Table

See Also: Blob::Read()

Definition at line 87 of file Table.cpp.

References p_assoc, and Isis::Blob::Read().

Isis::Table::Table	(	const QString &	tableName,
		const QString &	file,
		const Pvl &	fileHeader
	)

This constructor reads an existing table using the given table name and file containing the table and pvl labels.

This constructor sets the Table::Association to the Association keyword value in the Blob Pvl read from the file, if the keyword exists.

This constructor also calls the parent constructor Blob(tableName, "Table").

Parameters

tableName	The name of the Table to be read
file	The name of the file to be read into the Table
fileHeader	Pvl labels.

See Also: Blob::Read()

Definition at line 108 of file Table.cpp.

References p_assoc, and Isis::Blob::Read().

Isis::Table::Table ( const Table & other )

Copy constructor for an Table object.

This constructor copies TableRecords and the member variable values for record, records, assoc, and swap.

Parameters

other The table to copy from

Definition at line 121 of file Table.cpp.

References p_assoc, p_recbufs, p_record, p_records, p_swap, and RecordSize().

Isis::Table::~Table ( )

Destroys the Table object.

Definition at line 168 of file Table.cpp.

References Clear().

Member Function Documentation

void Isis::Table::Clear ( )

Clear the table of all records.

Definition at line 312 of file Table.cpp.

References p_recbufs.

Referenced by ReadInit(), and ~Table().

void Isis::Table::Delete ( const int index )

Deletes a TableRecord from the Table.

Parameters

index Index of TableRecord to be deleted

Definition at line 302 of file Table.cpp.

References p_recbufs.

void Isis::Blob::Find ( const Pvl & pvl )

protectedinherited

This method searches the given Pvl for the Blob by the Blob's type and name.

If found, the start byte, number of bytes are read from the Pvl. Also, if a keyword label pointer is found, the filename for the detached blob is stored and the pointer is removed from the blob pvl.

Parameters

pvl	The Pvl to be searched

Definition at line 179 of file Blob.cpp.

References _FILEINFO_, Isis::PvlContainer::isNamed(), Isis::PvlObject::object(), Isis::PvlObject::objects(), and Isis::FileName::path().

bool Isis::Table::IsBandAssociated ( )

Checks to see if association is Bands.

Returns: bool Returns true if association is Bands, and false if it is not

Definition at line 207 of file Table.cpp.

References p_assoc.

bool Isis::Table::IsLineAssociated ( )

Checks to see if association is Lines.

Returns: bool Returns true if association is Lines, and false if it is not

Definition at line 197 of file Table.cpp.

References p_assoc.

bool Isis::Table::IsSampleAssociated ( )

Checks to see if association is Samples.

Returns: bool Returns true if association is Samples, and false if it is not

Definition at line 187 of file Table.cpp.

References p_assoc.

PvlObject & Isis::Blob::Label ( )

inherited

Accessor method that returns a PvlObject containing the Blob label.

Returns: PvlObject The label of the blob.

Definition at line 167 of file Blob.cpp.

Referenced by Isis::SpiceRotation::CacheLabel(), Isis::SpicePosition::CacheLabel(), Isis::DawnVirCamera::getPointingTable(), Isis::SpicePosition::LoadCache(), and Isis::SpiceRotation::LoadCache().

QString Isis::Blob::Name ( ) const

inherited

Accessor method that returns a string containing the Blob name.

Returns: string The name of the blob.

Definition at line 149 of file Blob.cpp.

Referenced by Isis::Image::isFootprintable(), Isis::SpicePosition::LoadCache(), and Isis::Cube::write().

void Isis::Table::operator+= ( Isis::TableRecord & rec )

Adds a TableRecord to the Table.

Parameters

rec	The record to be added to the table

Definition at line 255 of file Table.cpp.

References _FILEINFO_, Isis::Blob::p_blobName, p_recbufs, Isis::TableRecord::Pack(), Isis::TableRecord::RecordSize(), RecordSize(), Isis::toString(), and Isis::IException::Unknown.

Table & Isis::Table::operator= ( const Isis::Table & other )

Sets the Table equal to the input Table object.

This method copies TableRecords and the member variable values for record, records, assoc, and swap.

Parameters

other The table to copy from

Returns: Table The copied table.

Definition at line 147 of file Table.cpp.

References p_assoc, p_recbufs, p_record, p_records, p_swap, and RecordSize().

Isis::TableRecord & Isis::Table::operator[] ( const int index )

Reads a TableRecord from the Table.

Parameters

index Index where desired TableRecord is located

Returns: Returns the TableRecord at specific index

Definition at line 245 of file Table.cpp.

References p_recbufs, p_record, and Isis::TableRecord::Unpack().

void Isis::Blob::Read ( const QString & file )

inherited

This method reads Pvl values from a specified file.

Parameters

file	The filename to read from.

Exceptions

iException::Io	- Unable to open file
iException::Pvl	- Invalid label format

Definition at line 243 of file Blob.cpp.

References _FILEINFO_, and Isis::Pvl::read().

Referenced by Isis::History::History(), Isis::OriginalLabel::OriginalLabel(), Isis::History::Read(), Isis::Cube::read(), and Table().

void Isis::Blob::Read	(	const QString &	file,
		const Pvl &	pvlLabels
	)

inherited

This method reads the given a file and labels.

Parameters

file	The filename to read from.
pvlLabels	A Pvl containing the label information.

Exceptions

iException::Io - Unable to open file

Definition at line 268 of file Blob.cpp.

References _FILEINFO_, and Isis::Message::FileOpen().

void Isis::Blob::Read	(	const Pvl &	pvl,
		std::istream &	istm
	)

virtualinherited

This method reads the Blob data from an open input file stream.

Parameters

pvl	A Pvl containing the label information.
istm	The input file stream containing the blob data to be read.

Exceptions

iException::Io - Unable to open file

Reimplemented in Isis::History.

Definition at line 303 of file Blob.cpp.

References _FILEINFO_, and Isis::Message::FileOpen().

void Isis::Table::ReadData ( std::istream & stream )

protectedvirtual

Virtual function to Read the data.

Parameters

stream InputStream to read data in from

Exceptions

Isis::IException::Io - Error reading or preparing to read a record

Reimplemented from Isis::Blob.

Definition at line 356 of file Table.cpp.

References _FILEINFO_, Isis::IException::Io, Isis::Blob::p_blobName, p_recbufs, p_record, p_records, Isis::Blob::p_startByte, p_swap, RecordSize(), Isis::TableRecord::Swap(), and Isis::toString().

void Isis::Table::ReadInit ( )

protectedvirtual

Virtual function to validate PVL table information.

Reimplemented from Isis::Blob.

Definition at line 318 of file Table.cpp.

References Clear(), Isis::PvlObject::group(), Isis::PvlObject::groups(), Isis::PvlObject::hasKeyword(), Isis::IsLsb(), Isis::IsMsb(), Isis::PvlContainer::isNamed(), p_assoc, Isis::Blob::p_blobPvl, p_record, p_records, and p_swap.

int Isis::Table::RecordFields ( ) const

Returns the number of fields per record.

Returns: int Number of fields

Definition at line 225 of file Table.cpp.

References Isis::TableRecord::Fields(), and p_record.

int Isis::Table::Records ( ) const

Returns the number of records.

Returns: int Number of records

Definition at line 216 of file Table.cpp.

References p_recbufs.

Referenced by Isis::ExportPdsTable::ExportPdsTable(), Isis::ProcessExportPds::ExportTable(), Isis::DawnVirCamera::getPointingTable(), Isis::ApolloPanoramicDetectorMap::initializeInteriorOrientation(), Isis::SpicePosition::LoadCache(), Isis::SpiceRotation::LoadCache(), Isis::Blobber::loadDouble(), Isis::Blobber::loadInteger(), Isis::DawnVirCamera::readHouseKeeping(), Isis::HrscCamera::ReadLineRates(), Isis::ProcessMosaic::SetMosaicOrigin(), Isis::AdvancedTrackTool::TrackMosaicOrigin(), WriteData(), and WriteInit().

int Isis::Table::RecordSize ( ) const

Returns the number of bytes per record.

Returns: int Number of bytes per record

Definition at line 234 of file Table.cpp.

References p_record, and Isis::TableRecord::RecordSize().

Referenced by operator+=(), operator=(), ReadData(), Table(), WriteData(), and WriteInit().

void Isis::Table::SetAssociation ( const Table::Association assoc )

Sets the association to the input parameter.

Parameters

assoc Association type

Definition at line 177 of file Table.cpp.

References p_assoc.

int Isis::Blob::Size ( ) const

inherited

Accessor method that returns the number of bytes in the blob data.

Returns: int Number of bytes in the blob data.

Definition at line 158 of file Blob.cpp.

Referenced by Isis::BundleAdjust::Observations().

QString Isis::Blob::Type ( ) const

inherited

Accessor method that returns a string containing the Blob type.

Returns: string Type of blob.

Definition at line 140 of file Blob.cpp.

Referenced by Isis::Image::isFootprintable(), and Isis::Cube::write().

void Isis::Table::Update	(	const TableRecord &	rec,
		const int	index
	)

Updates a TableRecord.

Parameters

rec	TableRecord to update old TableRecord with
index	Index of TableRecord to be updated

Definition at line 293 of file Table.cpp.

References p_recbufs, and Isis::TableRecord::Pack().

void Isis::Blob::Write ( const QString & file )

inherited

Write the blob data out to a file.

Parameters

file	The filename to write to.

Exceptions

IException::Io	- Unable to open file
IException::Io	- Error preparing to write data to file
IException::Io	- Error creating file

Definition at line 369 of file Blob.cpp.

References _FILEINFO_, Isis::PvlObject::addObject(), Isis::PvlObject::findObject(), Isis::toString(), and Isis::Pvl::write().

Referenced by Isis::Cube::write().

void Isis::Blob::Write	(	Pvl &	pvl,
		std::fstream &	stm,
		const QString &	detachedFileName = `""`
	)

inherited

Write the blob data out to a Pvl object.

Parameters

pvl	The pvl object to update
stm	stream to write data to
detachedFileName	If the stream is detached from the labels give the name of the file

Definition at line 418 of file Blob.cpp.

References Isis::PvlObject::addObject(), Isis::PvlContainer::name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), and Isis::toString().

void Isis::Table::WriteData ( std::fstream & os )

protectedvirtual

Virtual function to write the data.

Parameters

os	Outputstream to write the data to

Reimplemented from Isis::Blob.

Definition at line 411 of file Table.cpp.

References p_recbufs, Records(), and RecordSize().

void Isis::Table::WriteInit ( )

protectedvirtual

Virtual Function to prepare labels for writing.

Reimplemented from Isis::Blob.

Definition at line 381 of file Table.cpp.

References Isis::PvlContainer::deleteKeyword(), Isis::PvlObject::hasKeyword(), Isis::IsLsb(), p_assoc, Isis::Blob::p_blobPvl, Isis::Blob::p_nbytes, Records(), RecordSize(), and Isis::toString().

Member Data Documentation

Association Isis::Table::p_assoc

protected

Association Type of the table.

Definition at line 136 of file Table.h.

Referenced by IsBandAssociated(), IsLineAssociated(), IsSampleAssociated(), operator=(), ReadInit(), SetAssociation(), Table(), and WriteInit().

QString Isis::Blob::p_blobName

protectedinherited

Name of the Blob object.

Definition at line 95 of file Blob.h.

Referenced by Isis::Blob::Blob(), operator+=(), Isis::Blob::operator=(), ReadData(), and Isis::ImagePolygon::ReadData().

PvlObject Isis::Blob::p_blobPvl

protectedinherited

Pvl Blob object.

Definition at line 94 of file Blob.h.

Referenced by Isis::Blob::Blob(), Isis::Blob::operator=(), ReadInit(), Table(), and WriteInit().

char* Isis::Blob::p_buffer

protectedinherited

Buffer blob data is stored in.

Definition at line 97 of file Blob.h.

Referenced by Isis::Blob::Blob(), Isis::Blob::operator=(), Isis::History::ReturnHist(), Isis::OriginalLabel::ReturnLabels(), Isis::History::WriteInit(), and Isis::OriginalLabel::WriteInit().

QString Isis::Blob::p_detached

protectedinherited

Used for reading detached blobs.

Definition at line 101 of file Blob.h.

Referenced by Isis::Blob::Blob(), and Isis::Blob::operator=().

QString Isis::Blob::p_labelFile

protectedinherited

The file containing the labels.

Definition at line 102 of file Blob.h.

Referenced by Isis::Blob::Blob(), and Isis::Blob::operator=().

int Isis::Blob::p_nbytes

protectedinherited

Size of blob data (in bytes)

Definition at line 99 of file Blob.h.

Referenced by Isis::Blob::Blob(), Isis::Blob::operator=(), Isis::ImagePolygon::ReadData(), Isis::History::ReturnHist(), Isis::OriginalLabel::ReturnLabels(), Isis::ImagePolygon::WriteData(), Isis::History::WriteInit(), Isis::OriginalLabel::WriteInit(), WriteInit(), and Isis::ImagePolygon::WriteInit().

std::vector<char *> Isis::Table::p_recbufs

protected

Buffers containing record values.

Definition at line 131 of file Table.h.

Referenced by Clear(), Delete(), operator+=(), operator=(), operator[](), ReadData(), Records(), Table(), Update(), and WriteData().

TableRecord Isis::Table::p_record

protected

The current table record.

Definition at line 130 of file Table.h.

Referenced by operator=(), operator[](), ReadData(), ReadInit(), RecordFields(), RecordSize(), and Table().

int Isis::Table::p_records

protected

  Holds record count read from labels, may differ from

the size of p_recbufs.

Definition at line 133 of file Table.h.

Referenced by operator=(), ReadData(), ReadInit(), and Table().

BigInt Isis::Blob::p_startByte

protectedinherited

Byte blob data starts at in buffer.

Definition at line 98 of file Blob.h.

Referenced by Isis::Blob::Blob(), Isis::Blob::operator=(), ReadData(), and Isis::ImagePolygon::ReadData().

bool Isis::Table::p_swap

protected

Only used for reading.

Definition at line 137 of file Table.h.

Referenced by operator=(), ReadData(), ReadInit(), and Table().

QString Isis::Blob::p_type

protectedinherited

Type of data stored in the buffer.

Definition at line 100 of file Blob.h.

Referenced by Isis::Blob::Blob(), Isis::Blob::operator=(), and Isis::ImagePolygon::ReadData().

The documentation for this class was generated from the following files:

src/base/objs/Table/Table.h
src/base/objs/Table/Table.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation