source: branches/asap-3.x/src/STHistory.h@ 2412

//
// C++ Interface: STHistory
//
// Description:
//
//
// Author: Malte Marquarding <asap@atnf.csiro.au>, (C) 2006
//
// Copyright: See COPYING file that comes with this distribution
//
//
#ifndef ASAPSTHISTORY_H
#define ASAPSTHISTORY_H

#include <casa/aips.h>
#include <casa/BasicSL/String.h>
#include <tables/Tables/Table.h>
#include <tables/Tables/ScalarColumn.h>

#include "STSubTable.h"

namespace asap {

/**
The History subtable of the Scantable

@author Malte Marquarding
*/
class STHistory : public STSubTable {
public:
  STHistory() {;}
  explicit STHistory(casa::Table tab);
  explicit STHistory( const Scantable& parent );

  virtual ~STHistory();

  STHistory& operator=(const STHistory& other);

  /**
   * add another row to this table
   * @param item the histor string
   * @return an ID (irrelevant)
   */
  casa::uInt addEntry( const casa::String& item);

  /**
   * Just for consistency sake, doesn't do anything
   * as IDs are irrelevant in this class
   * @param  item a string
   * @param id an uInt ID
   */
  void getEntry( casa::String& item, casa::uInt id);

  /**
   * add all rows from another STHistory table
   * @param other a STHistory reference
   */
  void append(const STHistory& other);

  /**
   * Get all rows in the table as a vector
   * @return a vector of strings
   */
  std::vector<std::string> getHistory( ) const;

  const casa::String& name() const { return name_; }

private:
  void setup();
  static const casa::String name_;
  casa::ScalarColumn<casa::String> itemCol_;
};

}

#endif