]> git.donarmstrong.com Git - bamtools.git/blobdiff - src/api/SamSequence.h
Cleaned up intra-API includes & moved version numbers to 2.0.0
[bamtools.git] / src / api / SamSequence.h
index 054e58f985ec40c74820f37a8318157202dfd2ed..c1a8792065df16bdd1a10ba46f90b540ba7b6c95 100644 (file)
@@ -1,9 +1,8 @@
 // ***************************************************************************
 // SamSequence.h (c) 2010 Derek Barnett
 // Marth Lab, Department of Biology, Boston College
-// All rights reserved.
 // ---------------------------------------------------------------------------
-// Last modified: 18 April 2011 (DB)
+// Last modified: 10 October 2011 (DB)
 // ---------------------------------------------------------------------------
 // Provides direct read/write access to the SAM sequence data fields.
 // ***************************************************************************
@@ -11,7 +10,7 @@
 #ifndef SAM_SEQUENCE_H
 #define SAM_SEQUENCE_H
 
-#include <api/api_global.h>
+#include "api/api_global.h"
 #include <string>
 
 namespace BamTools {
@@ -26,23 +25,23 @@ struct API_EXPORT SamSequence {
     ~SamSequence(void);
 
     // query/modify entire sequence
-    void Clear(void);                   // clears all contents
+    void Clear(void);                // clears all contents
 
     // convenience query methods
-    bool HasAssemblyID(void) const;     // returns true if sequence has an assembly ID
-    bool HasChecksum(void) const;       // returns true if sequence has an MD5 checksum
-    bool HasLength(void) const;         // returns true if sequence has a length
-    bool HasName(void) const;           // returns true if sequence has a name
-    bool HasSpecies(void) const;        // returns true if sequence has a species ID
-    bool HasURI(void) const;            // returns true if sequence has a URI
+    bool HasAssemblyID(void) const;  // returns true if sequence has an assembly ID
+    bool HasChecksum(void) const;    // returns true if sequence has an MD5 checksum
+    bool HasLength(void) const;      // returns true if sequence has a length
+    bool HasName(void) const;        // returns true if sequence has a name
+    bool HasSpecies(void) const;     // returns true if sequence has a species ID
+    bool HasURI(void) const;         // returns true if sequence has a URI
 
     // data members
-    std::string AssemblyID;             // AS:<AssemblyID>
-    std::string Checksum;               // M5:<Checksum>
-    std::string Length;                 // LN:<Length>      *Required for valid SAM header*
-    std::string Name;                   // SN:<Name>        *Required for valid SAM header*
-    std::string Species;                // SP:<Species>
-    std::string URI;                    // UR:<URI>
+    std::string AssemblyID;          // AS:<AssemblyID>
+    std::string Checksum;            // M5:<Checksum>
+    std::string Length;              // LN:<Length>      *Required for valid SAM header*
+    std::string Name;                // SN:<Name>        *Required for valid SAM header*
+    std::string Species;             // SP:<Species>
+    std::string URI;                 // UR:<URI>
 };
 
 /*! \fn bool operator==(const SamSequence& lhs, const SamSequence& rhs)