DDD_AssetFactory.h

Go to the documentation of this file.

#ifndef _DDD_AssetFactory_h_
#define _DDD_AssetFactory_h_

/*! \file DDD_AssetFactory.h

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#include "DDD_DynamicLibrary.h"
#include "DDD_AssetBase.h"
#include "DDD_StringList.h"
#include "DDD_LogFacade.h"

namespace disti
{
class DDD_AssetLibrary;

/**  \brief  The DDD_AssetFactory class.  Factory for creating Data Director assets.
    */
class DDD_EXPORT DDD_AssetFactory : public DDD_LogFacade
{
private:

    typedef DynamicPtrArray<DDD_AssetLibrary*> AssetLibraryList;

    AssetLibraryList _loadedLibs;  /**< List of loaded asset libraries */

    /** Constructor.  Only the static Instance() interface can create this */
    DDD_AssetFactory();

    /** Intalls the built-in assets into the factory */
    void InstallBuiltInAssets();

public:

    /** Public interface to the singleton 
      * \return Returns a pointer to the singleton instance 
      */
    static DDD_AssetFactory& Instance();

    /** Creates a new asset of the requested type
      * \param className The name of the asset class to instantiate
      * \param container  The container that owns the asset
      * \return Returns a pointer to instantiated asset, or null if asset cannot be instantiated
      */
    DDD_AssetBase* InstantiateNewAsset(const std::string& className,DDD_AssetContainer *container); 

    /** Load the library file for the particular asset and install it in the factory
      * \param className   The class name of the asset
      * \param libFileName The name of the DLL/.SO file that has the creator function
      * \return True if the class was successfully installed in the factory
      */
    bool FindAsset(const std::string& className, std::string libFileName);

    /** \return Returns a list of known asset types that the factory can create
      */
    DDD_StringList GetKnownAssetTypes();
};


}   // end namespace disti


#endif