PDG/PDG_PartitionByParity.C

/*
 * Copyright (c) 2024
 *      Side Effects Software Inc.  All rights reserved.
 *
 * Redistribution and use of Houdini Development Kit samples in source and
 * binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. The name of Side Effects Software may not be used to endorse or
 *    promote products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY SIDE EFFECTS SOFTWARE `AS IS' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
 * NO EVENT SHALL SIDE EFFECTS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *----------------------------------------------------------------------------
 * The Parition by Parity PDG node, which groups work items based on whether
 * or not a particular attribute value is even or odd.
 */

#include "PDG_PartitionByParity.h"

#include <PDG/PDG_AttributeRef.h>
#include <PDG/PDG_AttributeTypes.h>
#include <PDG/PDG_PartitionHolder.h>
#include <PDG/PDG_TypeRegistry.h>
#include <PDG/PDG_WorkItem.h>

#include <UT/UT_DSOVersion.h>

void registerPDGTypes(PDG_TypeRegistry* registry)
{
    PDG_NodeInterface partitioner("partitionbyparity");

    partitioner.addParameter(
        PDGT_Value::eString, "attributename", "Attribute Name");
    registry->registerPartitioner<HDK_Sample::PDG_PartitionByParity>(
        "partitionbyparity", "Partition by Parity", "Partitioners", partitioner);
}

using namespace HDK_Sample;

PDG_CallbackResult
PDG_PartitionByParity::onPartition(
                            PDG_PartitionHolder* holder,
                            const PDG_WorkItemArray& work_items,
                            const PDG_WorkItem* target)
{
    UT_StringHolder attrib_name = evaluateS("attributename");

    UT_WorkBuffer errors;
    for (auto&& work_item : work_items)
    {
        auto&& attrib = work_item->attributes().refRO(attrib_name);
        if (!attrib)
        {
            myNode->addWarningFmt(
                "'{}' has no attribute with the name '{}'",
                work_item->name(), attrib_name);
            continue;
        }

        fpreal value = 0;
        if (attrib.asNumber(value, 0) != PDG_AttributeCast::eSuccess)
        {
            myNode->addWarningFmt(
                "'{}' does not have a numeric value for attribute '{}'",
                work_item->name(), attrib_name);
            continue;
        }

        exint index = ((exint)value % 2 == 0) ? 0 : 1;
        if (!holder->addItemToPartition(work_item, index, false, errors))
        {
            myNode->addError(errors.buffer());
            return PDG_CallbackResult::eFailure;
        }
    }
    
    return PDG_CallbackResult::eSuccess;
}