DDD_DataDirector.h

Go to the documentation of this file.

#ifndef _DDD_DataDirector_h_
#define _DDD_DataDirector_h_

/*! \file DDD_DataDirector.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_AssetBase.h"
#include "DDD_Connection.h"
#include "DDD_XMLConfigMgr.h"
#include "DDD_LogFacade.h"
#include "DDD_ObjectEventSubscriber.h"
#include <string>

#define MAX_PERF_BUFFER_COUNT 16
#define MAX_PERF_BUFFER_SIZE 64

/** \namespace disti
  * Contains DataDirector classes and other DiSTI code.
  */

namespace disti
{
class DDD_DataDirector;

typedef DDD_AssetBase* (*AssetCreateCallback)(void*,const std::string& instance, const std::string& className, const DDD_AttributeList& params,DDD_DataDirector *director);

class AssetCallbackContainer
{
public:
    AssetCreateCallback _assetCreateCb;
    void *_cbData;
    std::string _className;
};

/** Lsit of AssetCreateCallbacks */
typedef  DynamicPtrArray<AssetCallbackContainer *> AssetCreateCallbackList;

class DDD_PerformanceMonitor;

/** \brief DDD_DataDirector.  Main interface to DataDirector core that encapsulates all Assets, Connections and core logic.
  */
class DDD_EXPORT DDD_DataDirector : public XMLConfigTarget, public DDD_AssetObserver, public DDD_AssetContainer
{
    // callbacks from DDD_AssetObserver
    virtual void OnAssetAttributeListDeleted(DDD_AssetBase *asset);
    virtual void OnAssetAttributeListAdded(DDD_AssetBase *asset);

public:
    /** Constructor */
    DDD_DataDirector();

    /** Destructor */
    ~DDD_DataDirector();

    /** Load the Data Director state from an XML configuration file
      * \param filename  The name of the configuration file to load
      * \return Returns True if the configuration was successfully loaded
      */
    bool LoadXML(const std::string &filename);

    /** Save the Data Director state to an XML configuration file
      * \param filename  The name of the configuration file to save to
      * \return Returns True if the configuration was successfully saved
      */
    bool SaveXML(const std::string &filename);

    // XMLConfigTarget Overrides //////////////////////////////
    /** Instantiate an asset and add it to the asset list
      * \param instanceName  The intance name of the new asset
      * \param className     The class name of the new asset
      * \param libName       The library file name of the new asset
      * \param params        A list of initialization parameters for the asset
      * \return  A pointer to the newly added asset or NULL on failure
      */
    DDD_AssetBase* AddAsset(const std::string &instanceName, const std::string &className, const std::string &libName, const DDD_AttributeList& params);

    /** Add a Connection to the connection list
      * \param connection  A connection to add to the connection list
      */
    virtual void AddConnection(DDD_Connection *connection);

    /** \return Returns the connections list */
    virtual DDD_ConnectionList &GetConnectionList();

    /** Remove asset from asset list and also check each connection and invalidates ones that referenced that Asset
      * \param asset A pointer to the asset to remove
      */
    void RemoveAsset(DDD_AssetBase* asset);

    /** Changes asset instance name and also checks connections to make sure any connections that 
      * referenced the asset are updated
      * \param oldAssetName  The old instance name of the asset
      * \param newAssetName  The new instance name of the asset
      * \return true If an asset with the old name was found and if the new name is legal
      */
    bool ChangeAssetInstanceName(const std::string& oldAssetName, const std::string& newAssetName);

    /** Removes a connection from the Director
      * \param connection  The connection to remove
      */
    void RemoveConnection(DDD_Connection *connection);

    /** Registers an asset creation callback for "special" assets (i.e.- RSOs)
      * This callback will be called whenever a new asset is instantiated by the director
      * \param assetCreatorCb Function pointer to the callback
      * \param data           Data to pass to callback
      */
    void RegisterAssetCreateCallback(std::string className, AssetCreateCallback assetCreatorCb, void *data);

