Import a PDS table file with a label description. More...

#include <ImportPdsTable.h>

Collaboration diagram for Isis::ImportPdsTable:

Classes
struct	ColumnDescr

Public Member Functions
	ImportPdsTable ()
	Default constructor.

	ImportPdsTable (const QString &pdsLabFile, const QString &pdsTabFile="", const QString &pdsTableName="TABLE")
	This constructor automatically loads the given label and table files.

virtual	~ImportPdsTable ()
	Destructs the ImportPdsTable object.

QString	name () const
	Return the name of the PDS table.

void	setName (const QString &name="TABLE")
	Set the name of the PDS table object.

int	columns () const
	Returns the number of columns in the table.

int	rows () const
	Returns the number of rows in the table.

void	load (const QString &pdsLabFile, const QString &pdsTabFile="", const QString &pdsTableName="TABLE")
	Loads a PDS table label and (optional) data file.

bool	hasColumn (const QString &colName) const
	This method determines whether the PDS table has a column with the given name.

QString	getColumnName (const unsigned int &index=0, const bool &formatted=true) const
	Returns the name of the specifed column.

QStringList	getColumnNames (const bool &formatted=true) const
	Return the names of all the columns.

QString	getFormattedName (const QString &colname) const
	Converts a column name to a camel-case after it has been cleansed.

QString	getType (const QString &colName) const
	Get the type associated with the specified column.

bool	setType (const QString &colName, const QString &dataType)
	Change the datatype for a column.

Table	importTable (const QString &isisTableName)
	Populate a Table object with the PDS table and return it.

Table	importTable (const QString &colNames, const QString &isisTableName)
	Populate ISIS Table with specified column(s) from ASCII table.

Table	importTable (const QStringList &colNames, const QString &isisTableName)
	Populate ISIS Table with specific columns from ASCII table.

Protected Types
typedef QList< ColumnDescr >	ColumnTypes

typedef QStringList	Columns

typedef QList< Columns >	Rows

Protected Member Functions
const ColumnDescr &	getColumnDescriptor (const int &nth) const
	Retrieve a column description by index.

ColumnDescr *	findColumn (const QString &colName)
	Searches internal column descriptors for a named column.

const ColumnDescr *	findColumn (const QString &colName) const
	Searches internal column descriptors for a named column.

QString	getColumnValue (const QString &tline, const ColumnDescr &cdesc, const QString &delimiter="") const
	Extracts a column from a QString based upon a description.

QStringList	getColumnFields (const QString &tline, const ColumnDescr &cdesc, const QString &delimiter="") const
	Extracts column fields from a QString based upon a description.

QString	getGenericType (const QString &ttype) const
	Determine generic data type of a column.

virtual bool	processRow (const int &row, const QString &rowdata)
	Process a freshly read PDS table line of data.

Detailed Description

Import a PDS table file with a label description.

This class ingests a PDS table and converts it to an ISIS Table object. This class can handle importing PDS tables whose data is BINARY or ASCII format.

The PDS label file should completely define the contents of a PDS table with ASCII data or BINARY data. The location of the table data is determined from a label keyword, ^TABLE (or ^NAME_TABLE). This keyword will indicate the name of the file containing the table data and the start record value where the table data begins. If the keyword only gives the start record, the table is attached to the file that contains the label. If the keyword only gives a file name, that file only contains the data for the indicated table. PDS table files have the extension *.TAB if the table data is ASCII format and *.DAT if the data is BINARY. When constructing an ImportPdsTable object, programmers can provide a different name for the PDS table file.

NOTE: Depending on the INTERCHANGE_FORMAT value, programmers should choose the appropriate methods from this class.

Example of PDS ASCII table import. Construct the ImportPdsTable object with a label name, set the data type for the specified PDS columns, and import the PDS table to an Isis table with the comma separtated column names. ImportPdsTable pdsTable(labelFileName, tableFileName); pdsTable.setType("ScetTimeClock", "CHARACTER"); pdsTable.setType("ShutterStatus", "CHARACTER"); pdsTable.setType("MirrorSin", "DOUBLE"); pdsTable.setType("MirrorCos", "DOUBLE"); Table isisTable = pdsTable.importTable("ScetTimeClock,ShutterStatus,MirrorSin,MirrorCos", "VIRHouseKeeping"); Example of PDS BINARY table import. If the default constructor is used, the load method must be called to pass in the label file name. The PDS table can then be imported and an Isis Table object is returned. ImportPdsTable pdsTable; load(labelFileName, "", pdsTableName); Table isisTable = pdsTable.importTable(isisTableName);

