#include <TableRecord.h>

Collaboration diagram for Isis::TableRecord:

Public Member Functions
	TableRecord ()
	Constructs an empty TableRecord object. No member variables are set.

	~TableRecord ()
	Destroys the TableRecord object.

void	operator+= (Isis::TableField &field)
	Adds a TableField to a TableRecord.

TableField &	operator[] (const int field)
	Returns the TableField at the specified location in the TableRecord.

TableField &	operator[] (const QString &field)
	Returns the TableField in the record whose name corresponds to the input string.

int	Fields () const
	Returns the number of fields that are currently in the record.

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

void	Pack (char *buf) const
	Writes record information into the binary buffer.

void	Unpack (const char *buf)
	Reads record information from the binary buffer.

void	Swap (char *buf) const
	Swaps bytes of the buffer, depending on the TableField::Type.

Private Attributes
std::vector< TableField >	p_fields
	Vector of TableFields in the record.

Detailed Description

Author: 2004-09-01 Jeff Anderson

History:

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

2007-05-28 Steven Lambright - Added 4 byte float capablilities.

2008-06-19 Christopher Austin - Fixed the Packing of text TableFields

2008-06-25 Christopher Austin - Fixed the swapping of text

2012-10-04 Jeannie Backer Changed references to TableField methods in implementation and unitTest files to lower camel case. Added and ordered includes. Moved method implementation to cpp. Fixed header definition statement. Fixed indentation of history entries. Ordered methods in cpp file. Improved test coverage in all categories. Added padding to control statements. References #1169.

Todo:: Finish class documentation

Definition at line 57 of file TableRecord.h.

Constructor & Destructor Documentation

Isis::TableRecord::TableRecord ( )

Constructs an empty TableRecord object. No member variables are set.

Definition at line 37 of file TableRecord.cpp.

Isis::TableRecord::~TableRecord ( )

Destroys the TableRecord object.

Definition at line 41 of file TableRecord.cpp.

Member Function Documentation

int Isis::TableRecord::Fields ( ) const

Returns the number of fields that are currently in the record.

Returns: The number of fields in the record

Definition at line 94 of file TableRecord.cpp.

Referenced by Isis::ImportPdsTable::extractBinary(), Isis::DawnVirCamera::getPointingTable(), Isis::SpicePosition::LoadCache(), Isis::SpiceRotation::LoadCache(), Isis::ExportPdsTable::Pack(), Isis::Table::RecordFields(), and Isis::Table::Table().

void Isis::TableRecord::operator+= ( Isis::TableField & field )

Adds a TableField to a TableRecord.

Parameters

field - TableField to be added to the record

Definition at line 50 of file TableRecord.cpp.

Isis::TableField & Isis::TableRecord::operator[] ( const int field )

Returns the TableField at the specified location in the TableRecord.

Parameters

field Index of desired field

Returns: The TableField at specified location in the record

Definition at line 61 of file TableRecord.cpp.

TableField & Isis::TableRecord::operator[] ( const QString & field )

Returns the TableField in the record whose name corresponds to the input string.

Parameters

field The name of desired TableField

Returns: The specified TableField

Exceptions

Isis::IException::Programmer - The field does not exist in the record

Definition at line 76 of file TableRecord.cpp.

References _FILEINFO_, and Isis::IString::UpCase().

void Isis::TableRecord::Pack ( char * buf ) const

Writes record information into the binary buffer.

Parameters

buf	Buffer to fill with binary record information.

Exceptions

Isis::IException::Programmer - Invalid field type

Definition at line 116 of file TableRecord.cpp.

References _FILEINFO_, Isis::TableField::isDouble(), Isis::TableField::isInteger(), Isis::TableField::isReal(), Isis::TableField::isText(), and Isis::TableField::size().

Referenced by Isis::Table::operator+=(), and Isis::Table::Update().

int Isis::TableRecord::RecordSize ( ) const

Returns the number of bytes per record.

Returns: Number of bytes per record

Definition at line 103 of file TableRecord.cpp.

Referenced by Isis::ExportPdsTable::exportTable(), Isis::Table::operator+=(), and Isis::Table::RecordSize().

void Isis::TableRecord::Swap ( char * buf ) const

Swaps bytes of the buffer, depending on the TableField::Type.

Parameters

buf	Buffer containing record values to be swapped.

Exceptions

Isis::iException::Programmer - Invalid field type

Definition at line 184 of file TableRecord.cpp.

References _FILEINFO_, Isis::TableField::bytes(), Isis::TableField::isDouble(), Isis::TableField::isInteger(), Isis::TableField::isReal(), Isis::TableField::isText(), and Isis::TableField::size().

Referenced by Isis::Table::ReadData().

void Isis::TableRecord::Unpack ( const char * buf )

Reads record information from the binary buffer.

Parameters

buf	Buffer from which to read record field values.

Definition at line 168 of file TableRecord.cpp.

References Isis::TableField::bytes().

Referenced by Isis::Table::operator[]().

Member Data Documentation

std::vector<TableField> Isis::TableRecord::p_fields

private

Vector of TableFields in the record.

Definition at line 74 of file TableRecord.h.

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

src/base/objs/TableRecord/TableRecord.h
src/base/objs/TableRecord/TableRecord.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation