database_connection.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, Fetch Robotics
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Willow Garage, Inc. nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  *
29  */
30 
39 #ifndef WAREHOUSE_ROS_DATABASE_CONNECTION_H
40 #define WAREHOUSE_ROS_DATABASE_CONNECTION_H
41 
43 
44 namespace warehouse_ros
45 {
47 {
48 public:
50  {
51  }
52 
54  virtual bool setParams(const std::string& host, unsigned port, float timeout = 60.0) = 0;
55 
57  virtual bool setTimeout(float timeout) = 0;
58 
61  virtual bool connect() = 0;
62 
64  virtual bool isConnected() = 0;
65 
68  virtual void dropDatabase(const std::string& db_name) = 0;
69 
71  virtual std::string messageType(const std::string& db_name, const std::string& collection_name) = 0;
72 
75  template <class M>
76  MessageCollection<M> openCollection(const std::string& db_name, const std::string& collection_name);
77 
80  template <class M>
81  typename MessageCollection<M>::Ptr openCollectionPtr(const std::string& db_name, const std::string& collection_name);
82 
84 
85 protected:
86  virtual MessageCollectionHelper::Ptr openCollectionHelper(const std::string& db_name,
87  const std::string& collection_name) = 0;
88 };
89 
90 } // namespace warehouse_ros
91 
93 
94 #endif // include guard
virtual std::string messageType(const std::string &db_name, const std::string &collection_name)=0
Return the ROS Message type of a given collection.
MessageCollection< M >::Ptr openCollectionPtr(const std::string &db_name, const std::string &collection_name)
Open a collection on the DB. The collection is created if it doesn&#39;t exist. A DbClientConnection exce...
virtual bool isConnected()=0
Returns whether the database is connected.
virtual void dropDatabase(const std::string &db_name)=0
Drop a db and all its collections. A DbClientConnection exception will be thrown if the database is n...
virtual bool setTimeout(float timeout)=0
Set database connection params.
virtual MessageCollectionHelper::Ptr openCollectionHelper(const std::string &db_name, const std::string &collection_name)=0
boost::shared_ptr< DatabaseConnection > Ptr
MessageCollection< M > openCollection(const std::string &db_name, const std::string &collection_name)
Open a collection on the DB. The collection is created if it doesn&#39;t exist. A DbClientConnection exce...
virtual bool setParams(const std::string &host, unsigned port, float timeout=60.0)=0
Set database connection params.


warehouse_ros
Author(s): Bhaskara Marthi , Connor Brew
autogenerated on Fri Aug 20 2021 03:00:01