Author: 2011-07-20 Kris Becker

Member Typedef Documentation

◆ Columns

typedef QStringList Isis::ImportPdsTable::Columns

protected

◆ ColumnTypes

typedef QList<ColumnDescr> Isis::ImportPdsTable::ColumnTypes

protected

◆ Rows

typedef QList<Columns> Isis::ImportPdsTable::Rows

protected

Constructor & Destructor Documentation

◆ ImportPdsTable() [1/2]

Isis::ImportPdsTable::ImportPdsTable ( )

Default constructor.

This constructor initializes the PDS table name to TABLE.

If this constructor is used, the load() method will need to be called to set the PDS label file.

This constructor may be used for ASCII or BINARY PDS tables.

◆ ImportPdsTable() [2/2]

Isis::ImportPdsTable::ImportPdsTable	(	const QString &	pdsLabFile,
		const QString &	pdsTableFile = "",
		const QString &	pdsTableName = "TABLE" )

This constructor automatically loads the given label and table files.

This constructor takes the name of the label file describing the PDS table, the table data file name, and the name of the PDS table object. It will extract the description of the columns and read the contents of the table data file.

If no table file is given or an empty QString is given for the table file, the table location will be read from the label file.

If no table name is given, the default name for the object is TABLE.

This constructor may be used for ASCII or BINARY PDS tables.

Parameters

pdsLabFile	Name of table label file
pdsTableFile	Name of table data file
pdsTableName	The name of the table object in the PDS file.

References load().

◆ ~ImportPdsTable()

Isis::ImportPdsTable::~ImportPdsTable ( )

virtual

Destructs the ImportPdsTable object.

Member Function Documentation

◆ columns()

int Isis::ImportPdsTable::columns ( ) const

Returns the number of columns in the table.

This method can be called for ASCII or BINARY PDS tables.

Returns: int The number of columns.

Referenced by getColumnDescriptor(), getColumnName(), getColumnNames(), and processRow().

◆ findColumn() [1/2]

ImportPdsTable::ColumnDescr * Isis::ImportPdsTable::findColumn ( const QString & colName )

protected

Searches internal column descriptors for a named column.

This method converts the column names to a formatted name for consistency and then checks for the given name - with case insensitivity. If found, a pointer to the column description is returned, otherwise NULL.

This method can be called for ASCII or BINARY PDS tables.

Parameters

colName Name of column to find

Returns: ImportPdsTable::ColumnDescr* Pointer to column description is returned if found otherwise, NULL is returned.

References getFormattedName().

Referenced by getType(), hasColumn(), importTable(), and setType().

◆ findColumn() [2/2]

const ImportPdsTable::ColumnDescr * Isis::ImportPdsTable::findColumn ( const QString & colName ) const

protected

Searches internal column descriptors for a named column.

This method converts the column names to a formatted name for consistency and then checks for the given name - with case insensitivity. If found, a pointer to the column description is returned, otherwise NULL.

This method can be called for ASCII or BINARY PDS tables.

Parameters

colName Name of column to find

Returns: const ImportPdsTable::ColumnDescr* Const pointer to column description is returned if found otherwise, NULL is returned.

References getFormattedName().

◆ getColumnDescriptor()

const ImportPdsTable::ColumnDescr & Isis::ImportPdsTable::getColumnDescriptor ( const int & nth ) const

protected

Retrieve a column description by index.

Author: 2015-07-17 Kris Becker

Parameters

nth	Index of column description to retrieve, starting at 0

Returns: const ImportPdsTable::ColumnDescr& Reference to requested column description

Exceptions

IException::Programmer "Index ([nth]) into Columns invalid (max: [columns])"

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

◆ getColumnFields()

QStringList Isis::ImportPdsTable::getColumnFields	(	const QString &	tline,
		const ColumnDescr &	cdesc,
		const QString &	delimiter = "" ) const

protected

Extracts column fields from a QString based upon a description.

This method should not be called for BINARY PDS tables.

Parameters

tline	Row from table data
cdesc	Column description
delimiter	Delimiter used to delimit column fields (optional)

Returns: QStringList Returns the extracted column fields as a QStringList

References getColumnValue().

◆ getColumnName()

QString Isis::ImportPdsTable::getColumnName	(	const unsigned int &	index = 0,
		const bool &	formatted = true ) const

Returns the name of the specifed column.

This method will return the name of a specified column by index. It also has the option to format the column name to Camel-Case. This will remove all left and right parens, convert white space to spaces, compress consecutive spaces to only one space. It then removes the spaces converting the next character to uppercase.

