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 WAREHOUSE_ROS_QUERY_RESULTS_H
00040 #define WAREHOUSE_ROS_QUERY_RESULTS_H
00041 
00042 #include <warehouse_ros/message_with_metadata.h>
00043 #include <warehouse_ros/exceptions.h>
00044 #include <boost/iterator/iterator_facade.hpp>
00045 
00046 namespace warehouse_ros
00047 {
00048 
00049 class ResultIteratorHelper
00050 {
00051 public:
00052   virtual bool next() = 0;
00053   virtual bool hasData() const = 0;
00054   virtual Metadata::ConstPtr metadata() const = 0;
00055   virtual std::string message() const = 0;
00056 
00057   typedef boost::shared_ptr<ResultIteratorHelper> Ptr;
00058 };
00059 
00060 template<class M>
00061   class ResultIterator : public boost::iterator_facade<ResultIterator<M>, typename MessageWithMetadata<M>::ConstPtr,
00062       boost::single_pass_traversal_tag, typename MessageWithMetadata<M>::ConstPtr>
00063   {
00064   public:
00066     ResultIterator(ResultIteratorHelper::Ptr results, bool metadata_only);
00067 
00069     ResultIterator(const ResultIterator& rhs);
00070 
00072     ResultIterator();
00073 
00075     ~ResultIterator();
00076 
00077     ResultIterator& operator=(const ResultIterator& other);
00078 
00079   private:
00080     friend class boost::iterator_core_access;
00081 
00082     // Member functions needed to be an iterator
00083     void increment();
00084     typename MessageWithMetadata<M>::ConstPtr dereference() const;
00085     bool equal(const ResultIterator<M>& other) const;
00086 
00087     ResultIteratorHelper::Ptr results_;
00088     const bool metadata_only_;
00089   };
00090 
00091 template<class M>
00092   struct QueryResults
00093   {
00094     typedef std::pair<ResultIterator<M>, ResultIterator<M> > range_t;
00095   };
00096 
00097 } // namespace
00098 
00099 #include "impl/query_results_impl.hpp"
00100 
00101 #endif // include guard


warehouse_ros
Author(s): Bhaskara Marthi , Connor Brew
autogenerated on Thu Jun 23 2016 05:36:41