Tesseract 0.28.4
Loading...
Searching...
No Matches
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 Ptr = std::shared_ptr<SimpleLocatedResource>
using ConstPtr = std::shared_ptr<const SimpleLocatedResource>
Public Types inherited from tesseract::common::Resource
using Ptr = std::shared_ptr<Resource>
using ConstPtr = std::shared_ptr<const Resource>
Public Types inherited from tesseract::common::ResourceLocator
using Ptr = std::shared_ptr<ResourceLocator>
using ConstPtr = std::shared_ptr<const ResourceLocator>

Public Member Functions

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

Friends

template<class Archive>
friend void::tesseract::common::serialize (Archive &ar, SimpleLocatedResource &obj)

Detailed Description

Resource implementation for a local file.

Constructor & Destructor Documentation

◆ SimpleLocatedResource()

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

A generic resource.

Parameters
urlThe url to the resource
filenameThe file path to the resource
parentThe locator used to locate the resource

Member Function Documentation

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ locateResource()

tesseract::common::Resource::Ptr tesseract::common::SimpleLocatedResource::locateResource ( const std::string & url) const
finaloverridevirtual

Locate a resource based on a URL.

Parameters
urlThe URL of the resource
Returns
A shared pointer to a Resource instance, or nullptr if not found

Implements tesseract::common::ResourceLocator.