delphyne
Resource Class Referenceabstract

Detailed Description

A class for resource representation.

#include <include/delphyne/utility/resources/resources.h>

Inheritance diagram for Resource:
[legend]

Public Member Functions

 DELPHYNE_NO_COPY_NO_MOVE_NO_ASSIGN (Resource)
 
 Resource (const ignition::common::URI &uri)
 Constructs a resource associated with the given uri. More...
 
virtual ~Resource ()=default
 Default destructor. More...
 
const ignition::common::URI & Uri () const
 Returns this resource URI. More...
 
std::string Path () const
 Returns this resource path in the local file system. More...
 
virtual std::vector< ignition::common::URI > GetDependencies () const =0
 Retrieves the list of resources that this resource depends on. More...
 

Constructor & Destructor Documentation

◆ Resource()

Resource ( const ignition::common::URI &  uri)
explicit

Constructs a resource associated with the given uri.

◆ ~Resource()

virtual ~Resource ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ DELPHYNE_NO_COPY_NO_MOVE_NO_ASSIGN()

DELPHYNE_NO_COPY_NO_MOVE_NO_ASSIGN ( Resource  )

◆ GetDependencies()

virtual std::vector<ignition::common::URI> GetDependencies ( ) const
pure virtual

Retrieves the list of resources that this resource depends on.

Returns
The URIs of the dependencies, if any.

Implemented in GenericResource.

◆ Path()

std::string Path ( ) const

Returns this resource path in the local file system.

Exceptions
std::runtime_errorif resolving URI against current Package fails (see PackageManager class documentation).
std::runtime_errorif the resource is not local.

◆ Uri()

const ignition::common::URI& Uri ( ) const

Returns this resource URI.


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