DDD_EventPublisher.h

Go to the documentation of this file.

/*! \file DDD_EventPublisher.h
  \brief  The DDD_EventPublisher class.   

  \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.

*/

#ifndef _DDD_EVENT_PUBLISHER_H_
#define _DDD_EVENT_PUBLISHER_H_

#include "DDD_Include.h"
#include "DDD_EventSubscriber.h"
#include "dynamic_ptr_array.h"


namespace disti
{

/** \brief  The DDD_EventPublisher class. Central class for publishing events. Contains all logic for registering subscribers,
   unregistering event subscribers, dispatching events, and notifying even subscribers. 
  * \ingroup GroupEvents
  */
class DDD_EXPORT DDD_EventPublisher
{
    ///////////////////////////////////////////////////////////////////////////////////////
    // AssetAdded Event
    ///////////////////////////////////////////////////////////////////////////////////////
public:
    typedef DynamicPtrArray<DDD_AssetAdded_Subscriber*> AssetAddedSubscriberList;

    /* Register the provided object as an observer to the 
     * AssetAdded event
     * \param subscriber  Object to add as an observer
     */
    void Register(DDD_AssetAdded_Subscriber* subscriber);
    
    /* Unregister the provided object from the 
     * AssetAdded event
     * \param subscriber  Object to remove from the observer list
     */ 
    void Unregister(DDD_AssetAdded_Subscriber* subscriber);

    /* Helper function used to notify all observers that the
     * AssetAdded event just happened
     * \param asset  Newly added asset
     */
    virtual void Dispatch_AssetAdded(DDD_AssetBase *asset);
protected:
    AssetAddedSubscriberList _assetAddedSubscribers;
    ///////////////////////////////////////////////////////////////////////////////////////


    ///////////////////////////////////////////////////////////////////////////////////////
    // ConnectionAdded Event 
    ///////////////////////////////////////////////////////////////////////////////////////
public:
    typedef DynamicPtrArray<DDD_ConnectionAdded_Subscriber*> ConnectionAddedSubscriberList;

    /* Register the provided object as an observer to the
     * ConnectionAdded event
     * \param subscriber  Object to add as an observer
     */
    void Register(DDD_ConnectionAdded_Subscriber* subscriber);

    /* Unregister the provided object from the
     * ConnectionAdded event
     * \param subscriber  Object to remove from the observer list
     */
    void Unregister(DDD_ConnectionAdded_Subscriber* subscriber);

    /* Helper function used to notify all observer that the 
     * ConnectionAdded event just happened
     * \param connection  Newly added connection
     */
    virtual void Dispatch_ConnectionAdded(DDD_Connection *connection);
protected:
    ConnectionAddedSubscriberList _connectionAddedSubscribers;
    ///////////////////////////////////////////////////////////////////////////////////////


    ///////////////////////////////////////////////////////////////////////////////////////
    // ConnectionDeleted Event 
    ///////////////////////////////////////////////////////////////////////////////////////
public:
    typedef DynamicPtrArray<DDD_ConnectionDeleted_Subscriber*> ConnectionDeletedSubscriberList;

    /* Register the provided object as an observer to the
     * ConnectionDeleted event
     * \param subscriber  Object to add as an observer
     */
    void Register(DDD_ConnectionDeleted_Subscriber* subscriber);

    /* Unregister the provided object from the
     * ConnectionDeleted event
     * \param subscriber  Object to remove from the observer list
     */
    void Unregister(DDD_ConnectionDeleted_Subscriber* subscriber);

    /* Helper function used to notify all observer that the 
     * ConnectionDeleted event just happened
     * \param connection  Newly added connection
     */
    virtual void Dispatch_ConnectionDeleted(DDD_Connection *connection);
protected:
    ConnectionDeletedSubscriberList _connectionDeletedSubscribers;
    ///////////////////////////////////////////////////////////////////////////////////////


    ///////////////////////////////////////////////////////////////////////////////////////
    // ConnectionSelected Event 
    ///////////////////////////////////////////////////////////////////////////////////////
public:
    typedef DynamicPtrArray<DDD_ConnectionSelected_Subscriber*> ConnectionSelectedSubscriberList;

    /* Register the provided object as an observer to the 
     * ConverterSelected event
     * \param subscriber  Object to add as an observer
     */
    void Register(DDD_ConnectionSelected_Subscriber* subscriber);

    /* Unregister the provided object from the
     * ConverterSelected event
     * \param subscriber  Object to remove from the observer list
     */
    void Unregister(DDD_ConnectionSelected_Subscriber* subscriber);

