knowrob::DataSourceHandler Class Reference

#include <DataSourceHandler.h>

Inheritance diagram for knowrob::DataSourceHandler:

Public Member Functions
	DataSourceHandler ()=default
virtual	~DataSourceHandler ()=default
void	addDataHandler (const std::string &format, const DataSourceLoader &fn)
bool	loadDataSource (const DataSourcePtr &dataSource)
bool	hasDataHandler (const DataSourcePtr &dataSource) const
	DataSourceHandler ()=default
virtual	~DataSourceHandler ()=default
void	addDataHandler (const std::string &format, const DataSourceLoader &fn)
bool	loadDataSource (const DataSourcePtr &dataSource)
bool	hasDataHandler (const DataSourcePtr &dataSource) const

Protected Member Functions
virtual bool	loadDataSourceWithUnknownFormat (const DataSourcePtr &)
virtual bool	loadDataSourceWithUnknownFormat (const DataSourcePtr &)

Protected Attributes
std::map< std::string, DataSourceLoader >	dataSourceHandler_

Detailed Description

An object that can load data sources.

Definition at line 20 of file DataSourceHandler.h.

Constructor & Destructor Documentation

DataSourceHandler() [1/2]

knowrob::DataSourceHandler::DataSourceHandler ( )

default

~DataSourceHandler() [1/2]

virtual knowrob::DataSourceHandler::~DataSourceHandler ( )

virtualdefault

DataSourceHandler() [2/2]

knowrob::DataSourceHandler::DataSourceHandler ( )

default

~DataSourceHandler() [2/2]

virtual knowrob::DataSourceHandler::~DataSourceHandler ( )

virtualdefault

Member Function Documentation

addDataHandler() [1/2]

void knowrob::DataSourceHandler::addDataHandler	(	const std::string &	format,
		const DataSourceLoader &	fn
	)

Add a handler for a data source format.

Parameters

format	the format name.
fn	the handler function.

addDataHandler() [2/2]

void knowrob::DataSourceHandler::addDataHandler	(	const std::string &	format,
		const DataSourceLoader &	fn
	)

Add a handler for a data source format.

Parameters

format	the format name.
fn	the handler function.

hasDataHandler() [1/2]

bool DataSourceHandler::hasDataHandler

(

const DataSourcePtr &

dataSource

)

const

Check if a handler for a data source is available.

Parameters

dataSource

a data source.

Returns

true if a handler is available.

Definition at line 24 of file DataSourceHandler.cpp.

                                                                            {
    return dataSourceHandler_.find(dataSource->format()) != dataSourceHandler_.end();
}

hasDataHandler() [2/2]

bool knowrob::DataSourceHandler::hasDataHandler

(

const DataSourcePtr &

dataSource

)

const

Check if a handler for a data source is available.

Parameters

dataSource

a data source.

Returns

true if a handler is available.

loadDataSource() [1/2]

bool DataSourceHandler::loadDataSource

(

const DataSourcePtr &

dataSource

)

Load a data source. The knowledge base system calls this function for each data source that is passed to the reasoner.

Parameters

dataSource

the data source to load.

Definition at line 11 of file DataSourceHandler.cpp.

                                                                      {
    if (dataSource->format().empty()) {
        return loadDataSourceWithUnknownFormat(dataSource);
    } else {
        auto it = dataSourceHandler_.find(dataSource->format());
        if (it != dataSourceHandler_.end()) {
            return it->second(dataSource);
        } else {
            return false;
        }
    }
}

loadDataSource() [2/2]

bool knowrob::DataSourceHandler::loadDataSource

(

const DataSourcePtr &

dataSource

)

Load a data source. The knowledge base system calls this function for each data source that is passed to the reasoner.

Parameters

dataSource

the data source to load.

loadDataSourceWithUnknownFormat() [1/2]

virtual bool knowrob::DataSourceHandler::loadDataSourceWithUnknownFormat ( const DataSourcePtr &  )

inlineprotectedvirtual

Reimplemented in knowrob::PrologReasoner, and knowrob::PrologReasoner.

Definition at line 52 of file DataSourceHandler.h.

{ return false; }

loadDataSourceWithUnknownFormat() [2/2]

virtual bool knowrob::DataSourceHandler::loadDataSourceWithUnknownFormat ( const DataSourcePtr &  )

inlineprotectedvirtual

Reimplemented in knowrob::PrologReasoner, and knowrob::PrologReasoner.

Definition at line 52 of file DataSourceHandler.h.

{ return false; }

Member Data Documentation

dataSourceHandler_

std::map< std::string, DataSourceLoader > knowrob::DataSourceHandler::dataSourceHandler_

protected

Definition at line 50 of file DataSourceHandler.h.

---

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

• build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/DataSourceHandler.h
• src/DataSourceHandler.cpp