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

#ifndef __UNI_Wire_h__
#define __UNI_Wire_h__

#include "UNI_API.h"
#include "UNI_Item.h"

// ============================================================================
class UNI_ConstWire : public UNI_ConstItem<UNI_WireID>
{
public:
    /// Expose base class constructors.
    using UNI_ConstItem::UNI_ConstItem;

    /// Returns the source end of the wire.
    UNI_PortID          src() const
    { return graph() ? graph()->srcPort( id() ) : UNI_PortID(); }

    /// Returns the destination end of the wire.
    UNI_PortID          dst() const
    { return graph() ? graph()->dstPort( id() ) : UNI_PortID(); }
};


// ============================================================================
class UNI_API UNI_Wire : public UNI_Item<UNI_WireID,
                                         UNI_SessionWireID,
                                         UNI_ConstWire>
{
public:
    /// Expose base class constructors.
    using UNI_Item::UNI_Item;

    /// Removes this wire from the graph.
    void                destroy();
};

#endif