main page namespaces classes files
BIU home

src/biu/LatticeModel.hh

Go to the documentation of this file.

#ifndef LATTICEMODEL_H_
#define LATTICEMODEL_H_


#include "Point.hh"
#include "BioMolecule.hh"
#include "LatticeDescriptor.hh"
#include <set>

namespace biu
{
    

    class LatticeModel
    {
    protected:
        LatticeDescriptor const* const latDescriptor;
        
        const LatticeNeighborhood & latNeighborhood;
        
    public:
        LatticeModel(const LatticeDescriptor* const _latDescriptor); 
        
        LatticeModel(const LatticeModel& toCopy);
        virtual ~LatticeModel();
        
        LatticeDescriptor const* const getDescriptor() const {
            return latDescriptor;
        }
        
        const LatticeNeighborhood & getNeighborhood() const {
            return latNeighborhood;
        }
        
        
        bool operator == (const LatticeModel& lm2) const;
        bool operator != (const LatticeModel& lm2) const;
        
        
        // conversion of move sequences
        
        MoveSequence relMovesToAbsMoves( const MoveSequence &relMoves ) const;
        
        MoveSequence absMovesToRelMoves( const MoveSequence &absMoves ) const;
        
        // conversion moves <=> coordinates
            
        virtual Move getAbsMove(    const IntPoint& lastPoint, 
                                    const IntPoint& actPoint ) const;

        virtual MoveSequence pointsToAbsMoves( const IPointVec& points ) const;

        virtual MoveSequence parseMoveString( const std::string& moveStr) const;

        virtual MoveSequence pointsToRelMoves( const IPointVec& points) const;

        virtual IntPoint applyAbsMove(  const IntPoint& actPoint, 
                                        const Move& absMove ) const;

        virtual IPointVec absMovesToPoints( const MoveSequence& absMoves) const;

        virtual IPointVec relMovesToPoints( const MoveSequence& relMoves) const;

        virtual IPointVec& relMovesToPoints( const MoveSequence& relMoves, 
            IPointVec& toFill) const;
             
        virtual std::string getString( const MoveSequence& moveSeq ) const;
        
        // nachbarschaft im gitter
        
        virtual IPointSet   getAllNeighPoints( const IntPoint& center ) const;

        virtual bool areNeighbored( const IntPoint &first, 
                                    const IntPoint &second ) const;
        
    
    };

} // namespace biu


#include "LatticeModel.icc"

#endif /*LATTICEMODEL_H_*/