This method can be called for ASCII or BINARY PDS tables.

Parameters

index	Index of colunm name to get.
formatted	Specifies to convert the name to Camel-Case if true, otherwise leave as is in the PDS table.

Returns: QString Returns the column name as requested

Exceptions

IException::Programmer "Unable to import the binary PDS table into Isis. The requested column index exceeds the last column index."

References _FILEINFO_, columns(), getFormattedName(), name(), Isis::IException::Programmer, and Isis::toString().

◆ getColumnNames()

QStringList Isis::ImportPdsTable::getColumnNames ( const bool & formatted = true ) const

Return the names of all the columns.

This method will return the names of all columns. It also has the option to format the column name to Camel-Case. This will remove all left and right parens, convert white space to spaces, compress consecutive spaces to only one space. It then removes the spaces converting the next character to uppercase.

This method can be called for ASCII or BINARY PDS tables.

Parameters

formatted Specifies to convert the name to Camel-Case if true, otherwise leave as is in the PDS table.

Returns: QStringList List of all column names.

References columns(), getFormattedName(), and name().

◆ getColumnValue()

QString Isis::ImportPdsTable::getColumnValue	(	const QString &	tline,
		const ColumnDescr &	cdesc,
		const QString &	delimiter = "" ) const

protected

Extracts a column from a QString based upon a description.

This method should not be called for BINARY PDS tables.

Parameters

tline	Row from table data
cdesc	Column description

Returns: QString Returns the extracted column as a QString

Referenced by getColumnFields(), and processRow().

◆ getFormattedName()

QString Isis::ImportPdsTable::getFormattedName ( const QString & colname ) const

Converts a column name to a camel-case after it has been cleansed.

This method will convert a column name to camel-case after some character cleaning is performed. All white space characters as defined by the IString class are converted to spaces. Spaces are then compressed to one space. Any left/right parens are removed. Then the conversion to camel-case is performed.

Camel case always converts the first character in a QString to uppercase. Any space or '_' character are removed and the following character is converted to uppercase. All other characters are converted to lowercase.

This method can be called for ASCII or BINARY PDS tables.

Parameters

colname Column name to converty

Returns: QString Returns the formatted keyword

Referenced by findColumn(), findColumn(), getColumnName(), and getColumnNames().

◆ getGenericType()

QString Isis::ImportPdsTable::getGenericType ( const QString & ttype ) const

protected

Determine generic data type of a column.

This method will determine the generic type of a column. In general, PDS table descriptions contain types that have some prepended qualifiers to column data types. This routine removes those qualifiers and only returns the generic type.

For example, if the incoming type is MSB_INTEGER, only INTEGER will be returned.

This method is used for ASCII or BINARY PDS tables.

Parameters

ttype PDS data type to convert

Returns: QString Generic type found in the data type.

◆ getType()

QString Isis::ImportPdsTable::getType ( const QString & colName ) const

Get the type associated with the specified column.

This method returns the datatype associated with the specfied column. If the column does not exist, an empty QString is returned.

This method can be called for ASCII or BINARY PDS tables.

Author: 2011-06-27 Kris Becker

Parameters

colName Name of column to get type for.

Returns: QString Returns the type of the column. If the column does not exist, an empty QString is returned.

References findColumn(), and Isis::ImportPdsTable::ColumnDescr::m_dataType.

◆ hasColumn()

bool Isis::ImportPdsTable::hasColumn ( const QString & colName ) const

This method determines whether the PDS table has a column with the given name.

This method can be called for ASCII or BINARY PDS tables.

Parameters

colName A QString containing the column name.

Returns: bool Indicates whether the table has the given column.

References findColumn().

◆ importTable() [1/3]

Table Isis::ImportPdsTable::importTable	(	const QString &	colnames,
		const QString &	isisTableName )

Populate ISIS Table with specified column(s) from ASCII table.

This method extracts columns specified by the caller in a QString. It is typically used for a single column, but any number of columns can be provided. colnames is a comma delimited QString that contains the name of the columns that will be exported in the table.

This method should only be called for ASCII PDS tables. If needed for BINARY tables, implementation should be added and tested.

Parameters

colNames	String containing comma delimited column names to export
isisTableName	Name of table to create

Returns: Table Table containing the specified columns

References importTable().

◆ importTable() [2/3]

Table Isis::ImportPdsTable::importTable ( const QString & isisTableName )

Populate a Table object with the PDS table and return it.

This method converts PDS table data to an ISIS table.

This method can be called to import ASCII or BINARY PDS tables.

Parameters

isisTableName Name of table

