Format ascii tables. More...

#include <Column.h>

Collaboration diagram for Isis::Column:

Public Types
enum	Align { NoAlign = 0 , Right = 1 , Left = 2 , Decimal = 3 }
	Alignment of data in the Column. More...

enum	Type { NoType = 0 , Integer = 1 , Real = 2 , String = 3 , Pixel = 4 }
	Type of data in the Column. More...

Public Member Functions
	Column ()
	Constructor.

	Column (QString name, int width, Column::Type type, Column::Align align=Right)
	Constructor with parameter.

void	SetName (QString name)
	Sets the Column name, or header.

void	SetWidth (unsigned int width)
	Sets the width of the Column, in text columns.

void	SetType (Column::Type type)
	Sets the data type of the Column.

void	SetAlignment (Column::Align alignment)
	Sets the alignment of the Column.

void	SetPrecision (unsigned int precision)
	Sets the precision of the Column, for real number values.

QString	Name () const
	Get the Column's name.

unsigned int	Width () const
	Get the Column's width.

Column::Type	DataType () const
	Returns the type of data this column will contain.

Column::Align	Alignment () const
	Get the Column's alignment.

unsigned int	Precision () const
	Get the Column's precision.

Private Attributes
QString	p_name
	Name of the Column.

unsigned int	p_width
	Width of the Column.

Column::Type	p_type
	Type of the data in the Column.

Column::Align	p_align
	Alignment of the data in the Column.

unsigned int	p_precision
	Precision of the data in the Column.

Detailed Description

Format ascii tables.

This class takes in a series of string vectors and writes them out to a file as a table. Formatting options are up to the user. This was developed for cubediff's table output option, and is being utilized by the WriteTabular class (which currently resides in the cubediff folder).

Author: 2007-05-01 Brendan George

History

2007-06-18 Brendan George Fixed error message outputs and unitTest

2009-10-14 Eric Hyer Added documentation; Moved from base/apps/cubediff to base/objs;

2012-09-20 Steven Lambright - Improved unit test, fixed bug where uninitialized member variables were causing errors to be thrown sometimes. Fixes #1125.

2017-08-30 Summer Stapleton - Updated documentation. References #4807.

Definition at line 39 of file Column.h.

Member Enumeration Documentation

◆ Align

enum Isis::Column::Align

Alignment of data in the Column.

Enumerator
NoAlign	no alignment
Right	right alignment
Left	left alignment
Decimal	decimal alignment

Definition at line 45 of file Column.h.

◆ Type

enum Isis::Column::Type

Type of data in the Column.

Enumerator
Integer	No data type.
Real	Integer data type.
String	Real data type.
Pixel	String data type.

Definition at line 55 of file Column.h.

Constructor & Destructor Documentation

◆ Column() [1/2]

Isis::Column::Column ( )

Constructor.

Sets the precision for decimal-aligned columns to 4

Definition at line 20 of file Column.cpp.

References NoAlign, p_align, p_name, p_precision, p_type, and p_width.

◆ Column() [2/2]

Isis::Column::Column	(	QString	name,
		int	width,
		Column::Type	type,
		Column::Align	align = Right )

Constructor with parameter.

Parameters

name	The name of the column, used as the header
width	The width (in characters) to make the column
type	The type of information the column is to represent
align	The alignment, within the column, the data is to conform to

Definition at line 36 of file Column.cpp.

References NoAlign, p_align, p_name, p_precision, p_type, p_width, SetAlignment(), SetName(), SetType(), and SetWidth().

Member Function Documentation

◆ Alignment()

Column::Align Isis::Column::Alignment ( ) const

Get the Column's alignment.

Returns: The column's alignment

Definition at line 162 of file Column.cpp.

References p_align.

◆ DataType()

Column::Type Isis::Column::DataType ( ) const

Returns the type of data this column will contain.

Returns: Column::Type The data type of this column

Definition at line 152 of file Column.cpp.

