Attributable.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_ATTRIBUTABLE_H_
#define PRT_ATTRIBUTABLE_H_

#include "prt/prt.h"
#include "prt/Status.h"

#include <cstddef>
#include <cstdint>


namespace prt {


class PRT_EXPORTS_API Attributable {
public:

    enum PrimitiveType {
        PT_UNDEFINED,           
        PT_STRING,              
        PT_FLOAT,               
        PT_BOOL,                
        PT_INT,                 
        PT_STRING_ARRAY,        
        PT_FLOAT_ARRAY,         
        PT_BOOL_ARRAY,          
        PT_INT_ARRAY,           
        PT_BLIND_DATA,          
        PT_BLIND_DATA_ARRAY,    
        PT_COUNT                
    };

    virtual const wchar_t* const*   getKeys         (size_t* count, Status* stat = 0) const = 0;

    virtual bool            hasKey          (const wchar_t* key, Status* stat = 0) const = 0;

    virtual PrimitiveType   getType         (const wchar_t* key, Status* stat = 0) const = 0;

    virtual bool            getBool         (const wchar_t* key, Status* stat = 0) const = 0;

    virtual int32_t         getInt          (const wchar_t* key, Status* stat = 0) const = 0;

    virtual double          getFloat        (const wchar_t* key, Status* stat = 0) const = 0;

    virtual const wchar_t*  getString       (const wchar_t* key, Status* stat = 0) const = 0;

    virtual const bool*     getBoolArray    (const wchar_t* key, size_t* count, Status* stat = 0) const = 0;

    virtual const int32_t*  getIntArray     (const wchar_t* key, size_t* count, Status* stat = 0) const = 0;

    virtual const double*   getFloatArray   (const wchar_t* key, size_t* count, Status* stat = 0) const = 0;

    virtual const wchar_t* const*   getStringArray  (const wchar_t* key, size_t* count, Status* stat = 0) const = 0;

protected:
    Attributable() { }
    virtual ~Attributable() { }
};


class PRT_EXPORTS_API AttributableSetter {
public:

    virtual Status              setBool         (const wchar_t* key, bool               value) = 0;

    virtual Status              setInt          (const wchar_t* key, int32_t            value) = 0;

    virtual Status              setFloat        (const wchar_t* key, double             value) = 0;

    virtual Status              setString       (const wchar_t* key, const wchar_t*     value) = 0;

    virtual Status              setBoolArray    (const wchar_t* key, const bool*        value, size_t count) = 0;

    virtual Status              setIntArray     (const wchar_t* key, const int32_t*     value, size_t count) = 0;

    virtual Status              setFloatArray   (const wchar_t* key, const double*      value, size_t count) = 0;

    virtual Status              setStringArray  (const wchar_t* key, const wchar_t* const* value, size_t count) = 0;

protected:
    AttributableSetter() { }
    virtual ~AttributableSetter() { }
};


} // namespace


#endif /* PRT_ATTRIBUTABLE_H_ */