warehouse_ros_sqlite::DatabaseConnection Class Reference

#include <database_connection.h>

Inheritance diagram for warehouse_ros_sqlite::DatabaseConnection:

Public Member Functions
bool	connect () override
	DatabaseConnection ()=default
	DatabaseConnection (sqlite3_ptr db)
void	dropDatabase (const std::string &db_name) override
	Drop a db and all its collections. A DbClientConnection exception will be thrown if the database is not connected. More...
bool	isConnected () override
	Returns whether the database is connected. More...
std::string	messageType (const std::string &db_name, const std::string &collection_name) override
	Return the ROS Message type of a given collection. More...
bool	setParams (const std::string &host, unsigned, float=60.0) override
	Set database connection params. More...
bool	setTimeout (float) override
	Set database connection params. More...
Public Member Functions inherited from warehouse_ros::DatabaseConnection
MessageCollection< M >	openCollection (const std::string &db_name, const std::string &collection_name)
MessageCollection< M >::Ptr	openCollectionPtr (const std::string &db_name, const std::string &collection_name)
virtual	~DatabaseConnection ()

Static Public Attributes
static const int	BUSY_MAX_RETRIES = 10
static const int	BUSY_WAIT_MILLISECS = 20

Protected Member Functions
std::vector< std::string >	getTablesOfDatabase (const std::string &db_name)
void	initDb ()
warehouse_ros::MessageCollectionHelper::Ptr	openCollectionHelper (const std::string &db_name, const std::string &collection_name) override
bool	schemaVersionSet ()

Private Attributes
sqlite3_ptr	db_
std::string	uri_

Additional Inherited Members
Public Types inherited from warehouse_ros::DatabaseConnection
typedef boost::shared_ptr< DatabaseConnection >	Ptr

Detailed Description

Definition at line 38 of file database_connection.h.

Constructor & Destructor Documentation

DatabaseConnection() [1/2]

warehouse_ros_sqlite::DatabaseConnection::DatabaseConnection ( )

default

DatabaseConnection() [2/2]

warehouse_ros_sqlite::DatabaseConnection::DatabaseConnection ( sqlite3_ptr  db )

inline

Definition at line 45 of file database_connection.h.

Member Function Documentation

connect()

bool warehouse_ros_sqlite::DatabaseConnection::connect ( )

overridevirtual

Setup the database connection. This call assumes setParams() has been previously called. Returns true if the connection was succesfully established.

Implements warehouse_ros::DatabaseConnection.

Definition at line 65 of file database_connection.cpp.

dropDatabase()

void warehouse_ros_sqlite::DatabaseConnection::dropDatabase ( const std::string &  db_name )

overridevirtual

Drop a db and all its collections. A DbClientConnection exception will be thrown if the database is not connected.

Implements warehouse_ros::DatabaseConnection.

Definition at line 124 of file database_connection.cpp.

getTablesOfDatabase()

std::vector< std::string > warehouse_ros_sqlite::DatabaseConnection::getTablesOfDatabase ( const std::string &  db_name )

protected

Definition at line 90 of file database_connection.cpp.

initDb()

void warehouse_ros_sqlite::DatabaseConnection::initDb ( )

protected

Definition at line 179 of file database_connection.cpp.

isConnected()

bool warehouse_ros_sqlite::DatabaseConnection::isConnected ( )

overridevirtual

Returns whether the database is connected.

Implements warehouse_ros::DatabaseConnection.

Definition at line 85 of file database_connection.cpp.

messageType()

std::string warehouse_ros_sqlite::DatabaseConnection::messageType ( const std::string &  db_name, const std::string &  collection_name  )

overridevirtual

Return the ROS Message type of a given collection.

Implements warehouse_ros::DatabaseConnection.

Definition at line 150 of file database_connection.cpp.

openCollectionHelper()

warehouse_ros::MessageCollectionHelper::Ptr warehouse_ros_sqlite::DatabaseConnection::openCollectionHelper ( const std::string &  db_name, const std::string &  collection_name  )

overrideprotectedvirtual

Implements warehouse_ros::DatabaseConnection.

Definition at line 218 of file database_connection.cpp.

schemaVersionSet()

bool warehouse_ros_sqlite::DatabaseConnection::schemaVersionSet ( )

protected

Definition at line 195 of file database_connection.cpp.

setParams()

bool warehouse_ros_sqlite::DatabaseConnection::setParams ( const std::string &  host, unsigned  , float  = 60.0  )

inlineoverridevirtual

Set database connection params.

Implements warehouse_ros::DatabaseConnection.

Definition at line 49 of file database_connection.h.

setTimeout()

bool warehouse_ros_sqlite::DatabaseConnection::setTimeout ( float  )

inlineoverridevirtual

Set database connection params.

Implements warehouse_ros::DatabaseConnection.

Definition at line 56 of file database_connection.h.

Member Data Documentation

BUSY_MAX_RETRIES

const int warehouse_ros_sqlite::DatabaseConnection::BUSY_MAX_RETRIES = 10

static

Definition at line 76 of file database_connection.h.

BUSY_WAIT_MILLISECS

const int warehouse_ros_sqlite::DatabaseConnection::BUSY_WAIT_MILLISECS = 20

static

Definition at line 75 of file database_connection.h.

db_

sqlite3_ptr warehouse_ros_sqlite::DatabaseConnection::db_

private

Definition at line 40 of file database_connection.h.

uri_

std::string warehouse_ros_sqlite::DatabaseConnection::uri_

private

Definition at line 41 of file database_connection.h.

---

The documentation for this class was generated from the following files:

• database_connection.h
• database_connection.cpp