Public Types | Public Member Functions | Private Member Functions | Friends | List of all members
tesseract_common::ResourceLocator Class Referenceabstract

Abstract class for resource loaders. More...

#include <resource_locator.h>

Inheritance diagram for tesseract_common::ResourceLocator:
Inheritance graph
[legend]

Public Types

using ConstPtr = std::shared_ptr< const ResourceLocator >
 
using Ptr = std::shared_ptr< ResourceLocator >
 

Public Member Functions

virtual std::shared_ptr< ResourcelocateResource (const std::string &url) const =0
 Locate a resource based on a URL. More...
 
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)
 

Friends

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

Detailed Description

Abstract class for resource loaders.

Definition at line 53 of file resource_locator.h.

Member Typedef Documentation

◆ ConstPtr

Definition at line 57 of file resource_locator.h.

◆ Ptr

Definition at line 56 of file resource_locator.h.

Constructor & Destructor Documentation

◆ ~ResourceLocator()

virtual tesseract_common::ResourceLocator::~ResourceLocator ( )
virtualdefault

Member Function Documentation

◆ locateResource()

virtual std::shared_ptr<Resource> tesseract_common::ResourceLocator::locateResource ( const std::string &  url) const
pure virtual

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

Implemented in tesseract_common::BytesResource, tesseract_common::SimpleLocatedResource, TestResourceLocator, TestResourceLocator, and tesseract_common::GeneralResourceLocator.

◆ operator!=()

bool tesseract_common::ResourceLocator::operator!= ( const ResourceLocator rhs) const

Definition at line 53 of file resource_locator.cpp.

◆ operator==()

bool tesseract_common::ResourceLocator::operator== ( const ResourceLocator rhs) const

Definition at line 52 of file resource_locator.cpp.

◆ serialize()

template<class Archive >
void tesseract_common::ResourceLocator::serialize ( Archive &  ar,
const unsigned int  version 
)
private

Definition at line 56 of file resource_locator.cpp.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Definition at line 73 of file resource_locator.h.

◆ tesseract_common::Serialization

friend struct tesseract_common::Serialization
friend

Definition at line 74 of file resource_locator.h.


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


tesseract_common
Author(s): Levi Armstrong
autogenerated on Sun May 18 2025 03:01:40