libStatGen Software  1
SamHeaderTag.h
1 /*
2  * Copyright (C) 2010 Regents of the University of Michigan
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef __SAMHEADER_TAG_H__
19 #define __SAMHEADER_TAG_H__
20 
21 #include <string>
22 
24 {
25 public:
26  SamHeaderTag(const char* tag, const char* value);
27  SamHeaderTag(const SamHeaderTag&);
28 
29  ~SamHeaderTag();
30 
31  // Add this tag to the passed in tag string.
32  // If the tag value is blank, the tag will not be added to the
33  // passed in string.
34  // NOTE: does not clear tagString.
35  bool getTagString(std::string& tagString);
36 
37  // Set this tag to the passed in tag and value.
38  bool setTag(const char* tag, const char* value);
39 
40  // Set the value associated with this tag to the passed in value.
41  bool setValue(const char* value);
42 
43  // Return the tag for this tag.
44  const char* getTag();
45 
46  // Return the value associated with this tag.
47  const char* getValue();
48 
49  // Return true if there is a non-blank value associated with this tag.
50  bool hasValue();
51 
52 private:
53  SamHeaderTag();
54  SamHeaderTag& operator=(const SamHeaderTag&);
55 
56  std::string myTag;
57  std::string myValue;
58 };
59 
60 #endif
SamHeaderTag
Definition: SamHeaderTag.h:23