/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: 2010-07-29 21:00:36 UTC
  • Revision ID: edam@waxworlds.org-20100729210036-7me19mqc1iqo34pm
- failed to update TODO in last commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/sqlite3cc/row.h
1
1
/*
2
2
 * row.h
3
3
 *
4
 
 * Copyright (C) 2009 Tim Marston <tim@ed.am>
 
4
 * Copyright (C) 2009 Tim Marston <edam@waxworlds.org>
5
5
 *
6
6
 * This file is part of sqlite3cc (hereafter referred to as "this program").
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.
 
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.
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
51
 
 * change in future versions.
 
50
 * query object, or until the parent query object is destructed. This may change
 
51
 * in future versions.
52
52
 */
53
53
class row
54
54
{
60
60
 
61
61
        /**
62
62
         * Constructor that produces a valid row.
63
 
         *
64
63
         * @param handle of the statement (query) that created this row
65
64
         * @oaram row_number the index of this row
66
65
         */
78
77
public:
79
78
 
80
79
        /**
81
 
         * Determine if this row is valid or not.  If it is not valid, there are no
 
80
         * Determine if this row is valid or not. If it is not valid, there are no
82
81
         * more rows in the results of the query.
83
82
         */
84
83
        operator bool() const;
85
84
 
86
85
        /**
87
 
         * Get the index in to the results that is this row.
88
 
         *
 
86
         * get the index in to the results that is this row
89
87
         * @return index
90
88
         */
91
89
        inline unsigned long long row_number()
95
93
 
96
94
        /**
97
95
         * Ascertain a column's type.
98
 
         *
99
96
         * @param index column index
100
97
         * @return sqlite datatype code
101
98
         * @see sqlite3_column_type()
104
101
                unsigned int index );
105
102
 
106
103
        /**
107
 
         * Get the number of bytes in the result for a given column.
108
 
         *
 
104
         * get the number of bytes in the result for a given column.
109
105
         * @param index column index
110
106
         * @return number of bytes in result
111
107
         * @see sqlite3_column_bytes()
115
111
 
116
112
        /**
117
113
         * Get a value from the row.
118
 
         *
119
114
         * @param index column index
120
115
         * @param value reference to object to set with the value
121
116
         * @see sqlite3_column_*()
137
132
 
138
133
        /**
139
134
         * Get a value from the row and return it.
140
 
         *
141
135
         * @param index column index
142
136
         * @return the value
143
137
         * @see sqlite3_column_*()
153
147
 
154
148
        /**
155
149
         * Stream operator is used to obtain values from a result row, fetching from
156
 
         * each column in turn.  In addition, the null and set_index() auto-column-
 
150
         * each column in turn. In addition, the null and set_index() auto-column-
157
151
         * getting manipulators can be used.
158
 
         *
159
152
         * @param value is a variable to store the retrieved data in
160
153
         */
161
154
        template< class T >
174
167
                detail::set_index_t t );
175
168
 
176
169
        /**
177
 
         * Test to see if two rows are the same.
178
 
         *
 
170
         * Test to see if two rows are the same
179
171
         * @param other the row to compare this one to
180
172
         * @return true if they are
181
173
         */