Isis Developer Reference
Isis::TableRecord Class Reference

#include <TableRecord.h>

Collaboration diagram for Isis::TableRecord:
Collaboration graph

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.
 
TableFieldoperator[] (const int field)
 Returns the TableField at the specified location in the TableRecord.
 
TableFieldoperator[] (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.
 

Static Public Member Functions

static QString toString (TableRecord record, QString fieldDelimiter=",", bool fieldNames=false, bool endLine=true)
 

Detailed Description

Author
2004-09-01 Jeff Anderson

Constructor & Destructor Documentation

◆ TableRecord()

Isis::TableRecord::TableRecord ( )

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

◆ ~TableRecord()

Isis::TableRecord::~TableRecord ( )

Destroys the TableRecord object.

Member Function Documentation

◆ Fields()

int Isis::TableRecord::Fields ( ) const

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

Returns
The number of fields in the record

Referenced by Pack(), Isis::Table::RecordFields(), Swap(), toString(), and Unpack().

◆ operator+=()

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

Adds a TableField to a TableRecord.

Parameters
field- TableField to be added to the record

◆ operator[]() [1/2]

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

Returns the TableField at the specified location in the TableRecord.

Parameters
fieldIndex of desired field
Returns
The TableField at specified location in the record

◆ operator[]() [2/2]

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

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

Parameters
fieldThe name of desired TableField
Returns
The specified TableField
Exceptions
Isis::IException::Programmer- The field does not exist in the record

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

◆ Pack()

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

Writes record information into the binary buffer.

Parameters
bufBuffer to fill with binary record information.
Exceptions
Isis::IException::Programmer- Invalid field type

References _FILEINFO_, Fields(), and Isis::IException::Programmer.

◆ RecordSize()

int Isis::TableRecord::RecordSize ( ) const

Returns the number of bytes per record.

Returns
Number of bytes per record

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

◆ Swap()

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

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

Parameters
bufBuffer containing record values to be swapped.
Exceptions
Isis::iException::Programmer- Invalid field type

References _FILEINFO_, Fields(), and Isis::IException::Programmer.

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

◆ toString()

QString Isis::TableRecord::toString ( TableRecord record,
QString fieldDelimiter = ",",
bool fieldNames = false,
bool endLine = true )
static

◆ Unpack()

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

Reads record information from the binary buffer.

Parameters
bufBuffer from which to read record field values.

References Fields().

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


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