Isis 3.0 Application Source Code Reference

Home

---

Column.cpp

Go to the documentation of this file.

/**
 * @file
 * $Revision: 1.1 $
 * $Date: 2007/08/09 18:24:24 $
 *
 *   Unless noted otherwise, the portions of Isis written by the USGS are public
 *   domain. See individual third-party library and package descriptions for
 *   intellectual property information,user agreements, and related information.
 *
 *   Although Isis has been used by the USGS, no warranty, expressed or implied,
 *   is made by the USGS as to the accuracy and functioning of such software
 *   and related material nor shall the fact of distribution constitute any such
 *   warranty, and no responsibility is assumed by the USGS in connection
 *   therewith.
 *
 *   For additional information, launch
 *   $ISISROOT/doc//documents/Disclaimers/Disclaimers.html in a browser or see
 *   the Privacy & Disclaimers page on the Isis website,
 *   http://isis.astrogeology.usgs.gov, and the USGS privacy and disclaimers on
 *   http://www.usgs.gov/privacy.html.
 */
#include <vector>
#include <string>
#include <iostream>

#include "Column.h"
#include "iException.h"

namespace Isis{

  /**
   * Constructor. Sets the precision for decimal-aligned columns to 4
   */
  Column::Column(){
    p_precision = 4;
    p_width = 0;
    p_name = "";
    SetAlignment(Column::NoAlign);
    SetType(Column::NoType);
  }

  /**
   * Constructor with parameter
   * 
   * @param name The name of the column, used as the header
   * @param width The width (in characters) to make the column
   * @param type The type of information the column is to represent
   * @param align The alignment, within the column, the data is to conform to
   */
  Column::Column( std::string name, int width, Column::Type type, Column::Align align) {
    //Set the parameters with function calls, to make use of pre-existing error checks
    SetWidth(width);
    SetName(name);
    SetType(type);
    SetAlignment(align);

    p_precision = 4;
  }

  /**
   * Sets the Column name, or header
   * 
   * @param name The name of the Column
   */
  void Column::SetName (std::string name) {
    if (p_width != 0 && name.length() > p_width) {
      std::string message = "Name[" + name + "] is wider than width";
      throw iException::Message(iException::User,message,_FILEINFO_);
    }
    p_name = name;
  }

  /**
   * Sets the width of the Column, in text columns
   * 
   * @param width The number of text columns the Column will hold
   */
  void Column::SetWidth (unsigned int width) {
    if (p_name.size() > 0 && p_name.size() > width) {
      std::string message = "Width is insufficient to contain name[";
      message += p_name + "]";
      throw iException::Message(iException::User,message,_FILEINFO_);
    }
    p_width = width;
  }

  /**
   * Sets the data type of the Column
   * 
   * @param type The data type for the Column
   */
  void Column::SetType (Column::Type type) {
    if (p_align == Column::Decimal && 
        (type == Column::Integer || type == Column::String)) {
        std::string message = "Integer or string type is not sensible if ";
        message += "alignment is Decimal.";
        throw iException::Message(iException::User,message,_FILEINFO_);
    }
    p_type = type;
  }

  /**
   * 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
   * 
   * @param alignment The alignment of the text in the Column
   */
  void Column::SetAlignment (Column::Align alignment) {
    if (alignment == Column::Decimal && 
        (p_type == Column::Integer || p_type == Column::String)) {
        std::string message = "Decimal alignment does not make sense for ";
        message += "integer or string values.";
        throw iException::Message(iException::Programmer,message,_FILEINFO_);
    }
    p_align = alignment;
  }

  /**
   * 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.
   * 
   * @param precision The number of digits after the decimal point to be shown
   */
  void Column::SetPrecision(unsigned int precision) {
    if (DataType() != Column::Real &&
        DataType() != Column::Pixel) {
      std::string message = "Setting precision only makes sense for Decimal Alignment";
      throw iException::Message(iException::User,message,_FILEINFO_);
    }
    p_precision = precision;
  }

  /**
   * Returns the type of data this column will contain
   * 
   * @return Column::Type The data type of this column
   */
  Column::Type Column::DataType() {

    if (p_type == 0) {
      std::string message = "Type has not been set yet!";
      throw iException::Message(iException::User,message,_FILEINFO_);
    }

    return p_type;
  }
}