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

#ifndef __UN_Wire_h__
#define __UN_Wire_h__

#include "UN_API.h"
#include "UN_Handle.h"

class UN_Graph;
class UN_Port;


// ============================================================================
/// A light-weight handle for a wire that connects two ports together.
/// 
/// The actual wire data (UN_WireData) is owned and managed by UN_GraphData,
/// and UN_Wire serves as a handle for the client to refer to that data.

class UN_API UN_Wire : public UN_Handle
{
public:
    /// Convenience constructor for the wire handle.
                 UN_Wire( UN_GraphData *graph_data,
                          UN_WireIndex wire_index,
                          UN_WireID wire_id );

    /// @{ Default constructors and assignment operators.
                 UN_Wire();
                ~UN_Wire();
                 UN_Wire( const UN_Wire& other );
                 UN_Wire( UN_Wire&& other );
    UN_Wire &    operator=( const UN_Wire& other );
    UN_Wire &    operator=( UN_Wire&& other );
    /// @}

    /// @{ Returns true if this is a valid wire; false otherwise.
    bool                isValid() const;
    explicit operator   bool() const
                            { return isValid(); }
    /// @}

    /// @{ Comparison operators
    bool                operator==( const UN_Wire &other ) const
                            { return UN_Handle::operator==( other ); }
    bool                operator!=( const UN_Wire &other ) const
                            { return UN_Handle::operator!=( other ); }
    /// @}


    /// Returns the owner graph of this wire.
    UN_Graph            graph() const;

    /// Returns the source port of this wire.
    /// (ie, port that produces and sends the data).
    UN_Port             sourcePort() const;

    /// Returns the destination port of this wire.
    /// (ie, port that receives and consumes the data).
    UN_Port             destinationPort() const;


    /// Returns the wire data index this handle refers to.
    UN_WireIndex        wireIndex() const
                            { return UN_WireIndex( dataIndex() ); }

    /// Returns the unique ID of the wire data this handle refers to.
    UN_WireID           wireID() const
                            { return UN_WireID( dataID() ); }
};

#endif