ArcGIS Procedural Runtime  3.2.10650
List of all members | Public Types | Public Member Functions | Protected Attributes
prtx::DecoderFactory Class Reference

#include <DecoderFactory.h>

Inheritance diagram for prtx::DecoderFactory:
[legend]

Public Types

enum  EmbeddedResources {
  ER_NO,
  ER_CAN_HANDLE
}
 

Public Member Functions

virtual bool canHandleURI (prtx::URIPtr uri) const override
 
prt::DecoderInfocreateDecoderInfo () const
 
 DecoderFactory (prt::ContentType type, const std::wstring &id, const std::wstring &name, const std::wstring &desc, const FileExtensions &exts=FileExtensions(), const char *icon=0, EmbeddedResources canHandleER=ER_NO)
 
virtual prtx::Extension::ExtensionType getExtensionType () const final override
 
- Public Member Functions inherited from prtx::ExtensionFactory
virtual Extensioncreate () const =0
 
 ExtensionFactory (const ExtensionFactory &)=delete
 
virtual prt::ContentType getContentType () const =0
 
virtual const std::wstring & getDescription () const =0
 
virtual const std::wstring & getID () const =0
 
virtual float getMerit () const
 
virtual const std::wstring & getName () const =0
 
ExtensionFactoryoperator= (const ExtensionFactory &)=delete
 

Protected Attributes

DecoderInfoImpl * mInfo {nullptr}
 

Additional Inherited Members

- Static Public Member Functions inherited from prtx::ExtensionFactory
static float getDefaultMerit ()
 

Detailed Description

This is the base class for all decoder factories. A subclass may want to override getMerit() to control the resolve order of multiple decoders with the same type and id.

Member Enumeration Documentation

◆ EmbeddedResources

Enumerator
ER_NO 

Decoder or the underlying format does not have support for embedded resources.

ER_CAN_HANDLE 

Format has embedded resources, and Decoder can handle it.

Constructor & Destructor Documentation

◆ DecoderFactory()

prtx::DecoderFactory::DecoderFactory ( prt::ContentType  type,
const std::wstring &  id,
const std::wstring &  name,
const std::wstring &  desc,
const FileExtensions exts = FileExtensions(),
const char *  icon = 0,
EmbeddedResources  canHandleER = ER_NO 
)
Parameters
[in]typeThe content type of this extension.
[in]idThe ID of this extension.
[in]nameA human-readable name of this extension.
[in]descA human-readable description of this extension.
[in]extsSupported file extensions of this extension.
[in]iconAn icon as Base64-encoded PNG byte array.
[in]canHandleERER_CAN_HANDLE if the associated decoder can handle embedded resources.

Member Function Documentation

◆ canHandleURI()

virtual bool prtx::DecoderFactory::canHandleURI ( prtx::URIPtr  uri) const
overridevirtual

Returns true, if the URI matches one of the registered file extensions.

Implements prtx::ExtensionFactory.

◆ createDecoderInfo()

prt::DecoderInfo* prtx::DecoderFactory::createDecoderInfo ( ) const

Returns a new instance of the corresponding decoder information. Must be destroyed by the client.

◆ getExtensionType()

virtual prtx::Extension::ExtensionType prtx::DecoderFactory::getExtensionType ( ) const
inlinefinaloverridevirtual

Fixates the extension type to prtx::Extension::ET_DECODER;

Returns
Always returns prtx::Extension::ET_DECODER.

Implements prtx::ExtensionFactory.


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