prt::ResolveMapBuilder Class Reference

#include <ResolveMap.h>

Inheritance diagram for prt::ResolveMapBuilder:

Public Types
enum	EmbeddedEntriesMode {   EEM_INSPECT_AND_ADD,   EEM_IGNORE }

Public Member Functions
virtual Status	addEntry (const wchar_t *key, const wchar_t *uri, EmbeddedEntriesMode embeddedEntries=EEM_INSPECT_AND_ADD)=0
virtual ResolveMap const *	createResolveMap (Status *status=nullptr) const =0
virtual ResolveMap const *	createResolveMapAndReset (Status *status=nullptr)=0
virtual Status	setDownstreamMap (const ResolveMap *map)=0
Public Member Functions inherited from prt::Object
void	destroy () const
virtual char *	toXML (char *result, size_t *resultSize, Status *stat=0) const =0
char *	toXMLDocument (char *result, size_t *resultSize, Status *stat=0) const

Static Public Member Functions
static ResolveMapBuilder *	create (Status *status=nullptr)
static ResolveMapBuilder *	createFromResolveMap (ResolveMap const *resolveMap, Status *status=nullptr)

Additional Inherited Members
Protected Member Functions inherited from prt::Object
	Object (const Object &)

Detailed Description

Used for building a ResolveMap instance.

Member Enumeration Documentation

EmbeddedEntriesMode

enum prt::ResolveMapBuilder::EmbeddedEntriesMode

Enum for embedded entries mode in addEntry()

Enumerator
EEM_INSPECT_AND_ADD	inspect uri and add embedded resources
EEM_IGNORE	do not try to resolve and add embedded resources

Member Function Documentation

addEntry()

virtual Status prt::ResolveMapBuilder::addEntry ( const wchar_t *  key, const wchar_t *  uri, EmbeddedEntriesMode  embeddedEntries = EEM_INSPECT_AND_ADD  )

pure virtual

Adds a (key, URI) entry.

Parameters

key	The (unique) key string.
uri	The percent-encded URI to the (embedded) asset or texture. See Application Notes for URI creation.
embeddedEntries	If mode is EEM_INSPECT_AND_ADD (default), the uri is inspected if it points to a resource for which a Decoder with a ResolveMapProvider which can handle embedded resources is registered in the ExtensionManager. If so, and the resource is inspected and embedded resources are added as (key, uri) pairs too.

Returns

status.

create()

static ResolveMapBuilder* prt::ResolveMapBuilder::create ( Status *  status = nullptr )

static

Creates a new instance which must be destroyed by the caller.

Parameters

[out]

status

Optional pointer to return the status.

Returns

a new ResolveMapBuilder instance or 0 on error.

createFromResolveMap()

static ResolveMapBuilder* prt::ResolveMapBuilder::createFromResolveMap ( ResolveMap const *  resolveMap, Status *  status = nullptr  )

static

Creates a new builder instance which is initialized to the passed ResolveMap. The builder instance must be destroyed by the caller. #

Parameters

	resolveMap	ResolveMap to initialize this builder with.
[out]	status	Optional pointer to return the status.

Returns

a new ResolveMapBuilder instance or 0 on error.

createResolveMap()

virtual ResolveMap const* prt::ResolveMapBuilder::createResolveMap ( Status *  status = nullptr ) const

pure virtual

Creates a new ResolveMap instance. The instance must be destroyed by the caller.

Parameters

[out]

status

Optional pointer to return the status.

Returns

a new ResolveMap instance or 0 on error.

createResolveMapAndReset()

virtual ResolveMap const* prt::ResolveMapBuilder::createResolveMapAndReset ( Status *  status = nullptr )

pure virtual

Creates a new ResolveMap instance and resets the builder. The instance must be destroyed by the caller.

Parameters

[out]

status

Optional pointer to return the status.

Returns

a new ResolveMap instance or 0 on error.

setDownstreamMap()

virtual Status prt::ResolveMapBuilder::setDownstreamMap ( const ResolveMap *  map )

pure virtual

Puts a ResolveMap in place downstream. In key lookups, the lookup propagates to the downstream map if it is not found in the current map.

Parameters

map	The downstream ResolveMap to set.

Returns

status.

---

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

• ResolveMap.h