PDG_DependencyHolder.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_DEPENDENCY_HOLDER_H__
#define __PDG_DEPENDENCY_HOLDER_H__

#include "PDG_API.h"
#include "PDG_Types.h"

#include <UT/UT_Array.h>

class PDG_WorkItem;
class UT_WorkBuffer;

/**
 * Factory object for adding dependency pairs between work items. Used for
 * mapping and for adding sibling dependencies.
 * */
class PDG_API PDG_DependencyHolder
{

public:
                            PDG_DependencyHolder();
                            PDG_DependencyHolder(
                                    const PDG_WorkItemSet& valid);
                            PDG_DependencyHolder(
                                    const PDG_WorkItemArray& valid);

    bool                    addDependency(
                                    PDG_WorkItem* dependent,
                                    PDG_WorkItem* dependency,
                                    UT_WorkBuffer& errors);
    const PDG_WorkItemPairArray&
                            dependencyPairs() const
                                { return myDependencyPairs; }

protected:
    bool                    isValid(PDG_WorkItem* work_item) const;

    PDG_WorkItemPairArray   myDependencyPairs;
    PDG_WorkItemSet         myValidSet;
};

#endif