PDG_RegisteredType.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.
 *
 * COMMENTS:
 */

#ifndef __PDG_REGISTERED_TYPE_H__
#define __PDG_REGISTERED_TYPE_H__

#include "PDG_API.h"

#include <PDGT/PDGT_BaseType.h>
#include <PDGT/PDGT_RegisteredType.h>
#include <PDGT/PDGT_TypeInstance.h>

/// Enumeration of entities that can be registered with PDG_TypeRegistry
enum class PDG_RegistrationType
{
    /// Custom external dependency
    eDependency,

    /// Custom node definition
    eNode,

    /// Custom scheduler definition
    eScheduler,

    /// Custom work item data definition
    eWorkItem,

    /// Custom service defintion
    eService,

    eCount
};

/// Base type for types registered using PDG_TypeRegistry
using PDG_BaseType = PDGT_BaseType<PDG_RegistrationType>;

/// Specialization type which encapsulates the produced class and
/// construction args, for a type registered in the registry
template <typename Class,
          typename Pointer,
          PDG_RegistrationType type,
          typename... Args>
using PDG_RegisteredType = PDGT_RegisteredType<
    Class, Pointer, PDG_RegistrationType, type, Args...>;

/// Base class for a concrete instance of a type created by the
/// registry
using PDG_TypeInstance = PDGT_TypeInstance<PDG_RegistrationType>;

#ifdef WIN32
/// Explicit instantiate for base type, to avoid linker errors on windows
template class PDG_API PDGT_BaseType<PDG_RegistrationType>;
#endif

#endif