References p_type.

Referenced by SetPrecision().

◆ Name()

QString Isis::Column::Name ( ) const

Get the Column's name.

Returns: The column's name

Definition at line 133 of file Column.cpp.

References p_name.

◆ Precision()

unsigned int Isis::Column::Precision ( ) const

Get the Column's precision.

Returns: The column's presicion

Definition at line 172 of file Column.cpp.

References p_precision.

◆ SetAlignment()

void Isis::Column::SetAlignment ( Column::Align alignment )

Sets the alignment of the Column.

The text in the Column will be aligned according to this parameter, which is Right, Left, or, possible only with real-number values, aligned by the decimal point

Parameters

alignment The alignment of the text in the Column

Definition at line 101 of file Column.cpp.

References Decimal, Integer, p_align, p_type, Isis::IException::Programmer, and String.

Referenced by Column().

◆ SetName()

void Isis::Column::SetName ( QString name )

Sets the Column name, or header.

Parameters

name	The name of the Column

Definition at line 55 of file Column.cpp.

References p_name, p_width, and Isis::IException::User.

Referenced by Column().

◆ SetPrecision()

void Isis::Column::SetPrecision ( unsigned int precision )

Sets the precision of the Column, for real number values.

This sets the number of digits after the decimal point, for decimal aligned values. If the Column's alignment is anything else, an error is thrown.

Parameters

precision The number of digits after the decimal point to be shown

Definition at line 119 of file Column.cpp.

References DataType(), p_precision, Pixel, Real, and Isis::IException::User.

◆ SetType()

void Isis::Column::SetType ( Column::Type type )

Sets the data type of the Column.

Parameters

type	The data type for the Column

Definition at line 82 of file Column.cpp.

References Decimal, Integer, p_align, p_type, String, and Isis::IException::User.

Referenced by Column().

◆ SetWidth()

void Isis::Column::SetWidth ( unsigned int width )

Sets the width of the Column, in text columns.

Parameters

width The number of text columns the Column will hold

Definition at line 68 of file Column.cpp.

References p_name, p_width, and Isis::IException::User.

Referenced by Column().

◆ Width()

unsigned int Isis::Column::Width ( ) const

Get the Column's width.

Returns: The column's width

Definition at line 142 of file Column.cpp.

References p_width.

Member Data Documentation

◆ p_align

Column::Align Isis::Column::p_align

private

Alignment of the data in the Column.

Definition at line 89 of file Column.h.

Referenced by Alignment(), Column(), Column(), SetAlignment(), and SetType().

◆ p_name

QString Isis::Column::p_name

private

Name of the Column.

Definition at line 80 of file Column.h.

Referenced by Column(), Column(), Name(), SetName(), and SetWidth().

◆ p_precision

unsigned int Isis::Column::p_precision

private

Precision of the data in the Column.

Definition at line 92 of file Column.h.

Referenced by Column(), Column(), Precision(), and SetPrecision().

◆ p_type

Column::Type Isis::Column::p_type

private

Type of the data in the Column.

Definition at line 86 of file Column.h.

Referenced by Column(), Column(), DataType(), SetAlignment(), and SetType().

◆ p_width

unsigned int Isis::Column::p_width

private

Width of the Column.

Definition at line 83 of file Column.h.

Referenced by Column(), Column(), SetName(), SetWidth(), and Width().

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

src/base/objs/Column/Column.h
src/base/objs/Column/Column.cpp

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Align

◆ Type

Constructor & Destructor Documentation

◆ Column() [1/2]

◆ Column() [2/2]

Member Function Documentation

◆ Alignment()

◆ DataType()

◆ Name()

◆ Precision()

◆ SetAlignment()

◆ SetName()

◆ SetPrecision()

◆ SetType()

◆ SetWidth()

◆ Width()

Member Data Documentation

◆ p_align

◆ p_name

◆ p_precision

◆ p_type

◆ p_width