tesseract_common::SimpleLocatedResource Class Reference

Resource implementation for a local file. More...

#include <resource_locator.h>

Inheritance diagram for tesseract_common::SimpleLocatedResource:

Public Types
using	ConstPtr = std::shared_ptr< const SimpleLocatedResource >
using	Ptr = std::shared_ptr< SimpleLocatedResource >
Public Types inherited from tesseract_common::Resource
using	ConstPtr = std::shared_ptr< const Resource >
using	Ptr = std::shared_ptr< Resource >
Public Types inherited from tesseract_common::ResourceLocator
using	ConstPtr = std::shared_ptr< const ResourceLocator >
using	Ptr = std::shared_ptr< ResourceLocator >

Public Member Functions
std::string	getFilePath () const override final
	Get the file path of the resource. Only valid if isFile() is true. More...
std::vector< uint8_t >	getResourceContents () const override final
	Get the resource as bytes. This function may block. More...
std::shared_ptr< std::istream >	getResourceContentStream () const override final
	Get the resource as a std::istream. This function and the returned stream may block. More...
std::string	getUrl () const override final
	Get the original URL used to locate the file. More...
bool	isFile () const override final
	Returns true if the located resource is a local file. More...
Resource::Ptr	locateResource (const std::string &url) const override final
	Locate a resource based on a URL. More...
bool	operator!= (const SimpleLocatedResource &rhs) const
SimpleLocatedResource &	operator= (const SimpleLocatedResource &)=default
SimpleLocatedResource &	operator= (SimpleLocatedResource &&)=default
bool	operator== (const SimpleLocatedResource &rhs) const
	SimpleLocatedResource ()=default
	This is for boost serialization do not use directly. More...
	SimpleLocatedResource (const SimpleLocatedResource &)=default
	SimpleLocatedResource (SimpleLocatedResource &&)=default
	SimpleLocatedResource (std::string url, std::string filename, ResourceLocator::ConstPtr parent=nullptr)
	A generic resource. More...
	~SimpleLocatedResource () override=default
Public Member Functions inherited from tesseract_common::Resource
bool	operator!= (const Resource &rhs) const
bool	operator== (const Resource &rhs) const
Public Member Functions inherited from tesseract_common::ResourceLocator
bool	operator!= (const ResourceLocator &rhs) const
bool	operator== (const ResourceLocator &rhs) const
virtual	~ResourceLocator ()=default

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Private Attributes
std::string	filename_
ResourceLocator::ConstPtr	parent_
std::string	url_

Friends
class	boost::serialization::access
struct	tesseract_common::Serialization

Detailed Description

Resource implementation for a local file.

Definition at line 201 of file resource_locator.h.

Member Typedef Documentation

ConstPtr

using tesseract_common::SimpleLocatedResource::ConstPtr = std::shared_ptr<const SimpleLocatedResource>

Definition at line 205 of file resource_locator.h.

Ptr

using tesseract_common::SimpleLocatedResource::Ptr = std::shared_ptr<SimpleLocatedResource>

Definition at line 204 of file resource_locator.h.

Constructor & Destructor Documentation

SimpleLocatedResource() [1/4]

tesseract_common::SimpleLocatedResource::SimpleLocatedResource ( )

default

This is for boost serialization do not use directly.

SimpleLocatedResource() [2/4]

tesseract_common::SimpleLocatedResource::SimpleLocatedResource	(	std::string	url,
		std::string	filename,
		ResourceLocator::ConstPtr	parent = nullptr
	)

A generic resource.

Parameters

url	The url to the resource
filename	The file path to the resource
parent	The locator used to locate the resource

Definition at line 228 of file resource_locator.cpp.

~SimpleLocatedResource()

tesseract_common::SimpleLocatedResource::~SimpleLocatedResource ( )

overridedefault

SimpleLocatedResource() [3/4]

tesseract_common::SimpleLocatedResource::SimpleLocatedResource ( const SimpleLocatedResource &  )

default

SimpleLocatedResource() [4/4]

tesseract_common::SimpleLocatedResource::SimpleLocatedResource ( SimpleLocatedResource &&  )

default

Member Function Documentation

getFilePath()

std::string tesseract_common::SimpleLocatedResource::getFilePath ( ) const

finaloverridevirtual

Get the file path of the resource. Only valid if isFile() is true.

Returns

The file path to the resource

Implements tesseract_common::Resource.

Definition at line 237 of file resource_locator.cpp.

getResourceContents()

std::vector< uint8_t > tesseract_common::SimpleLocatedResource::getResourceContents ( ) const

finaloverridevirtual

Get the resource as bytes. This function may block.

Returns

Resource bytes as a uint8_t vector

Implements tesseract_common::Resource.

Definition at line 239 of file resource_locator.cpp.

getResourceContentStream()

std::shared_ptr< std::istream > tesseract_common::SimpleLocatedResource::getResourceContentStream ( ) const

finaloverridevirtual

Get the resource as a std::istream. This function and the returned stream may block.

Returns

A std::istream shared pointer for the resource data

Implements tesseract_common::Resource.

Definition at line 259 of file resource_locator.cpp.

getUrl()

std::string tesseract_common::SimpleLocatedResource::getUrl ( ) const

finaloverridevirtual

Get the original URL used to locate the file.

Returns

The URL of the resource

Implements tesseract_common::Resource.

Definition at line 235 of file resource_locator.cpp.

isFile()

bool tesseract_common::SimpleLocatedResource::isFile ( ) const

finaloverridevirtual

Returns true if the located resource is a local file.

Returns

true if the resource is a local file, otherwise false

Implements tesseract_common::Resource.

Definition at line 233 of file resource_locator.cpp.

locateResource()

tesseract_common::Resource::Ptr tesseract_common::SimpleLocatedResource::locateResource ( const std::string &  url ) const

finaloverridevirtual

Locate a resource based on a URL.

Parameters

url	The URL of the resource

Returns

A shared pointer to a Resource instance, or nullptr if not found

Implements tesseract_common::ResourceLocator.

Definition at line 270 of file resource_locator.cpp.

operator!=()

bool tesseract_common::SimpleLocatedResource::operator!=

(

const SimpleLocatedResource &

rhs

)

const

Definition at line 311 of file resource_locator.cpp.

operator=() [1/2]

SimpleLocatedResource& tesseract_common::SimpleLocatedResource::operator= ( const SimpleLocatedResource &  )

default

operator=() [2/2]

SimpleLocatedResource& tesseract_common::SimpleLocatedResource::operator= ( SimpleLocatedResource &&  )

default

operator==()

bool tesseract_common::SimpleLocatedResource::operator==

(

const SimpleLocatedResource &

rhs

)

const

Definition at line 301 of file resource_locator.cpp.

serialize()

template<class Archive >

void tesseract_common::SimpleLocatedResource::serialize ( Archive &  ar, const unsigned int  version  )

private

Definition at line 314 of file resource_locator.cpp.

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Definition at line 243 of file resource_locator.h.

tesseract_common::Serialization

friend struct tesseract_common::Serialization

friend

Definition at line 244 of file resource_locator.h.

Member Data Documentation

filename_

std::string tesseract_common::SimpleLocatedResource::filename_

private

Definition at line 240 of file resource_locator.h.

parent_

ResourceLocator::ConstPtr tesseract_common::SimpleLocatedResource::parent_

private

Definition at line 241 of file resource_locator.h.

url_

std::string tesseract_common::SimpleLocatedResource::url_

private

Definition at line 239 of file resource_locator.h.

---

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

• resource_locator.h
• resource_locator.cpp