PRM_KeyValueDictDataItem.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        PRM_KeyValueDictDataItem.h (PRM Library, C++)
 *
 * COMMENTS:    Represents a key-value dictionary (string keys and values) in a
 *              parameter.
 */

#ifndef __PRM_KeyValueDictDataItem__
#define __PRM_KeyValueDictDataItem__

#include "PRM_API.h"
#include "PRM_Parm.h"
#include "PRM_Type.h"

class UT_JSONValueMap;

class PRM_API PRM_KeyValueDictDataItem : public PRM_DataItem
{
public:
    PRM_KeyValueDictDataItem();
    explicit PRM_KeyValueDictDataItem(UT_JSONValueMap *key_value_dict);
    ~PRM_KeyValueDictDataItem() override;

    PRM_Type::PRM_DataType getDataType() const override 
        { return PRM_Type::PRM_DATA_KEY_VALUE_DICT; }
    const char *getDataTypeToken() const override { return "key_value_dict"; }

    bool saveAscii(std::ostream &os) const override;
    bool saveBinary(std::ostream &os) const override;

    int64 getMemoryUsage() const override
    {
        return sizeof(*this);
    }

    // Data accessor.
    UT_JSONValueMap *getKeyValueDict() const override;

private:
    UT_JSONValueMap *myKeyValueDict;
};

#endif