    /* Helper function used to notify all observers that the 
     * ConverterSelected event just happened
     * \param converter  Newly selected converter
     */
    virtual void Dispatch_ConnectionSelected(DDD_Connection *connection);
protected:
    ConnectionSelectedSubscriberList _connectionSelectedSubscribers;
    ///////////////////////////////////////////////////////////////////////////////////////


    ///////////////////////////////////////////////////////////////////////////////////////
    // AssetSelected Event 
    ///////////////////////////////////////////////////////////////////////////////////////
public:
    typedef DynamicPtrArray<DDD_AssetSelected_Subscriber*> AssetSelectedSubscriberList;

    /* Register the provided object as an observer to the
     * AssetSelected event
     * \param subscriber  Object to add as an observer
     */
    void Register(DDD_AssetSelected_Subscriber* subscriber);

    /* Unregister the provided object from the 
     * AssetSelected event
     * \param subscriber  Object to remove from the observer list
     */
    void Unregister(DDD_AssetSelected_Subscriber* subscriber);

    /* Helper function used to notify all observers that the 
     * AssetSelected event just happened
     * \param asset  Newly selected asset
     */
    virtual void Dispatch_AssetSelected(DDD_AssetBase *asset);
protected:
    AssetSelectedSubscriberList _assetSelectedSubscribers;
    ///////////////////////////////////////////////////////////////////////////////////////

    ///////////////////////////////////////////////////////////////////////////////////////
    // AssetStarted Event 
    ///////////////////////////////////////////////////////////////////////////////////////
public:
    typedef DynamicPtrArray<DDD_AssetStarted_Subscriber*> AssetStartedSubscriberList;

    /* Register the provided object as an observer to the
     * AssetStarted event
     * \param subscriber  Object to add as an observer
     */
    void Register(DDD_AssetStarted_Subscriber* subscriber);

    /* Unregister the provided object from the 
     * AssetStarted event
     * \param subscriber  Object to remove from the observer list
     */
    void Unregister(DDD_AssetStarted_Subscriber* subscriber);

    /* Helper function used to notify all observers that the 
     * AssetStarted event just happened
     * \param start  true = started; false = stopped
     * \param asset  pointer to asset that is to be started or stopped. 
     *            NULL implies that multiple assets have been affected.
     */
    virtual void Dispatch_AssetStarted(bool started, DDD_AssetBase *asset);
protected:
    AssetStartedSubscriberList _assetStartedSubscribers;
    ///////////////////////////////////////////////////////////////////////////////////////



    ///////////////////////////////////////////////////////////////////////////////////////
    // AssetDeleted Event 
    ///////////////////////////////////////////////////////////////////////////////////////
public:
    typedef DynamicPtrArray<DDD_AssetDeleted_Subscriber*> AssetDeletedSubscriberList;

    /* Register the provided object as an observer to the 
     * AssetDeleted event
     * \param subscriber  Object to add as an observer
     */
    void Register(DDD_AssetDeleted_Subscriber* subscriber);

    /* Unregister the provided object from the 
     * AssetDeleted event
     * \param subscriber  Object to remove from the observer list
     */
    void Unregister(DDD_AssetDeleted_Subscriber* subscriber);

    /* Helper function used to notfy all observers that the
     * AssetDeleted event just happened
     * \param asset  Newly deleted asset
     */
    virtual void Dispatch_AssetDeleted(DDD_AssetBase *asset);

protected:
    AssetDeletedSubscriberList _assetDeletedSubscribers;
    ///////////////////////////////////////////////////////////////////////////////////////

    ///////////////////////////////////////////////////////////////////////////////////////
    // XMLConfigLoading Event 
    ///////////////////////////////////////////////////////////////////////////////////////
public:

    typedef DynamicPtrArray<DDD_XMLConfigLoading_Subscriber*> XMLConfigLoadingSubscriberList;

    /* Register the provided object as an observer to the 
     * XMLConfigLoading event
     * \param subscriber  Object to add as an observer
     */
    void Register(DDD_XMLConfigLoading_Subscriber* subscriber);

    /* Unregister the provided object from the 
     * XMLConfigLoading event
     * \param subscriber Object to remove from the observer list
     */
    void Unregister(DDD_XMLConfigLoading_Subscriber* subscriber);

    /* Helper function used to notify all observeres that the
     * XMLConfigLoading event just happened
     * \param currentlyLoading  True if loading just started and False if it just finished
     */
    virtual void Dispatch_XMLConfigLoading(bool currentlyLoading);
protected:
    XMLConfigLoadingSubscriberList _xmlConfigLoadingSubscribers;
    ///////////////////////////////////////////////////////////////////////////////////////


