PDG_WorkItemData.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.
 *
 * COMMENTS:
 */

#ifndef __PDG_WORK_ITEM_DATA_H__
#define __PDG_WORK_ITEM_DATA_H__

#include "PDG_API.h"

#include "PDG_AttributeMap.h"
#include "PDG_RegisteredType.h"
#include "PDG_WorkItemTypes.h"

#include <UT/UT_StringHolder.h>

class UT_JSONValue;
class UT_JSONWriter;

class PDG_Scheduler;
class PDG_TypeRegistry;
class PDG_WorkItem;

class PDG_API PDG_WorkItemData : public PDG_TypeInstance
{    
public:
    static void             registerTypes(PDG_TypeRegistry* registry);

                            PDG_WorkItemData();
                            PDG_WorkItemData(const PDG_BaseType* base_type,
                                             const PDGT_ValueArgs& extra_args);
                            ~PDG_WorkItemData() override;

    int64                   getMemoryUsage(bool inclusive) const override;

    virtual UT_StringHolder serialize(const PDG_WorkItem*,
                                      const PDG_Scheduler*) const;
    virtual bool            deserialize(const UT_StringHolder& str);
    virtual bool            serializeToFile(const UT_StringHolder&,
                                            const PDG_WorkItem*,
                                            const PDG_Scheduler*) const
    {
        return false;
    }
    bool                    load(const UT_JSONValue& json_val);

    virtual void            clone(const PDG_WorkItemData* data);
    virtual bool            compare(PDG_WorkItemData* item) const
    {
        return this == item;
    }

    void                    setWorkItem(PDG_WorkItem* work_item);
    PDG_WorkItem*           workItem();

    virtual bool            setFloat(const UT_StringHolder& name,
                                     fpreal data,
                                     int index);
    bool                    setFloatArray(const UT_StringHolder& name,
                                          const PDG_AttributeFloat::Array& data);

    virtual bool            setInt(const UT_StringHolder& name,
                                   int data,
                                   int index);
    bool                    setIntArray(const UT_StringHolder& name,
                                        const PDG_AttributeInteger::Array& data);

    virtual bool            setString(const UT_StringHolder& name,
                                      const UT_StringHolder& data,
                                      int index);
    bool                    setStringArray(const UT_StringHolder& name,
                                           const PDG_AttributeString::Array& data);

    virtual bool            floatData(fpreal& param,
                                      const UT_StringHolder& name,
                                      int index) const;
    virtual bool            floatData(PDG_AttributeFloat::Map& params) const;
    bool                    floatData(PDG_AttributeFloat::Array& param,
                                      const UT_StringHolder& name) const;

    virtual bool            intData(exint& param,
                                    const UT_StringHolder& name,
                                    int index) const;
    virtual bool            intData(PDG_AttributeInteger::Map& params) const;
    bool                    intData(PDG_AttributeInteger::Array& param,
                                    const UT_StringHolder& name) const;

    virtual bool            stringData(UT_StringHolder& param,
                                       const UT_StringHolder& name,
                                       int index) const;
    virtual bool            stringData(PDG_AttributeString::Map& params) const;
    bool                    stringData(PDG_AttributeString::Array& param,
                                       const UT_StringHolder& name) const;

    virtual bool            clearFloatData();
    virtual bool            clearIntData();
    virtual bool            clearStringData();
    virtual bool            removeData(const UT_StringHolder& name, int index);

    virtual bool            cook()
    {
        return false;
    }

private:
    bool                    save(UT_JSONWriter& writer) const;

private:
    PDG_WorkItem*           myWorkItem;
};

#endif /* __PDG_WORK_ITEM_DATA_H__ */