PDG_Event.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_EVENT_H__
#define __PDG_EVENT_H__

#include "PDG_API.h"

#include "PDG_Types.h"
#include "PDG_WorkItem.h"
#include "PDG_WorkItemStats.h"

#include <UT/UT_StringHolder.h>

class PDG_GraphContext;
class PDG_Node;
class PDG_ServiceManager;
class PDG_Scheduler;

class PDG_API PDG_Event
{
public:
    PDG_Event();
    PDG_Event(const PDG_Event& event);
    PDG_Event& operator = (const PDG_Event& event);
    PDG_Event(PDG_EventType type,
              PDG_GraphContext* context,
              const PDG_Node* node = nullptr,
              const PDG_Node* node2 = nullptr,
              const PDG_Scheduler* scheduler = nullptr,
              PDG_WorkItemID work_item_id = PDG_WorkItem::theInvalidId,
              PDG_WorkItemID dependency_id = PDG_WorkItem::theInvalidId,
              PDG_WorkItemState current_state = PDG_WorkItemState::eUndefined,
              PDG_WorkItemState last_state = PDG_WorkItemState::eUndefined,
              const UT_StringHolder& message = "",
              PDG_WorkItemStats stats = PDG_WorkItemStats());

    PDG_Event(PDG_EventType type,
              PDG_GraphContext *context,
              const PDG_Node *node,
              PDG_WorkItemID work_item_id,
              const UT_StringHolder &attrName = "");

    PDG_Event(PDG_EventType type,
              PDG_GraphContext* context,
              const PDG_Node* node,
              const UT_StringHolder& oldName,
              const UT_StringHolder& newName);

    PDG_Event(PDG_EventType type,
              PDG_ServiceManager* sm);

    PDG_Event(PDG_EventType type,
              PDG_ServiceManager* sm,
              const UT_StringHolder& serviceName);

    PDG_Event(PDG_EventType type,
              PDG_ServiceManager* sm,
              const UT_StringHolder& serviceName,
              const UT_StringHolder& serviceClient);

    PDG_Event(PDG_EventType type, const PDG_WorkItemIDArray& workItemArray);

    // Helpers for creating events, I'd like it to be replaced by children
    // classes constructors in the future
    // Not a pleasant sight here, but it makes the code actually emitting
    // events much more readable
    static PDG_Event            NodeCreate(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node);
    static PDG_Event            NodeRemove(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node);

    static PDG_Event            NodeConnect(
                                    PDG_GraphContext *context,
                                    const PDG_Node* input,
                                    const PDG_Node* output);
    static PDG_Event            NodeDisconnect(
                                    PDG_GraphContext *context,
                                    const PDG_Node* input,
                                    const PDG_Node* output);
    static PDG_Event            NodeFirstCook(
                                    PDG_GraphContext *context,
                                    const PDG_Node* node);

    static PDG_Event            NodeGenerated(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node);
    static PDG_Event            NodeCooked(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node);

    static PDG_Event            DirtyStart(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node);
    static PDG_Event            DirtyStop(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node);
    static PDG_Event            DirtyAll(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node = nullptr);
    static PDG_Event            NodeClear(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node);

    static PDG_Event            CookError(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    const UT_StringHolder &message);
    static PDG_Event            CookWarning(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    const UT_StringHolder &message);

    static PDG_Event            WorkItemRemove(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID work_item_id,
                                    PDG_WorkItemState currentState);

    static PDG_Event            CookStart(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node);
    static PDG_Event            CookComplete(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node);

    static PDG_Event            CookError(
                                    PDG_GraphContext *context,
                                    const PDG_Scheduler *scheduler,
                                    const UT_StringHolder &message);
    static PDG_Event            CookWarning(
                                    PDG_GraphContext *context,
                                    const PDG_Scheduler *scheduler,
                                    const UT_StringHolder &message);

    static PDG_Event            WorkItemAddDep(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID id,
                                    PDG_WorkItemID depId);
    static PDG_Event            WorkItemRemoveDep(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID id,
                                    PDG_WorkItemID depId);

    static PDG_Event            WorkItemCookPercentUpdate(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID id);

    static PDG_Event            WorkItemStateChange(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID id,
                                    PDG_WorkItemState old_state,
                                    PDG_WorkItemState new_state);
    static PDG_Event            WorkItemAdd(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID id);
    
    static PDG_Event            UISelect(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID id);

    static PDG_Event            SetIntData(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID work_item_id,
                                    const UT_StringHolder &attrName);
    static PDG_Event            SetFloatData(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID work_item_id,
                                    const UT_StringHolder &attrName);
    static PDG_Event            SetStringData(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID work_item_id,
                                    const UT_StringHolder &attrName);

