/sqlite3cc

To get this branch, use:
bzr branch http://bzr.ed.am/sqlite3cc

« back to all changes in this revision

Viewing changes to include/sqlite3cc/row.h

  • Committer: edam
  • Date: 2012-01-23 14:27:08 UTC
  • Revision ID: edam@waxworlds.org-20120123142708-w12277ptwtlspa6f
updated email and web addresses

Show diffs side-by-side

added added

removed removed

include/sqlite3cc/row.h
1
1
/*
2
2
 * row.h
3
3
 *
4
 
 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
 
4
 * Copyright (C) 2009 Tim Marston <tim@ed.am>
5
5
 *
6
6
 * This file is part of sqlite3cc (hereafter referred to as "this program").
7
 
 * See http://www.waxworlds.org/edam/software/sqlite3cc for more information.
8
 
 *
9
 
 * This program is free software: you can redistribute it and/or modify
10
 
 * it under the terms of the GNU Lesser General Public License as published
11
 
 * by the Free Software Foundation, either version 3 of the License, or
12
 
 * (at your option) any later version.
13
 
 *
14
 
 * This program is distributed in the hope that it will be useful,
15
 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
 
 * GNU Lesser General Public License for more details.
 
7
 * See http://ed.am/dev/sqlite3cc for more information.
 
8
 *
 
9
 * This program is free software: you can redistribute it and/or modify it under
 
10
 * the terms of the GNU Lesser General Public License as published by the Free
 
11
 * Software Foundation, either version 3 of the License, or (at your option) any
 
12
 * later version.
 
13
 *
 
14
 * This program is distributed in the hope that it will be useful, but WITHOUT
 
15
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 
16
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 
17
 * details.
18
18
 *
19
19
 * You should have received a copy of the GNU Lesser General Public License
20
20
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
47
47
 * A result row from a query.
48
48
 *
49
49
 * The row is only valid until the next call to step() or reset() on the parent
50
 
 * query object, or until the parent query object is destructed. This may change
51
 
 * in future versions.
 
50
 * query object, or until the parent query object is destructed.  This may
 
51
 * change in future versions.
52
52
 */
53
53
class row
54
54
{
60
60
 
61
61
        /**
62
62
         * Constructor that produces a valid row.
 
63
         *
63
64
         * @param handle of the statement (query) that created this row
64
65
         * @oaram row_number the index of this row
65
66
         */
77
78
public:
78
79
 
79
80
        /**
80
 
         * Determine if this row is valid or not. If it is not valid, there are no
 
81
         * Determine if this row is valid or not.  If it is not valid, there are no
81
82
         * more rows in the results of the query.
82
83
         */
83
84
        operator bool() const;
84
85
 
85
86
        /**
86
 
         * get the index in to the results that is this row
 
87
         * Get the index in to the results that is this row.
 
88
         *
87
89
         * @return index
88
90
         */
89
91
        inline unsigned long long row_number()
93
95
 
94
96
        /**
95
97
         * Ascertain a column's type.
 
98
         *
96
99
         * @param index column index
97
100
         * @return sqlite datatype code
98
101
         * @see sqlite3_column_type()
101
104
                unsigned int index );
102
105
 
103
106
        /**
104
 
         * get the number of bytes in the result for a given column.
 
107
         * Get the number of bytes in the result for a given column.
 
108
         *
105
109
         * @param index column index
106
110
         * @return number of bytes in result
107
111
         * @see sqlite3_column_bytes()
111
115
 
112
116
        /**
113
117
         * Get a value from the row.
 
118
         *
114
119
         * @param index column index
115
120
         * @param value reference to object to set with the value
116
121
         * @see sqlite3_column_*()
132
137
 
133
138
        /**
134
139
         * Get a value from the row and return it.
 
140
         *
135
141
         * @param index column index
136
142
         * @return the value
137
143
         * @see sqlite3_column_*()
147
153
 
148
154
        /**
149
155
         * Stream operator is used to obtain values from a result row, fetching from
150
 
         * each column in turn. In addition, the null and set_index() auto-column-
 
156
         * each column in turn.  In addition, the null and set_index() auto-column-
151
157
         * getting manipulators can be used.
 
158
         *
152
159
         * @param value is a variable to store the retrieved data in
153
160
         */
154
161
        template< class T >
167
174
                detail::set_index_t t );
168
175
 
169
176
        /**
170
 
         * Test to see if two rows are the same
 
177
         * Test to see if two rows are the same.
 
178
         *
171
179
         * @param other the row to compare this one to
172
180
         * @return true if they are
173
181
         */