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

#ifndef __UN_Handle_h__
#define __UN_Handle_h__


#include "UN_API.h"
#include "UN_Types.h"

class UN_GraphData;


// ============================================================================
/// Data class that is basis for many data classes.
/// It factors out the behavious of a data object inside a data container.

// Note, no UN_API because all methods are defined in the header.
class UN_Handle
{
public:
    /// Convenience constructor.
    UN_Handle( UN_GraphData *graph_data, 
            UN_DataIndex data_index, 
            UN_DataID data_id )
        : myGraphData( graph_data )
        , myDataIndex( data_index )
        , myDataID( data_id )
        {}

    /// Default constructor.
    UN_Handle() 
        : UN_Handle( nullptr, UN_DataIndex(), UN_DataID() )
        {}

    /// @{ Default destructor, constructors and assignment operators.
                       ~UN_Handle() = default;
                        UN_Handle( const UN_Handle & ) = default;
                        UN_Handle( UN_Handle && ) = default;
                        UN_Handle& operator=( const UN_Handle & ) = default;
                        UN_Handle& operator=( UN_Handle && ) = default;
    /// @}

    /// @{ Comparison operators
    bool                operator==( const UN_Handle &other ) const
                            { 
                                return myGraphData == other.myGraphData 
                                    && myDataIndex == other.myDataIndex
                                    && myDataID    == other.myDataID; 
                            }

    bool                operator!=( const UN_Handle &other ) const
                            {   
                                return !( *this == other ); 
                            }

    /// @}

    /// Index identifying the data object within the owner graph.
    /// Note, a data object may reuse space from previously deleted data object,
    /// and thus share the same data index into the data container.
    UN_DataIndex        dataIndex() const
                            { return myDataIndex; }

    /// The unique ID of a data object during the lifespan of the owner graph.
    UN_DataID           dataID() const
                            { return myDataID; }

protected:
    /// The graph data struct that owns, manages, and operates on data object.
    /// Returning a non-const pointer from const method, since the
    /// derived classes have const methods that operate on non-const graph.
    UN_GraphData *      graphData() const
                            { return myGraphData; }

private:
    /// The graph that owns, manages, and operates on data object.
    UN_GraphData *      myGraphData;

    /// Index identifying the data object within the graph above.
    /// Note, a data object may reuse space from previously deleted data object,
    /// and thus share the same data index into the data container.
    UN_DataIndex        myDataIndex;

    /// The unique identification number of a data object during the lifespan
    /// of the graph above, used for detecting and verifying that
    /// the data object has not been deleted.
    UN_DataID           myDataID;
};


#endif