    static PDG_Event            MergeData(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID work_item_id);
    static PDG_Event            OutputFiles(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID work_item_id);

    static PDG_Event            WorkItemPriority(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    PDG_WorkItemID work_item_id);

    static PDG_Event            NodeProgressUpdate(
                                    PDG_GraphContext* context,
                                    const PDG_Node* node);

    static PDG_Event            NodeRename(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    const UT_StringHolder &oldName,
                                    const UT_StringHolder &newName);

    static PDG_Event            SchedulerAdded(
                                    PDG_GraphContext *context,
                                    const PDG_Scheduler *scheduler);
    static PDG_Event            SchedulerRemoved(
                                    PDG_GraphContext *context,
                                    const PDG_Scheduler *scheduler);
    static PDG_Event            SetScheduler(
                                    PDG_GraphContext *context,
                                    const PDG_Node *node,
                                    const PDG_Scheduler *scheduler);

    static PDG_Event            ServiceManagerAll(PDG_ServiceManager *sm);
    static PDG_Event            ServiceStartBegin(
                                    PDG_ServiceManager *sm,
                                    const UT_StringHolder& service_name);
    static PDG_Event            ServiceStartEnd(
                                    PDG_ServiceManager *sm,
                                    const UT_StringHolder& service_name);
    static PDG_Event            ServiceClientStarted(
                                    PDG_ServiceManager *sm,
                                    const UT_StringHolder& service_name,
                                    const UT_StringHolder& client_name);
    static PDG_Event            ServiceClientChanged(
                                    PDG_ServiceManager *sm,
                                    const UT_StringHolder& service_name,
                                    const UT_StringHolder& client_name);

    static PDG_Event            BatchWorkItemInitialized(
                                    const PDG_WorkItemIDArray& workItemArray);

public:
    PDG_EventType               type() const
                                    { return myType; }
    PDG_GraphContext*           context() const
                                    { return myContext; }
    PDG_ServiceManager*         serviceManager() const
                                    { return myServiceManager; }

    PDG_Node*                   node() const;
    PDG_Node*                   node2() const;
    PDG_Scheduler*              scheduler() const;

    PDG_WorkItemID              workItemId() const
                                    { return myWorkItemId; }
    PDG_WorkItemID              dependencyId() const
                                    { return myDependencyId; }

    PDG_WorkItemState           currentState() const
                                    { return myCurrentState; }
    PDG_WorkItemState           lastState() const
                                    { return myLastState; }
    const UT_StringHolder&      message() const
                                    { return myMessage; }
    const PDG_WorkItemStats&    stats() const
                                    { return myStats; }

    const UT_StringHolder&      attrName() const
                                    { return myAttrName; }

    const UT_StringHolder&      oldName() const
                                    { return myOldName; }
    const UT_StringHolder&      newName() const
                                    { return myNewName; }

    const UT_StringHolder&      serviceName() const
                                    { return myServiceName; }
    const UT_StringHolder&      serviceClientName() const
                                    { return myServiceClientName; }

    const PDG_WorkItemIDArray&  workItemArray() const
                                    { return myWorkItemArray; }

    int                         nodeId() const
                                    { return myNode; }
    int                         node2Id() const
                                    { return myNode2; }
    const UT_StringHolder&      schedulerName() const
                                    { return myScheduler; }

#if PDG_EVENT_QUEUE_DEBUG
    UT_StringHolder             toString() const;
#endif

private:
    PDG_EventType               myType = PDG_EventType::PDG_EVENT_NULL;

    PDG_GraphContext*           myContext = nullptr;
    int                         myNode = -1;
    int                         myNode2 = -1;
    UT_StringHolder             myScheduler;

    PDG_ServiceManager*         myServiceManager = nullptr;
    UT_StringHolder             myServiceName;
    UT_StringHolder             myServiceClientName;

    UT_StringHolder             myMessage;

    PDG_WorkItemID              myWorkItemId = PDG_WorkItem::theInvalidId;
    PDG_WorkItemID              myDependencyId = PDG_WorkItem::theInvalidId;

    PDG_WorkItemState           myCurrentState = PDG_WorkItemState::eUndefined;
    PDG_WorkItemState           myLastState = PDG_WorkItemState::eUndefined;

    PDG_WorkItemStats           myStats;

    UT_StringHolder             myAttrName;

    UT_StringHolder             myOldName;
    UT_StringHolder             myNewName;

    PDG_WorkItemIDArray         myWorkItemArray;
};

#endif