    ///////////////////////////////////////////////////////////////////////////////////////
    // ViewerRunning Event 
    ///////////////////////////////////////////////////////////////////////////////////////
public:
    typedef DynamicPtrArray<DDD_ViewerRunning_Subscriber*> ViewerRunningSubscriberList;

    /* Register the provided object as an observer to the
     * ViewerRunning event
     * \param subscriber  Object to add as an observer
     */
    void Register(DDD_ViewerRunning_Subscriber* subscriber);

    /* Unregister the provided object from the
     * ViewerRunning event
     * \param subscriber  Object to remove from the observer list
     */
    void Unregister(DDD_ViewerRunning_Subscriber* subscriber);

    /* Helper function used to notify all observers that the 
     * ViewerRunning event just happend
     * \param running  True if the viewr just started and False if it just stopped
     */
    virtual void Dispatch_ViewerRunning(bool running);
protected:
    ViewerRunningSubscriberList _viewerRunningSubscribers;
    ///////////////////////////////////////////////////////////////////////////////////////


    ///////////////////////////////////////////////////////////////////////////////////////
    // ConfigurationCleared Event 
    ///////////////////////////////////////////////////////////////////////////////////////
public:
    typedef DynamicPtrArray<DDD_ConfigurationCleared_Subscriber*> ConfigurationClearedSubscriberList;

    /* Register the provided object as an observer to the 
     * ConfigurationCleared event
     * \param subscriber  Object to add as an observer
     */
    void Register(DDD_ConfigurationCleared_Subscriber* subscriber);

    /* Unregister the provided object from the
     * ConfigurationCleared event
     * \param subscriber  Object to remove from the observer list
     */
    void Unregister(DDD_ConfigurationCleared_Subscriber* subscriber);

    /* Helper function used to notif all observers that the
     * ConfigurationCleared just happend
     */
    virtual void Dispatch_ConfigurationCleared(void);
protected:
    ConfigurationClearedSubscriberList _configurationClearedSubscribers;
    ///////////////////////////////////////////////////////////////////////////////////////

    ///////////////////////////////////////////////////////////////////////////////////////
    // AssetShifted Event 
    ///////////////////////////////////////////////////////////////////////////////////////
public:
    typedef DynamicPtrArray<DDD_AssetShifted_Subscriber*> AssetShiftedSubscriberList;

    /* Register the provided object as an observer to the 
     * AssetShifted event
     * \param subscriber  Object to add as an observer
     */
    void Register(DDD_AssetShifted_Subscriber* subscriber);

    /* Unregister the provided object from the 
     * AssetShifted event
     * \param subscriber  Object to remove from the observer list
     */
    void Unregister(DDD_AssetShifted_Subscriber* subscriber);

    /* Helper function used to notfy all observers that the
     * AssetShifted event just happened
     * \param asset  pointer to asset that is to be shifted
     * \param direction  enum denoting asset's direction for shift.
     */
    virtual void Dispatch_AssetShifted(DDD_AssetBase *asset, DDD_AssetShifted_Subscriber::AssetShiftDirection direction);

protected:
    AssetShiftedSubscriberList _assetShiftedSubscribers;
    ///////////////////////////////////////////////////////////////////////////////////////

    ///////////////////////////////////////////////////////////////////////////////////////
    // ConnectionShifted Event 
    ///////////////////////////////////////////////////////////////////////////////////////
public:
    typedef DynamicPtrArray<DDD_ConnectionShifted_Subscriber*> ConnectionShiftedSubscriberList;

    /* Register the provided object as an observer to the 
     * ConnectionShifted event
     * \param subscriber  Object to add as an observer
     */
    void Register(DDD_ConnectionShifted_Subscriber* subscriber);

    /* Unregister the provided object from the 
     * ConnectionShifted event
     * \param subscriber  Object to remove from the observer list
     */
    void Unregister(DDD_ConnectionShifted_Subscriber* subscriber);

    /* Helper function used to notfy all observers that the
     * ConnectionShifted event just happened
     * \param connection  pointer to asset that is to be shifted
     * \param direction  enum denoting asset's direction for shift.
     */
    virtual void Dispatch_ConnectionShifted(DDD_Connection *connection, DDD_ConnectionShifted_Subscriber::ConnectionShiftDirection direction);

protected:
    ConnectionShiftedSubscriberList _connectionShiftedSubscribers;
    ///////////////////////////////////////////////////////////////////////////////////////



};

}


#endif