daeURIResolver Class Reference

#include <daeURI.h>

Inheritance diagram for daeURIResolver:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 daeURIResolver (DAE &dae)
virtual daeString getName ()=0
virtual daeElementresolveElement (const daeURI &uri)=0
virtual ~daeURIResolver ()

Static Public Member Functions

static daeBool getAutoLoadExternalDocuments ()
static void setAutoLoadExternalDocuments (daeBool load)

Protected Attributes

DAEdae

Static Protected Attributes

static daeBool _loadExternalDocuments

Detailed Description

The daeURIResolver class is the plugin point for URI resolution. This class is an abstract base class that defines an interface for resolving URIs. Every URI is passed through this list of daeURIResolvers for resolution. The list is ordered on a first come, first serve basis, and resolution terminates after any resolver instance resolves the URI.

Definition at line 348 of file daeURI.h.


Constructor & Destructor Documentation

daeURIResolver::daeURIResolver ( DAE dae  ) 

Constructor

Parameters:
dae The associated dae object.
virtual daeURIResolver::~daeURIResolver (  )  [virtual]

Destructor


Member Function Documentation

static daeBool daeURIResolver::getAutoLoadExternalDocuments (  )  [static]

Gets a flag that tells if the URI resolver is set to load an external document if a URI being resolved points to one.

Returns:
Returns true if the resolver will automatically load documents to resolve a URI. False otherwise.
virtual daeString daeURIResolver::getName (  )  [pure virtual]

Gets the name of this resolver.

Returns:
Returns the resolver name as a string.

Implemented in daeRawResolver, and daeStandardURIResolver.

virtual daeElement* daeURIResolver::resolveElement ( const daeURI uri  )  [pure virtual]

Provides an abstract interface for converting a daeURI into a daeElement

Parameters:
uri daeURI to resolve.
Returns:
Returns the resolved element, or null if resolving failed. returns false otherwise.

Implemented in daeRawResolver, and daeStandardURIResolver.

static void daeURIResolver::setAutoLoadExternalDocuments ( daeBool  load  )  [static]

Sets a flag that tells the URI resolver whether or not to load a separate document if a URI being resolved points to one.

Parameters:
load Set to true if you want the URI Resolver to automatically load other documents to resolve URIs.

Member Data Documentation

Definition at line 393 of file daeURI.h.

DAE* daeURIResolver::dae [protected]

Definition at line 394 of file daeURI.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


colladadom
Author(s): Du Hung Hou, Khronos.org, Marcus Barnes, Greg Corson, Herbert Law, Sebastian Schwarz, Steven Thomas, John Hsu (ros package), Tim Field (ros package)
autogenerated on Fri Jan 11 09:29:16 2013