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

#ifndef __UN_GraphContext_h__
#define __UN_GraphContext_h__

#include "UN_API.h"
#include "UN_GraphConfig.h"
#include <UT/UT_StringArray.h>

class UN_UniCategory;
class UNI_Manager;

// ============================================================================
/// The graph context class, representing a specific use case for the graph.
/// It provides specific values for the configurable behaviours of the graph,
/// like alphanumeric validity and uniqueness of the nodes in the graph,
/// and also supplies the graph with concrete node and data types to operate on.

class UN_API UN_GraphContext
{
public:
    /// @{ Constructor and destructor
    /// @param  graph_config    Object that describes the graph's capabilities.
    /// @param  root_type_name  The node type name that should be used for the
    ///                         root node of this graph.
    /// @param  manager         Object that manages types.
    ///                         If given, it should outlive the context.
    UN_GraphContext(UN_GraphConfig graph_config = UN_GraphConfig(),
            const UT_StringHolder &root_type_name = UT_StringHolder(),
            UNI_Manager *manager = nullptr);
    /// @}

    /// Comparison operator.
    bool    operator==( const UN_GraphContext &other ) const;

    /// Returns the node type to be used for the root of this graph.
    const UT_StringHolder &     rootTypeName() const
    { return myRootTypeName; }

    /// Returns the configuration options for the graph in this context.
    const UN_GraphConfig &      graphConfig() const
    { return myGraphConfig; }

    /// Returns the configuration options for the graph in this context.
    const UNI_Manager *         manager() const
    { return myManager; }

private:
    /// Graph configuration settings.
    UN_GraphConfig           myGraphConfig;

    /// The name of the node type for the root node (from the UNI_Manager's
    /// UNI_ROOT_CATEGORY node type category).
    UT_StringHolder          myRootTypeName;

    /// Manager of node type categories.
    UNI_Manager             *myManager;
};


#endif