PDG_Mapper.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_MAPPER_H__
#define __PDG_MAPPER_H__

#include "PDG_API.h"
#include "PDG_Node.h"

/**
 * PDG_Node subclass that implements mapper-specific logic. This node can
 * establish dependencies between upstream items and downstream static items.
 */
class PDG_API PDG_Mapper : public PDG_Node
{    
public:
    using PDG_Node::PDG_Node;

    ~PDG_Mapper() override {}

    /// Returns the total memory usage of the node, including any work items
    /// owned by it.
    void                    memoryInfo(PDG_MemoryInfo& memory_info,
                                       bool inclusive) const override;

    /// Adds dependencies on input nodes based on the current generation
    /// settings
    void                    addInputDeps(PDG_Node* input_node) override;

protected:
    /// Sets the loop depth and loop block reference on the node
    int                     preCookLoop(
                                const UT_Array<LoopInfo>& begin_info) override;

    PDGE_Dependency::State  evalResolve(
                                PDGE_Resolutions& resolutions,
                                const PDGE_Evaluator& evaluator,
                                PDGE_Dependency* dependency) override;
};

#endif /* __PDG_MAPPER_H__ */