#include <pathMappingHandler.h>

Public Types
typedef std::shared_ptr< PathMappingHandler >	Ptr

Public Member Functions
	PathMappingHandler ()=default
	Constructor. More...

	PathMappingHandler (const PathMappingHandler &)=default
	Default copy constructor. More...

virtual	~PathMappingHandler ()=default
	Destructor. More...

virtual Path	toHost (const Path &) const =0
	Maps a runtime path into its host alias equivalent. More...

virtual Path	fromHost (const Path &) const =0
	Maps a host alias of the path into its runtime equivalent. More...

Static Public Member Functions

static Ptr	pathMappingHandler (Rtid)

static Ptr	pathMappingHandler (const SceneItem::Ptr &)

Detailed Description

This base class defines an interface that runtimes can implement to provide a path mapping service. A runtime can have paths that are aliases to one another. This service allows conversion from the path to the aliased path and vice-versa.

Definition at line 26 of file pathMappingHandler.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<PathMappingHandler> Ufe::PathMappingHandler::Ptr

Definition at line 29 of file pathMappingHandler.h.

Constructor & Destructor Documentation

◆ PathMappingHandler() [1/2]

Ufe::PathMappingHandler::PathMappingHandler ( )

default

Constructor.

◆ PathMappingHandler() [2/2]

Ufe::PathMappingHandler::PathMappingHandler ( const PathMappingHandler & )

default

Default copy constructor.

◆ ~PathMappingHandler()

virtual Ufe::PathMappingHandler::~PathMappingHandler ( )

virtualdefault

Destructor.

Member Function Documentation

◆ fromHost()

virtual Path Ufe::PathMappingHandler::fromHost ( const Path & ) const

pure virtual

Maps a host alias of the path into its runtime equivalent.

◆ pathMappingHandler() [1/2]

static Ptr Ufe::PathMappingHandler::pathMappingHandler ( Rtid )

static

Convenience method to retrieve the path mapping handler. The handler interface will remain valid as long as the given runtime remains set in the runtime manager.

◆ pathMappingHandler() [2/2]

static Ptr Ufe::PathMappingHandler::pathMappingHandler ( const SceneItem::Ptr & )

static

Convenience method to retrieve the path mapping handler. The handler interface will remain valid as long as the given runtime remains set in the runtime manager.

◆ toHost()

virtual Path Ufe::PathMappingHandler::toHost ( const Path & ) const