    /** Runs the Data Director engine--iterates the assets and pumps connections */
    void Process(); 

    /** Runs the Data Director engine--iterates the assets and pumps connections 
      * \param time  Elapsed time since last call (for when calling process inside of calculate)
      */
    void Process(double time);  

    /** Clears all Assets and Connections- revert to empty configuration */
    void ClearAll();

    /** Starts all assets */
    void StartAllAssets();

    /** stops all assets */
    void StopAllAssets();

    /** Resumes all assets */
    void ResumeAllAssets();

    /** Pauses all assets */
    void PauseAllAssets();

    /** \return Returns true if there are no assets or connections in the director
      */
    bool Empty();

    /** \return Returns version string for compatibility checking of plugins
      */
    static const char* Version();

    /** Moves a connection "UP" in the list, which means it gets moved further towards
      * the end of the list.   
      * \param  connection  The connection to reorder
      * \return True if if the connection was moved, false otherwise
      */
    bool MoveConnectionUp(DDD_Connection* connection);

    /** Moves a connection "DOWN" in the list, which means it gets moved towards the
      * beginning of the list.   
      * \param  connection  The connection to reorder
      * \return True if if the connection was moved, false otherwise
      */    
    bool MoveConnectionDown(DDD_Connection* connection);

    /** Moves a asset "UP" in the list, which means it gets moved further towards
      * the end of the list.   
      * \param  asset  The asset to reorder
      * \return True if if the asset was moved, false otherwise
      */
    bool MoveAssetUp(DDD_AssetBase* asset);

    /** Moves a asset "DOWN" in the list, which means it gets moved towards the
      * beginning of the list.   
      * \param  asset  The asset to reorder
      * \return True if if the asset was moved, false otherwise
      */
    bool MoveAssetDown(DDD_AssetBase* asset);

    /** This method will force every connection to be added to pending connections to be
      * processed regardless whether they had any changed attributes.
      */
    void ForceProcessConnections();

    /** \return Returns the asset list */
    virtual DDD_AssetList &GetAssetList();

    /** Add a new event subscriber to subscriber list
      * \param subscriber  The event subscriber to add
      */
    void AddEventSubscriber(DDD_ObjectEventSubscriber *subscriber);

    /** Remove an event subscriber from the subscriber list
      * \param subscriber  The event subscriber to remove
      */  
    void RemoveEventSubscriber(DDD_ObjectEventSubscriber *subscriber);

    /** Post a new event that will be received by all event subscribers
      * \param event  The object event to post
      */
    void PostEvent(DDD_ObjectEvent *event);

    /** Searches the asset list for an asset with the specified instance name
      * \param assetName  The instance name of the asset to find
      * \return Returns a pointer to the asset or NULL if not found
      */
    DDD_AssetBase* FindAsset(const std::string &assetName);

    /** Searches all instantiated assets for the attribute
      * \param name  The fully qualified name of the attribute to find (e.g. assetName.attribName)
      * \return Returns a pointer to the attribute or NULL if not found
      */
    DDD_AttributeBase *FindAttribute(const std::string &name);

    // End of From DDD_AssetContainer

    static void InitializeGlsLibrary();

private:
    /** called whenever connection orders change */
    void UpdateConnectionNumbers();

private:
    DDD_AssetList _assets;                     /**< The list of assets for this DataDirector instance  */
    DDD_ConnectionList _connections;           /**< The list of assets for this DataDirector instance  */
    AssetCreateCallbackList  _assetCreatorCbs; /**< Callback function to be called when an asset is created */
//    CallbackDataList _cbData;                  /**< Data to pass to callback function when called */
    DDD_PerformanceMonitor *_processProfiler;  /**< Profiler for tracking "Process" performance */
    DDD_ObjectEventSubscriberList _eventSubscribers; /**< List of objects that have subscribed to ObjectEvents */
    bool _paused;                              /**< True if the Data Director is paused */

    static bool _libraryInitialized;
};

}   // end namespace disti
#endif