feature.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: feature.hpp,v $
 * PRODUCTION Revision 1000.0  2003/10/29 20:26:45  gouriano
 * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.3
 * PRODUCTION
 * ===========================================================================
 */

#ifndef FEAT__HPP
#define FEAT__HPP

/*  $Id: feature.hpp,v 1000.0 2003/10/29 20:26:45 gouriano Exp $
* ===========================================================================
*
*                            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.
*
* ===========================================================================
*
* Author:  Clifford Clausen
*
* File Description:
*   Feature utilities
*/

#include <corelib/ncbistd.hpp>


BEGIN_NCBI_SCOPE
BEGIN_SCOPE(objects)

// Forward declarations
class CSeq_feat;
class CScope;

BEGIN_SCOPE(feature)

enum ELabelType {
    eType,
    eContent,
    eBoth
};


// Returns a label for a CSeq_feat. Label may be based on just the type of 
// feature, just the content of the feature, or both. If scope is 0, then the
// label will not include information from feature products.
NCBI_XOBJUTIL_EXPORT
void GetLabel (const CSeq_feat&    feat, 
               string*             label, 
               feature::ELabelType label_type,
               CScope*             scope = 0);


END_SCOPE(feature)
END_SCOPE(objects)
END_NCBI_SCOPE

/*
* ===========================================================================
* $Log: feature.hpp,v $
* Revision 1000.0  2003/10/29 20:26:45  gouriano
* PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.3
*
* Revision 1.3  2002/12/26 19:45:50  dicuccio
* Added export specifier for feature::GetLabel()
*
* Revision 1.2  2002/06/07 16:09:52  ucko
* Move everything into the "feature" namespace.
*
* Revision 1.1  2002/06/06 18:46:38  clausen
* Initial version
*
* ===========================================================================
*/

#endif  /* FEAT__HPP */