HiCalTypes.h

Go to the documentation of this file.

#if !defined(HiCalTypes_h)
#define HiCalTypes_h
/**                                                                       
 * @file                                                                  
 * $Revision: 3878 $
 * $Date: 2012-01-18 10:23:13 -0700 (Wed, 18 Jan 2012) $
 *                                                                        
 *   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 <string>
#include <vector>
#include <iostream>
#include <sstream>

#include "tnt_array1d.h"
#include "tnt_array1d_utils.h"
#include "tnt_array2d.h"
#include "tnt_array2d_utils.h"
#include "PvlKeyword.h"

namespace Isis {

typedef TNT::Array1D<double> HiVector;       //!<  1-D Buffer
typedef TNT::Array2D<double> HiMatrix;       //!<  2-D buffer

/**
 * @author ????-??-?? Unknown
 *
 * @internal
 */
class HiHistory {
  public:
    /**
     * @brief Output operator for history events
     * @param o Output stream
     * @param h History class to write contents of
     * 
     * @return std::ostream& Returns new state of stream
     */
    friend std::ostream &operator<<(std::ostream &o, const HiHistory &h) {
      std::copy(h._events.begin(), h._events.end(), 
                std::ostream_iterator<std::string>(o,"; "));
      return (o);
    }

  public:
    HiHistory() { }
    HiHistory(const HiHistory &h) : _events(h._events) { }
    virtual ~HiHistory() { }

    inline int size() const { return (_events.size()); }
    void add(const std::string &event) { _events.push_back(event); }
    std::string get(unsigned int index = 0) const { 
      if (index < _events.size()) { 
        return (_events[index]);
      }
      else {
        return (std::string(""));
      }
    }

    void clear() { _events.clear(); }

    PvlKeyword makekey(const std::string &name = "History") const {
      PvlKeyword key(name);
      for (unsigned int i = 0 ; i < _events.size() ; i++) {
        key.AddValue(_events[i]);
      }
      return (key); 
    }

  private:
    std::vector<std::string> _events;
};

};
#endif