SequenceContainer.h

Go to the documentation of this file.

//
// File: SequenceContainer.h
// Created by: Guillaume Deuchst
//             Julien Dutheil
// Created on: Fri Jul 25 2003
//

/*
Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)

This software is a computer program whose purpose is to provide classes
for sequences analysis.

This software is governed by the CeCILL  license under French law and
abiding by the rules of distribution of free software.  You can  use, 
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info". 

As a counterpart to the access to the source code and  rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty  and the software's author,  the holder of the
economic rights,  and the successive licensors  have only  limited
liability. 

In this respect, the user's attention is drawn to the risks associated
with loading,  using,  modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean  that it is complicated to manipulate,  and  that  also
therefore means  that it is reserved for developers  and  experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or 
data to be ensured and,  more generally, to use and operate it in the 
same conditions as regards security. 

The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/

#ifndef _SEQUENCECONTAINER_H_
#define _SEQUENCECONTAINER_H_

#include "../Alphabet/Alphabet.h"
#include "../Sequence.h"
#include "SequenceContainerExceptions.h"
#include <Bpp/Clonable.h>

// From the STL:
#include <string>

namespace bpp
{

class SequenceContainer:
  public virtual Clonable
{
  public:
    SequenceContainer() {}
    virtual ~SequenceContainer() {}

  public:
    virtual const Alphabet* getAlphabet() const = 0;
    
    virtual const std::vector<int>& getContent(const std::string& name) const throw (SequenceNotFoundException) = 0;  
    
    virtual std::string toString(const std::string& name) const throw (SequenceNotFoundException) = 0;  

    virtual const Sequence& getSequence(const std::string& name) const throw (SequenceNotFoundException) = 0;

    virtual bool hasSequence(const std::string& name) const = 0;

    virtual void addSequence(const Sequence& sequence, bool checkName) throw (Exception) = 0;

    virtual void setSequence(const std::string& name, const Sequence& sequence, bool checkName) throw (Exception) = 0;

    virtual Sequence* removeSequence(const std::string& name) throw (SequenceNotFoundException, Exception) = 0;
    
    virtual void deleteSequence(const std::string& name) throw (SequenceNotFoundException, Exception) = 0;

    virtual size_t getNumberOfSequences() const = 0;

    virtual std::vector<std::string> getSequencesNames() const = 0;
    
    virtual void setSequencesNames(const std::vector<std::string>& names, bool checkNames) throw (Exception) = 0;

    virtual const Comments& getComments(const std::string& name) const throw (SequenceNotFoundException) = 0;
    
    virtual void setComments(const std::string& name, const Comments& comments) throw (SequenceNotFoundException) = 0;
    
    virtual const Comments& getGeneralComments() const = 0;

    virtual void setGeneralComments(const Comments& comments) = 0;
    
    virtual void deleteGeneralComments() = 0;

    virtual void clear() = 0;

    virtual SequenceContainer* createEmptyContainer() const = 0;

    virtual int& valueAt(const std::string& sequenceName, size_t elementIndex) throw (SequenceNotFoundException, IndexOutOfBoundsException) = 0;

    virtual const int& valueAt(const std::string& sequenceName, size_t elementIndex) const throw (SequenceNotFoundException, IndexOutOfBoundsException) = 0;

    virtual int& operator()(const std::string& sequenceName, size_t elementIndex) = 0;

    virtual const int& operator()(const std::string& sequenceName, size_t elementIndex) const = 0;
};

} //end of namespace bpp.

#endif  // _SEQUENCECONTAINER_H_