Detailed Description

A Package subclass that bundles all resources in a self contained directory structure, suitable for transport.

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

Inheritance diagram for BundledPackage:

Public Member Functions
	DELPHYNE_NO_COPY_NO_MOVE_NO_ASSIGN (BundledPackage)

	BundledPackage (const std::string &path)
	Associates instance with the given `path`. More...

void	Add (const std::string &uri_or_path)
	Adds local resource referred by `uri_or_path`. More...

void	Add (const ignition::common::URI &uri)
	Adds local resource referred by `uri`. More...

Public Member Functions inherited from Package
	DELPHYNE_NO_COPY_NO_MOVE_NO_ASSIGN (Package)

virtual	~Package ()=default

ignition::common::URI	Resolve (const std::string &uri_or_path) const
	Resolves a `uri_or_path`, specific to this package, into a full regular URI. More...

ignition::common::URI	Resolve (const ignition::common::URI &uri) const
	Resolves a `uri`, specific to this package, into a full regular URI. More...

Additional Inherited Members
Protected Member Functions inherited from Package
	Package ()=default

Constructor & Destructor Documentation

BundledPackage ( const std::string & path )

explicit

Associates instance with the given path.

Given path need not exist at construction time.

void Add ( const ignition::common::URI & uri )

Adds local resource referred by uri.

Parameters

[in] uri Identifier of the resource to be added.

Exceptions

std::runtime_error	if given `uri` is not valid (i.e. uri.Valid() is false).
std::runtime_error	if the resource is not local. Only file and package schemes are currently supported.
std::runtime_error	if the resource or any of its dependencies could not be found in the current package. See PackageManager and ResourceInspector singletons.

void Add ( const std::string & uri_or_path )

Adds local resource referred by uri_or_path.

DELPHYNE_NO_COPY_NO_MOVE_NO_ASSIGN ( BundledPackage )

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