Aikido
aikido::io::CatkinResourceRetriever Class Reference

Retreive resources specified by 'package://' URIs. More...

#include <aikido/io/CatkinResourceRetriever.hpp>

Inheritance diagram for aikido::io::CatkinResourceRetriever:

Classes

struct  Workspace
 

Public Member Functions

 CatkinResourceRetriever ()
 Constructs a resource retriever that delegates to a LocalResourceRetriever to resolve 'file://' URIs. More...
 
 CatkinResourceRetriever (const dart::common::ResourceRetrieverPtr &_delegate)
 Constructs a resource retriever that delegates to a LocalResourceRetriever to retrieve 'file://' URIs. More...
 
virtual ~CatkinResourceRetriever ()=default
 
bool exists (const dart::common::Uri &_uri) override
 
dart::common::ResourcePtr retrieve (const dart::common::Uri &_uri) override
 

Private Member Functions

std::vector< WorkspacegetWorkspaces () const
 
dart::common::Uri resolvePackageUri (const dart::common::Uri &_uri) const
 

Private Attributes

dart::common::ResourceRetrieverPtr mDelegate
 
std::vector< WorkspacemWorkspaces
 

Detailed Description

Retreive resources specified by 'package://' URIs.

This class resolves a 'package://' URI to a 'file://' URI using the same logic as catkin.find_in_workspaces, then resolves the resource using a delegate ResourceRetriever.

Constructor & Destructor Documentation

◆ CatkinResourceRetriever() [1/2]

aikido::io::CatkinResourceRetriever::CatkinResourceRetriever ( )

Constructs a resource retriever that delegates to a LocalResourceRetriever to resolve 'file://' URIs.

◆ CatkinResourceRetriever() [2/2]

aikido::io::CatkinResourceRetriever::CatkinResourceRetriever ( const dart::common::ResourceRetrieverPtr &  _delegate)
explicit

Constructs a resource retriever that delegates to a LocalResourceRetriever to retrieve 'file://' URIs.

Parameters
_delegateresource retriever to retrieve 'file://' URIs

◆ ~CatkinResourceRetriever()

virtual aikido::io::CatkinResourceRetriever::~CatkinResourceRetriever ( )
virtualdefault

Member Function Documentation

◆ exists()

bool aikido::io::CatkinResourceRetriever::exists ( const dart::common::Uri &  _uri)
override

◆ getWorkspaces()

std::vector<Workspace> aikido::io::CatkinResourceRetriever::getWorkspaces ( ) const
private

◆ resolvePackageUri()

dart::common::Uri aikido::io::CatkinResourceRetriever::resolvePackageUri ( const dart::common::Uri &  _uri) const
private

◆ retrieve()

dart::common::ResourcePtr aikido::io::CatkinResourceRetriever::retrieve ( const dart::common::Uri &  _uri)
override

Member Data Documentation

◆ mDelegate

dart::common::ResourceRetrieverPtr aikido::io::CatkinResourceRetriever::mDelegate
private

◆ mWorkspaces

std::vector<Workspace> aikido::io::CatkinResourceRetriever::mWorkspaces
private