EncoderInfo.h

/*
  COPYRIGHT (c) 2012-2024 Esri R&D Center Zurich
  TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
  Unpublished material - all rights reserved under the
  Copyright Laws of the United States and applicable international
  laws, treaties, and conventions.

  For additional information, contact:
  Environmental Systems Research Institute, Inc.
  Attn: Contracts and Legal Services Department
  380 New York Street
  Redlands, California, 92373
  USA

  email: contracts@esri.com
*/

#ifndef PRT_ENCODERINFO_H_
#define PRT_ENCODERINFO_H_

#include "prt/prt.h"
#include "prt/ContentType.h"
#include "prt/Object.h"
#include "prt/AttributeMap.h"
#include "prt/Annotation.h"


namespace prt {


class PRT_EXPORTS_API EncoderInfo : public Object {
public:
    enum OptionState {
        OS_ENABLED,     
        OS_DISABLED,    
        OS_HIDDEN       
    };

public:

    virtual const wchar_t* getID(Status* status = 0) const = 0;

    virtual const wchar_t* getName(Status* status = 0) const = 0;

    virtual const wchar_t* getDescription(Status* status = 0) const = 0;

    virtual ContentType getType(Status* status = 0) const = 0;

    virtual const wchar_t* getExtensions(Status* status = 0) const = 0;

    virtual double getMerit(Status* status = 0) const = 0;

    virtual const char* const* getIconsBase64(size_t* iconsCount, Status* status  = 0) const = 0;

    virtual Status createValidatedOptionsAndStates(
            const AttributeMap* optionsIn,
            const AttributeMap** optionsOut,
            const AttributeMap** statesOut = nullptr
    ) const = 0;

    virtual const wchar_t* const* getOptionKeys(size_t* count, Status* status = 0) const = 0;

    virtual const wchar_t* const* getInitialShapeAttributeKeys(size_t* count, Status* status = 0) const = 0;

    virtual AttributeMap::PrimitiveType getType(const wchar_t* key, Status* status = 0) const = 0;

    virtual size_t getNumAnnotations(const wchar_t* key, Status* status = 0) const = 0;

    virtual const Annotation* getAnnotation(const wchar_t* key, size_t i, Status* status = 0) const = 0;

protected:
    EncoderInfo() { }
    EncoderInfo(const EncoderInfo&) : prt::Object() { };
    virtual ~EncoderInfo() { }
};


} /* namespace prt */


#endif /* PRT_ENCODERINFO_H_ */