File: field_8h-source.html

package info (click to toggle)
mysql%2B%2B 3.0.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 10,328 kB
  • ctags: 9,487
  • sloc: cpp: 33,486; sh: 3,091; perl: 809; makefile: 683
file content (148 lines) | stat: -rw-r--r-- 15,176 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
	<title>MySQL++ Reference Manual</title>
	<meta http-equiv="Content-type" content="text/html;charset=iso-8859-1">
	<link href="doxygen.css" rel="stylesheet" type="text/css">
	<link href="refman.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="annotated.html"><span>Classes</span></a></li>
    <li id="current"><a href="files.html"><span>Files</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
  </ul></div>
<h1>field.h</h1><a href="field_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
<a name="l00002"></a>00002 
<a name="l00003"></a>00003 
<a name="l00004"></a>00004 <span class="comment">/***********************************************************************</span>
<a name="l00005"></a>00005 <span class="comment"> Copyright (c) 2007 by Educational Technology Resources, Inc.</span>
<a name="l00006"></a>00006 <span class="comment"> Others may also hold copyrights on code in this file.  See the</span>
<a name="l00007"></a>00007 <span class="comment"> CREDITS file in the top directory of the distribution for details.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This file is part of MySQL++.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment"> MySQL++ is free software; you can redistribute it and/or modify it</span>
<a name="l00012"></a>00012 <span class="comment"> under the terms of the GNU Lesser General Public License as published</span>
<a name="l00013"></a>00013 <span class="comment"> by the Free Software Foundation; either version 2.1 of the License, or</span>
<a name="l00014"></a>00014 <span class="comment"> (at your option) any later version.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> MySQL++ is distributed in the hope that it will be useful, but WITHOUT</span>
<a name="l00017"></a>00017 <span class="comment"> ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span>
<a name="l00018"></a>00018 <span class="comment"> FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public</span>
<a name="l00019"></a>00019 <span class="comment"> License for more details.</span>
<a name="l00020"></a>00020 <span class="comment"></span>
<a name="l00021"></a>00021 <span class="comment"> You should have received a copy of the GNU Lesser General Public</span>
<a name="l00022"></a>00022 <span class="comment"> License along with MySQL++; if not, write to the Free Software</span>
<a name="l00023"></a>00023 <span class="comment"> Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301</span>
<a name="l00024"></a>00024 <span class="comment"> USA</span>
<a name="l00025"></a>00025 <span class="comment">***********************************************************************/</span>
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="preprocessor">#if !defined(MYSQLPP_FIELD_H)</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#define MYSQLPP_FIELD_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="common_8h.html">common.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="type__info_8h.html">type_info.h</a>"</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00034"></a>00034 
<a name="l00035"></a>00035 <span class="keyword">namespace </span>mysqlpp {
<a name="l00036"></a>00036 
<a name="l00045"></a>00045 
<a name="l00046"></a><a class="code" href="classmysqlpp_1_1Field.html">00046</a> <span class="keyword">class </span><a class="code" href="classmysqlpp_1_1Field.html">Field</a>
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 <span class="keyword">public</span>:
<a name="l00050"></a><a class="code" href="classmysqlpp_1_1Field.html#f93a6fa53e488b3566bcb1ea4908e996">00050</a>         <a class="code" href="classmysqlpp_1_1Field.html#f93a6fa53e488b3566bcb1ea4908e996">Field</a>() :
<a name="l00051"></a>00051         length_(0),
<a name="l00052"></a>00052         max_length_(0),
<a name="l00053"></a>00053         flags_(0)
<a name="l00054"></a>00054         {
<a name="l00055"></a>00055         }
<a name="l00056"></a>00056 
<a name="l00058"></a><a class="code" href="classmysqlpp_1_1Field.html#887e4566a1266e5c98be8d86eedbd548">00058</a>         <a class="code" href="classmysqlpp_1_1Field.html#f93a6fa53e488b3566bcb1ea4908e996">Field</a>(<span class="keyword">const</span> MYSQL_FIELD* pf) :
<a name="l00059"></a>00059         name_(pf-&gt;<a class="code" href="classmysqlpp_1_1Field.html#1ee7be4fb4104d669725f91c166bb50e">name</a>),
<a name="l00060"></a>00060         table_(pf-&gt;<a class="code" href="classmysqlpp_1_1Field.html#aaa8afad2e6ac3703e639843d97722db">table</a>),
<a name="l00061"></a>00061         db_(pf-&gt;<a class="code" href="classmysqlpp_1_1Field.html#d8c7716647ec0ecc16c500696a3afb1f">db</a>),
<a name="l00062"></a>00062         type_(pf-&gt;<a class="code" href="classmysqlpp_1_1Field.html#3b8594efb4685be1b0ffa34418a04c2f">type</a>, (pf-&gt;flags &amp; UNSIGNED_FLAG) != 0,
<a name="l00063"></a>00063                         (pf-&gt;flags &amp; NOT_NULL_FLAG) == 0),
<a name="l00064"></a>00064         length_(pf-&gt;<a class="code" href="classmysqlpp_1_1Field.html#2b497665a0a1cc09855562ad9ef6871d">length</a>),
<a name="l00065"></a>00065         max_length_(pf-&gt;<a class="code" href="classmysqlpp_1_1Field.html#b72f6da6cd4a512f1d6a35a435a63ed8">max_length</a>),
<a name="l00066"></a>00066         flags_(pf-&gt;flags)
<a name="l00067"></a>00067         {
<a name="l00068"></a>00068         }
<a name="l00069"></a>00069 
<a name="l00071"></a><a class="code" href="classmysqlpp_1_1Field.html#6833175bda71e745b6b83df585030154">00071</a>         <a class="code" href="classmysqlpp_1_1Field.html#f93a6fa53e488b3566bcb1ea4908e996">Field</a>(<span class="keyword">const</span> <a class="code" href="classmysqlpp_1_1Field.html">Field</a>&amp; other) :
<a name="l00072"></a>00072         name_(other.name_),
<a name="l00073"></a>00073         table_(other.table_),
<a name="l00074"></a>00074         db_(other.db_),
<a name="l00075"></a>00075         type_(other.type_),
<a name="l00076"></a>00076         length_(other.length_),
<a name="l00077"></a>00077         max_length_(other.max_length_),
<a name="l00078"></a>00078         flags_(other.flags_)
<a name="l00079"></a>00079         {
<a name="l00080"></a>00080         }
<a name="l00081"></a>00081 
<a name="l00083"></a><a class="code" href="classmysqlpp_1_1Field.html#bfae5bd1d80c8c2df3f3a198f586cb9a">00083</a>         <span class="keywordtype">bool</span> <a class="code" href="classmysqlpp_1_1Field.html#bfae5bd1d80c8c2df3f3a198f586cb9a">auto_increment</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> flags_ &amp; AUTO_INCREMENT_FLAG; }
<a name="l00084"></a>00084 
<a name="l00086"></a><a class="code" href="classmysqlpp_1_1Field.html#adcd521da1c6abf551297285d9066c59">00086</a>         <span class="keywordtype">bool</span> <a class="code" href="classmysqlpp_1_1Field.html#adcd521da1c6abf551297285d9066c59">binary_type</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> flags_ &amp; BINARY_FLAG; }
<a name="l00087"></a>00087 
<a name="l00089"></a><a class="code" href="classmysqlpp_1_1Field.html#42f2d14810c1c89ae6a0b9a4392641eb">00089</a>         <span class="keywordtype">bool</span> <a class="code" href="classmysqlpp_1_1Field.html#42f2d14810c1c89ae6a0b9a4392641eb">blob_type</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> flags_ &amp; BLOB_FLAG; }
<a name="l00090"></a>00090 
<a name="l00092"></a><a class="code" href="classmysqlpp_1_1Field.html#d8c7716647ec0ecc16c500696a3afb1f">00092</a>         <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classmysqlpp_1_1Field.html#d8c7716647ec0ecc16c500696a3afb1f">db</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> db_.c_str(); }
<a name="l00093"></a>00093 
<a name="l00095"></a><a class="code" href="classmysqlpp_1_1Field.html#e5278a6cb1d754ec506c2ad2421451fd">00095</a>         <span class="keywordtype">bool</span> <a class="code" href="classmysqlpp_1_1Field.html#e5278a6cb1d754ec506c2ad2421451fd">enumeration</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> flags_ &amp; ENUM_FLAG; }
<a name="l00096"></a>00096 
<a name="l00101"></a><a class="code" href="classmysqlpp_1_1Field.html#2b497665a0a1cc09855562ad9ef6871d">00101</a>         size_t <a class="code" href="classmysqlpp_1_1Field.html#2b497665a0a1cc09855562ad9ef6871d">length</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> length_; }
<a name="l00102"></a>00102 
<a name="l00105"></a><a class="code" href="classmysqlpp_1_1Field.html#b72f6da6cd4a512f1d6a35a435a63ed8">00105</a>         size_t <a class="code" href="classmysqlpp_1_1Field.html#b72f6da6cd4a512f1d6a35a435a63ed8">max_length</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> max_length_; }
<a name="l00106"></a>00106 
<a name="l00108"></a><a class="code" href="classmysqlpp_1_1Field.html#a1d17ae8726ddf34c1066437198f3fee">00108</a>         <span class="keywordtype">bool</span> <a class="code" href="classmysqlpp_1_1Field.html#a1d17ae8726ddf34c1066437198f3fee">multiple_key</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> flags_ &amp; MULTIPLE_KEY_FLAG; }
<a name="l00109"></a>00109 
<a name="l00111"></a><a class="code" href="classmysqlpp_1_1Field.html#1ee7be4fb4104d669725f91c166bb50e">00111</a>         <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classmysqlpp_1_1Field.html#1ee7be4fb4104d669725f91c166bb50e">name</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> name_.c_str(); }
<a name="l00112"></a>00112 
<a name="l00113"></a>00113 <span class="preprocessor">#if defined(NO_DEFAULT_VALUE_FLAG)</span>
<a name="l00115"></a>00115 <span class="preprocessor">        bool no_default() const { return flags_ &amp; NO_DEFAULT_VALUE_FLAG; }</span>
<a name="l00116"></a>00116 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00117"></a>00117 <span class="preprocessor"></span>
<a name="l00119"></a><a class="code" href="classmysqlpp_1_1Field.html#d5ec7d6cb28141c547610100b8225327">00119</a>         <span class="keywordtype">bool</span> <a class="code" href="classmysqlpp_1_1Field.html#d5ec7d6cb28141c547610100b8225327">primary_key</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> flags_ &amp; PRI_KEY_FLAG; }
<a name="l00120"></a>00120 
<a name="l00122"></a><a class="code" href="classmysqlpp_1_1Field.html#d4417c65532ff5d2d8cb9ec4d2706fcc">00122</a>         <span class="keywordtype">bool</span> <a class="code" href="classmysqlpp_1_1Field.html#d4417c65532ff5d2d8cb9ec4d2706fcc">set_type</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> flags_ &amp; SET_FLAG; }
<a name="l00123"></a>00123 
<a name="l00125"></a><a class="code" href="classmysqlpp_1_1Field.html#aaa8afad2e6ac3703e639843d97722db">00125</a>         <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classmysqlpp_1_1Field.html#aaa8afad2e6ac3703e639843d97722db">table</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> table_.c_str(); }
<a name="l00126"></a>00126 
<a name="l00128"></a><a class="code" href="classmysqlpp_1_1Field.html#b89c227addf1acb01040de46fc021c9a">00128</a>         <span class="keywordtype">bool</span> <a class="code" href="classmysqlpp_1_1Field.html#b89c227addf1acb01040de46fc021c9a">timestamp</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> flags_ &amp; TIMESTAMP_FLAG; }
<a name="l00129"></a>00129 
<a name="l00131"></a><a class="code" href="classmysqlpp_1_1Field.html#3b8594efb4685be1b0ffa34418a04c2f">00131</a>         <span class="keyword">const</span> <a class="code" href="classmysqlpp_1_1mysql__type__info.html">mysql_type_info</a>&amp; <a class="code" href="classmysqlpp_1_1Field.html#3b8594efb4685be1b0ffa34418a04c2f">type</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> type_; }
<a name="l00132"></a>00132 
<a name="l00134"></a><a class="code" href="classmysqlpp_1_1Field.html#6ebf1823c21d3601b7674c865e27ad0d">00134</a>         <span class="keywordtype">bool</span> <a class="code" href="classmysqlpp_1_1Field.html#6ebf1823c21d3601b7674c865e27ad0d">unique_key</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> flags_ &amp; UNIQUE_KEY_FLAG; }
<a name="l00135"></a>00135 
<a name="l00137"></a><a class="code" href="classmysqlpp_1_1Field.html#31dee697f7bd816e17ea89ad34151fba">00137</a>         <span class="keywordtype">bool</span> <a class="code" href="classmysqlpp_1_1Field.html#31dee697f7bd816e17ea89ad34151fba">zerofill</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> flags_ &amp; ZEROFILL_FLAG; }
<a name="l00138"></a>00138 
<a name="l00139"></a>00139 <span class="keyword">private</span>:
<a name="l00140"></a>00140         std::string name_;              
<a name="l00141"></a>00141         std::string table_;             
<a name="l00142"></a>00142         std::string db_;                
<a name="l00143"></a>00143         <a class="code" href="classmysqlpp_1_1mysql__type__info.html">mysql_type_info</a> type_;  
<a name="l00144"></a>00144         size_t length_;                 
<a name="l00145"></a>00145         size_t max_length_;             
<a name="l00146"></a>00146         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags_;    
<a name="l00147"></a>00147 };
<a name="l00148"></a>00148 
<a name="l00149"></a>00149 
<a name="l00151"></a>00151 <span class="keyword">typedef</span> std::vector&lt;Field&gt; Fields;
<a name="l00152"></a>00152 
<a name="l00153"></a>00153 } <span class="comment">// end namespace mysqlpp</span>
<a name="l00154"></a>00154 
<a name="l00155"></a>00155 <span class="preprocessor">#endif // !defined(MYSQLPP_FIELD_H)</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri Feb 29 16:26:00 2008 for MySQL++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>