database_loader.h
Go to the documentation of this file.
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2015, Fetch Robotics
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of Willow Garage nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *********************************************************************/
34 
35 /* Author: Connor Brew */
36 
37 #ifndef WAREHOUSE_ROS_DATABASE_LOADER_
38 #define WAREHOUSE_ROS_DATABASE_LOADER_
39 
40 #include <boost/scoped_ptr.hpp>
43 
44 namespace warehouse_ros
45 {
46 class DBConnectionStub : public DatabaseConnection
47 {
48 public:
49  bool setParams(const std::string& /*host*/, unsigned /*port*/, float /*timeout*/) override
50  {
51  return false;
52  }
53  bool setTimeout(float /*timeout*/) override
54  {
55  return false;
56  }
57  bool connect() override
58  {
59  return false;
60  }
61  bool isConnected() override
62  {
63  return false;
64  }
65  void dropDatabase(const std::string& /*db_name*/) override
66  {
67  throw warehouse_ros::DbConnectException("Database is stub");
68  }
69  std::string messageType(const std::string& /*db_name*/, const std::string& /*collection_name*/) override
70  {
71  throw warehouse_ros::DbConnectException("Database is stub");
72  }
73 
74 protected:
75  typename MessageCollectionHelper::Ptr openCollectionHelper(const std::string& db_name,
76  const std::string& collection_name) override;
77 };
78 
80 class DatabaseLoader
81 {
82 public:
86 
88 
90  void initialize();
91 
96 
97 private:
99  boost::scoped_ptr<pluginlib::ClassLoader<warehouse_ros::DatabaseConnection> > db_plugin_loader_;
100 };
101 } // namespace warehouse_ros
102 
103 #endif
warehouse_ros::DatabaseLoader::db_plugin_loader_
boost::scoped_ptr< pluginlib::ClassLoader< warehouse_ros::DatabaseConnection > > db_plugin_loader_
Definition: database_loader.h:131
warehouse_ros::DatabaseLoader::DatabaseLoader
DatabaseLoader()
Takes a warehouse_ros DatabaseConnection. The DatabaseConnection is expected to have already been ini...
Definition: database_loader.cpp:75
warehouse_ros::DatabaseLoader::~DatabaseLoader
~DatabaseLoader()
Definition: database_loader.cpp:80
boost::shared_ptr
warehouse_ros::DatabaseLoader::loadDatabase
DatabaseConnection::Ptr loadDatabase()
Load a database connection using pluginlib Looks for ROS params specifying which plugin/host/port to ...
Definition: database_loader.cpp:98
warehouse_ros::DbConnectException
Couldn't connect to database.
Definition: exceptions.h:68
warehouse_ros::DBConnectionStub::dropDatabase
void dropDatabase(const std::string &) override
Drop a db and all its collections. A DbClientConnection exception will be thrown if the database is n...
Definition: database_loader.h:129
warehouse_ros::DBConnectionStub::setTimeout
bool setTimeout(float) override
Set database connection params.
Definition: database_loader.h:117
warehouse_ros::DatabaseLoader::initialize
void initialize()
Initialize the DatabaseLoader.
Definition: database_loader.cpp:84
warehouse_ros::DatabaseLoader::nh_
ros::NodeHandle nh_
Definition: database_loader.h:130
class_loader.hpp
database_connection.h
warehouse_ros::DatabaseLoader
This class provides the mechanism to connect to a database and reads needed ROS parameters when appro...
Definition: database_loader.h:112
warehouse_ros::MessageCollectionHelper::Ptr
boost::shared_ptr< MessageCollectionHelper > Ptr
Definition: message_collection.h:61
warehouse_ros::DBConnectionStub::messageType
std::string messageType(const std::string &, const std::string &) override
Return the ROS Message type of a given collection.
Definition: database_loader.h:133
warehouse_ros::DBConnectionStub::connect
bool connect() override
Definition: database_loader.h:121
warehouse_ros::DBConnectionStub::setParams
bool setParams(const std::string &, unsigned, float) override
Set database connection params.
Definition: database_loader.h:113
warehouse_ros::DBConnectionStub::openCollectionHelper
MessageCollectionHelper::Ptr openCollectionHelper(const std::string &db_name, const std::string &collection_name) override
Definition: database_loader.cpp:155
warehouse_ros
Definition: database_connection.h:44
warehouse_ros::DBConnectionStub::isConnected
bool isConnected() override
Returns whether the database is connected.
Definition: database_loader.h:125
ros::NodeHandle


warehouse_ros
Author(s): Bhaskara Marthi , Connor Brew
autogenerated on Wed Oct 16 2024 02:42:07