UN_WireUtils.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.
 *
 * NAME:        UN_WireUtils.h ( UN Library, C++)
 *
 * COMMENTS:
 *      
 */

#ifndef __UN_WireUtils_h__
#define __UN_WireUtils_h__


#include "UN_API.h"
#include "UN_GraphData.h"


namespace UN_WireUtils
{
    /// Returns true if the wire by the given ID is valid in the given graph.
    static inline bool
    isValid( const UN_GraphData *graph_data, UN_WireID wire_id )
    {
        return graph_data && graph_data->isValid( wire_id );
    }

    /// Returns the source port of this wire.
    /// Ie, port that produces and sends the data.
    static inline UN_PortID
    srcPort( const UN_GraphData *graph_data, UN_WireID wire_id )
    {
        return graph_data ? graph_data->srcPort( wire_id ) : UN_PortID();
    }

    /// Returns the destination port of this wire.
    /// Ie, port that receives and consumes the data.
    static inline UN_PortID
    dstPort( const UN_GraphData *graph_data, UN_WireID wire_id )
    {
        return graph_data ? graph_data->dstPort( wire_id ) : UN_PortID();
    }

    /// Returns the source node of this wire.
    /// Ie, a node that produces and sends the data.
    static inline UN_NodeID
    srcNode( const UN_GraphData *graph_data, UN_WireID wire_id )
    {
        auto port = graph_data ? graph_data->srcPort( wire_id ) : UN_PortID();
        return port ? graph_data->node( port ) : UN_NodeID();
    }

    /// Returns the destination node of this wire.
    /// Ie, a node that receives and consumes the data.
    static inline UN_NodeID
    dstNode( const UN_GraphData *graph_data, UN_WireID wire_id )
    {
        auto port = graph_data ? graph_data->dstPort( wire_id ) : UN_PortID();
        return port ? graph_data->node( port ) : UN_NodeID();
    }
}

#endif