ArcGIS Procedural Runtime  3.2.10650
List of all members | Public Member Functions
prt::DecoderInfo Class Referenceabstract

#include <DecoderInfo.h>

Inheritance diagram for prt::DecoderInfo:
[legend]

Public Member Functions

virtual bool canHandleEmbeddedResources (Status *status=0) const =0
 
virtual const wchar_t * getDescription (Status *status=0) const =0
 
virtual const wchar_t * getExtensions (Status *status=0) const =0
 
virtual const char *const * getIconsBase64 (size_t *iconsCount, Status *status=0) const =0
 
virtual const wchar_t * getID (Status *status=0) const =0
 
virtual double getMerit (prt::Status *status=0) const =0
 
virtual const wchar_t * getName (Status *status=0) const =0
 
virtual ContentType getType (Status *status=0) const =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
 

Additional Inherited Members

- Protected Member Functions inherited from prt::Object
 Object (const Object &)
 

Detailed Description

DecoderInfo is used to return static decoder information.

Member Function Documentation

◆ canHandleEmbeddedResources()

virtual bool prt::DecoderInfo::canHandleEmbeddedResources ( Status status = 0) const
pure virtual

Returns true if the corresponding decoder can handle embedded resources (and therefore has a matching ResolveMapProvider).

◆ getDescription()

virtual const wchar_t* prt::DecoderInfo::getDescription ( Status status = 0) const
pure virtual
Parameters
[out]statusOptional pointer to return the status.
Returns
the description of the corresponding decoder.

◆ getExtensions()

virtual const wchar_t* prt::DecoderInfo::getExtensions ( Status status = 0) const
pure virtual
Returns
a ';' separated list of file extensions (with the leading '.') supported by this decoder.

◆ getIconsBase64()

virtual const char* const* prt::DecoderInfo::getIconsBase64 ( size_t *  iconsCount,
Status status = 0 
) const
pure virtual
Parameters
iconsCountNumber of returned icons
[out]statusOptional pointer to return the status.
Returns
the decoder icon as base64-encoded PNG.

◆ getID()

virtual const wchar_t* prt::DecoderInfo::getID ( Status status = 0) const
pure virtual
Parameters
[out]statusOptional pointer to return the status.
Returns
the ID of the corresponding decoder.

◆ getMerit()

virtual double prt::DecoderInfo::getMerit ( prt::Status status = 0) const
pure virtual
Parameters
[out]statusOptional pointer to return the status.
Returns
the Merit of this encoder. Higher has precedence.

◆ getName()

virtual const wchar_t* prt::DecoderInfo::getName ( Status status = 0) const
pure virtual
Parameters
[out]statusOptional pointer to return the status.
Returns
the name of the corresponding decoder.

◆ getType()

virtual ContentType prt::DecoderInfo::getType ( Status status = 0) const
pure virtual
Parameters
[out]statusOptional pointer to return the status.
Returns
the content type this encoder can encode.

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