aln_scanner.hpp

Go to the documentation of this file.

Go to the SVN repository for this file.

#ifndef _ALN_SCANNER_HPP_
#define _ALN_SCANNER_HPP_
 
/*
 * $Id: aln_scanner.hpp 86227 2019-04-19 17:18:39Z foleyjp $
 *
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Authors: Frank Ludwig
 *
 */
#include <corelib/ncbistd.hpp>
 
BEGIN_NCBI_SCOPE
BEGIN_SCOPE(objects);
 
class CLineInput;
class CSequenceInfo;
struct SAlignFileRaw;
 
//  ============================================================================
class CAlnScanner
    //  ============================================================================
{
protected:
    using TLineInfo = SLineInfo;
 
public:
    using TDeflines = vector<TLineInfo>;
 
    CAlnScanner() {};
 
    virtual ~CAlnScanner() {};
 
    virtual void
    ProcessAlignmentFile(
        CSequenceInfo&,
        CLineInput&,
        SAlignmentFile&);
 
protected:
 
    enum class ESeqIdComparison {
        eIdentical,
        eDifferByCase,
        eDifferentChars,
        eDifferent
    };
 
    virtual void
    xImportAlignmentData(
        CSequenceInfo&,
        CLineInput&);
 
    virtual void
    xAdjustSequenceInfo(
        CSequenceInfo&);
 
    virtual void
    xVerifyAlignmentData(
        const CSequenceInfo&);
 
    virtual void
    xExportAlignmentData(
        SAlignmentFile& alignmentInfo);
 
    virtual void
    xVerifySingleSequenceData(
        const CSequenceInfo&,
        const TLineInfo& seqId,
        const vector<TLineInfo> seqData);
 
    ESeqIdComparison
    xGetExistingSeqIdInfo(
        const string& seqId,
        TLineInfo& existingInfo);
 
    bool
    xSeqIdIsEqualToInfoAt(
        const string& seqId,
        int index);
 
    vector<TLineInfo> mSeqIds;
    vector<vector<TLineInfo>> mSequences;
    vector<TLineInfo> mDeflines;
};
 
END_SCOPE(objects)
END_NCBI_SCOPE
 
#endif // _ALN_SCANNER_HPP_