message_collection.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, Willow Garage, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Willow Garage, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef MONGO_ROS_MESSAGE_COLLECTION_H
#define MONGO_ROS_MESSAGE_COLLECTION_H

#include <mongo_ros/query_results.h>
#include <ros/ros.h>

namespace mongo_ros
{

template <class M>
class MessageCollection
{
public:

  MessageCollection (const std::string& db_name,
                     const std::string& collection_name,
                     const std::string& db_host="",
                     unsigned db_port=0,
                     float timeout=300.0);

  void insert (const M& msg, const Metadata& metadata = Metadata());

  typename QueryResults<M>::range_t
  queryResults (const mongo::Query& query, bool metadata_only = false,
                const std::string& sort_by = "", bool ascending=true) const;

  std::vector<typename MessageWithMetadata<M>::ConstPtr >
  pullAllResults (const mongo::Query& query, bool metadata_only = false,
                  const std::string& sort_by = "", bool ascending=true) const;

  
  typename MessageWithMetadata<M>::ConstPtr
  findOne (const Query& query, bool metadata_only = false) const;

  unsigned removeMessages (const mongo::Query& query);

  MessageCollection& ensureIndex (const std::string& field);
  
  void modifyMetadata (const Query& q, const Metadata& m);

  unsigned count ();

private:

  // Called by constructors
  void initialize (const std::string& db, const std::string& coll,
                   const std::string& host, unsigned port,
                   float timeout);

  const std::string ns_;
  boost::shared_ptr<mongo::DBClientConnection> conn_;
  boost::shared_ptr<mongo::GridFS> gfs_;
  ros::NodeHandle nh_;
  ros::Publisher insertion_pub_;
};


} // namespace

#include "../../src/message_collection_impl.h"

#endif // include guard