pdb_remarks.hpp

/*
  This file is part of LOOS.
 
  LOOS (Lightweight Object-Oriented Structure library)
  Copyright (c) 2008, Tod D. Romo, Alan Grossfield
  Department of Biochemistry and Biophysics
  School of Medicine & Dentistry, University of Rochester
 
  This package (LOOS) is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation under version 3 of the License.
 
  This package is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
 
 
 
#if !defined(LOOS_PDB_REMARKS_HPP)
#define LOOS_PDB_REMARKS_HPP
 
 
#include <iostream>
#include <string>
#include <stdexcept>
#include <vector>
 
namespace loos {
 
 
  class Remarks {
  public:
    int numberOf(void) const;
    int size(void) const;
    std::string get(const int i) const;
    void add(const std::string s);
    void add(const std::vector<std::string>& s);
    void erase(const int i);
 
#if !defined(SWIG)
    std::string& operator[](const int i);
    const std::string& operator[](const int i) const;
 
    friend std::ostream& operator<<(std::ostream& os, const Remarks& r);
#endif // !defined(SWIG)
 
    std::vector<std::string> allRemarks(void) const { return(remarks); }
 
 
  private:
    void rangeCheck(const unsigned int i) const;
    std::string sanitize(const std::string s) const;
 
  private:
    std::vector<std::string> remarks;
  };
 
 
}
 
#endif