Returns: Table Table containing PDS table data

Exceptions

IException::Unknown "Unable to import the PDS table from the PDS file into Isis."

References _FILEINFO_, and Isis::IException::Unknown.

Referenced by importTable().

◆ importTable() [3/3]

Table Isis::ImportPdsTable::importTable	(	const QStringList &	colnames,
		const QString &	isisTableName )

Populate ISIS Table with specific columns from ASCII table.

This method extracts columns specified by the caller. If the requested column does not exist, an exception is thrown.

This method should only be called for ASCII PDS tables. If needed for BINARY tables, implementation should be added and tested.

Parameters

colNames	QStringList of column names to convert to a table.
isisTableName	Name of the table to create.

Returns: Table Table containing the specified columns

Exceptions

IException::Programmer "Unable to import the PDS table into Isis. The requested column name does not exist in table."

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

◆ load()

void Isis::ImportPdsTable::load	(	const QString &	pdsLabFile,
		const QString &	pdsTableFile = "",
		const QString &	pdsTableName = "TABLE" )

Loads a PDS table label and (optional) data file.

This method will load a PDS table dataset using a label file describing the contents of the table data. The caller can provide the table data file, otherwise, the location of the table data is extracted from the ^TABLE_NAME keyword in the provided labels. The table data is then loaded.

This method needs to be called if the default constructor is used. Otherwise, it is invoked in the constructor that takes the label, table file, and table name. This method may be used to overwrite the label and table file used. When it is invoked, the current contents of the object are discarded.

This method is used for ASCII or BINARY PDS tables.

Parameters

pdsLabFile	Name of PDS table label file
pdsTableFile	Name of PDS table data file to be imported into Isis (optional)
pdsTableName	Name of the table object in the PDS file (optional)

Exceptions

IException::Unknown "Unable to import PDS table. Neither of the possible table values were found."

References _FILEINFO_, Isis::toInt(), and Isis::IException::Unknown.

Referenced by ImportPdsTable().

◆ name()

QString Isis::ImportPdsTable::name ( ) const

Return the name of the PDS table.

Referenced by getColumnName(), getColumnNames(), and setName().

◆ processRow()

bool Isis::ImportPdsTable::processRow	(	const int &	row,
		const QString &	rowdata )

protectedvirtual

Process a freshly read PDS table line of data.

Author: 2015-07-17 Kris Becker

Parameters

row	Row number being processed
rowdata	Character line of data

Returns: bool True if succssful, false if error

References columns(), and getColumnValue().

◆ rows()

int Isis::ImportPdsTable::rows ( ) const

Returns the number of rows in the table.

This method can be called for ASCII or BINARY PDS tables.

Returns: int The number of rows.

◆ setName()

void Isis::ImportPdsTable::setName ( const QString & name = "TABLE" )

Set the name of the PDS table object.

Parameters

name	New name for the PDS table object

References name().

◆ setType()

bool Isis::ImportPdsTable::setType	(	const QString &	colName,
		const QString &	dataType )

Change the datatype for a column.

This method changes the data type the specified column. If the column can not be found, false is returned (indicating an unsuccessful change).

This method can be called for ASCII or BINARY PDS tables.

Author: 2011-06-27 Kris Becker

Parameters

colName	Name of column to change.
dtype	New type of column. Support types are DOUBLE, REAL, INTEGER and CHARACTER. Unsupported/unknown types are treated as CHARACTER.

Returns: bool Indicates if the change was successful.

References findColumn(), and Isis::ImportPdsTable::ColumnDescr::m_dataType.

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

/Users/chkim/repos/ISIS3/isis/src/base/objs/ImportPdsTable/ImportPdsTable.h
/Users/chkim/repos/ISIS3/isis/src/base/objs/ImportPdsTable/ImportPdsTable.cpp

Classes

Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Columns

◆ ColumnTypes

◆ Rows

Constructor & Destructor Documentation

◆ ImportPdsTable() [1/2]

◆ ImportPdsTable() [2/2]

◆ ~ImportPdsTable()

Member Function Documentation

◆ columns()

◆ findColumn() [1/2]

◆ findColumn() [2/2]

◆ getColumnDescriptor()

◆ getColumnFields()

◆ getColumnName()

◆ getColumnNames()

◆ getColumnValue()

◆ getFormattedName()

◆ getGenericType()

◆ getType()

◆ hasColumn()

◆ importTable() [1/3]

◆ importTable() [2/3]

◆ importTable() [3/3]

◆ load()

◆ name()

◆ processRow()

◆ rows()

◆ setName()

◆ setType()