PDG_AttributeClassify.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_ATTRIBUTE_CLASSIFY_H__
#define __PDG_ATTRIBUTE_CLASSIFY_H__

#include "PDG_API.h"

#include "PDG_WorkItemTypes.h"

#include <UT/UT_Array.h>
#include <UT/UT_ArrayMap.h>
#include <UT/UT_VectorTypes.h>
#include <UT/UT_WorkBuffer.h>

#include <SYS/SYS_Hash.h>

class PDG_WorkItem;

class UT_StringArray;

/*
 * Groups work items into separate classes based on their attributes
 */
class PDG_API PDG_AttributeClassify
{
public:
    /// A map of attribute hash to the work items that match that particular
    /// class.
    using AttributeMap  = UT_ArrayMap<SYS_HashType, PDG_WorkItemIDArray>;

    /// A map of work item ID to the monotonically increasing class numbers
    /// that the work item is a part of
    using ClassMap      = UT_ArrayMap<PDG_WorkItemID, UT_ExintArray>;

public:
    /// Returns the immediate results of classification, as a map of attrib
    /// hash to the matching work items
    const AttributeMap&     classifications() const
                                { return myClassifications; }

    /// Returns the number of unique classifiction keys found from the input
    /// work items
    exint                   numKeys() const
                                { return myClassificationKeys.size(); }

    /// Returns a map of work item ID to class, produced by post-processing the
    /// classification map
    void                    classifications(ClassMap& class_map) const;

    /// Classifies the work item by creating a unique classification for ALL
    /// attribute names. Returns true if the work item has the desired set of
    /// attributes, and false if the work item is missing an attribute.
    bool                    classifyAll(
                                const UT_StringArray& names,
                                const PDG_WorkItem* work_item,
                                bool skip_failures,
                                UT_WorkBuffer& errors);

    /// Classifies the work item by creating a unique classification for EACH
    /// attribute name. Returns true if the work items has the desired set of
    /// attributes, and false if the work items is missing an attribute.
    bool                    classifyEach(
                                const UT_StringArray& names,
                                const PDG_WorkItem* work_item,
                                bool skip_failures,
                                UT_WorkBuffer& errors);

private:
    AttributeMap            myClassifications;
    UT_Array<SYS_HashType>  myClassificationKeys;
};

#endif