query_results.h
Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2008, Willow Garage, Inc.
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  *     * Redistributions of source code must retain the above copyright
00009  *       notice, this list of conditions and the following disclaimer.
00010  *     * Redistributions in binary form must reproduce the above copyright
00011  *       notice, this list of conditions and the following disclaimer in the
00012  *       documentation and/or other materials provided with the distribution.
00013  *     * Neither the name of the Willow Garage, Inc. nor the names of its
00014  *       contributors may be used to endorse or promote products derived from
00015  *       this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00018  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00027  * POSSIBILITY OF SUCH DAMAGE.
00028  *
00029  */
00030 
00039 #ifndef MONGO_ROS_QUERY_RESULTS_H
00040 #define MONGO_ROS_QUERY_RESULTS_H
00041 
00042 #include <mongo_ros/message_with_metadata.h>
00043 #include <boost/optional.hpp>
00044 
00045 namespace mongo_ros
00046 {
00047 
00048 // To avoid some const-correctness issues we wrap Mongo's returned auto_ptr in
00049 // another pointer
00050 typedef std::auto_ptr<mongo::DBClientCursor> Cursor;
00051 typedef boost::shared_ptr<Cursor> CursorPtr;
00052 
00053 template <class M>
00054 class ResultIterator :
00055     public boost::iterator_facade<ResultIterator<M>,
00056                                   typename MessageWithMetadata<M>::ConstPtr,
00057                                   boost::single_pass_traversal_tag,
00058                                   typename MessageWithMetadata<M>::ConstPtr >
00059 {
00060 public:
00061 
00063   ResultIterator (boost::shared_ptr<mongo::DBClientConnection> conn,
00064                   const std::string& ns,
00065                   const mongo::Query& query,
00066                   boost::shared_ptr<mongo::GridFS> gfs,
00067                   bool metadata_only);
00068 
00070   ResultIterator (const ResultIterator& rhs);
00071 
00073   ResultIterator ();
00074 
00075 private:
00076 
00077   friend class boost::iterator_core_access;
00078 
00079   // Member functions needed to be an iterator
00080   void increment ();
00081   typename MessageWithMetadata<M>::ConstPtr dereference () const;
00082   bool equal (const ResultIterator<M>& other) const;
00083 
00084   const bool metadata_only_;
00085   CursorPtr cursor_;
00086   boost::optional<mongo::BSONObj> next_;
00087   boost::shared_ptr<mongo::GridFS> gfs_;
00088 };
00089 
00091 template <class M>
00092 struct QueryResults
00093 {
00094   typedef std::pair<ResultIterator<M>, ResultIterator<M> > range_t;
00095 };
00096 
00097 
00098 
00099 } // namespace
00100 
00101 #include "impl/query_results_impl.hpp"
00102 
00103 #endif // include guard


warehouse_ros
Author(s): Bhaskara Marthi
autogenerated on Fri Apr 22 2016 04:08:50