DDD_EventSubscriber.h

Go to the documentation of this file.

#ifndef DDD_EVENT_SUBSCRIBER_H_
#define DDD_EVENT_SUBSCRIBER_H_

/*! \file DDD_EventSubscriber.h
  \brief  Abstract base classes for DataDirector event subscribers.

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

*/


namespace disti
{

class DDD_AssetBase;
class DDD_ConvertBase;
class DDD_Connection;


/** \defgroup GroupEvents DataDirector Events */
/*@{*/
/** \defgroup AssetAddedGroup            AssetAdded 
  * \brief Whenever a new asset is added to the DataDirector
  */
/** \defgroup AssetDeletedGroup          AssetDeleted
  * \brief Whenever an asset is about to be deleted
  */
/** \defgroup AssetSelectedGroup         AssetSelected 
  * \brief Whenever an asset has been selected
  */
/** \defgroup AssetShiftedGroup          AssetShifted   
  * \brief Whenever an asset is shifted up or down within the Director's internal list
  */
/** \defgroup AssetStartedGroup          AssetStarted 
  * \brief Whenever an asset is started or stopped
  */
/** \defgroup ConfigurationClearedGroup  ConfigurationCleared 
  * \brief Whenever the DataDirector configuration has been cleared
  */
/** \defgroup ConnectionAddedGroup       ConnectionAdded 
  * \brief Whenever a connection has been added
  */
/** \defgroup ConnectionDeletedGroup     ConnectionDeleted
  * \brief Whenever a connection has been deleted
  */
/** \defgroup ConnectionSelectedGroup    ConnectionSelected
  * \brief Whenever a connection has been selected
  */
/** \defgroup ConnectionShiftedGroup     ConnectionShifted 
  * \brief Whenever a connection has been shifted up/down within the Director's internal list
  */
/** \defgroup ViewerRunningGroup         ViewerRunning 
  * \brief Whenever the DataDirectorViewer has started or stopped running
  */
/** \defgroup XMLConfigLoadingGroup      XMLConfigLoading 
  * \brief Whenever the DataDirector has started/stopped loading a configuration from XML
  */
/*@}*/

///////////////////////////////////////////////////////////////////////////////////
/** \brief  Abstract base class for subscribers of the AssetAdded event.
  * \ingroup AssetAddedGroup
  */
class DDD_AssetAdded_Subscriber
{
public:

    /** The AssetAdded event handling method in this observer
     * \param asset  asset instance that has been added to the Director
     */
    virtual void TriggerAssetAdded(DDD_AssetBase* asset) = 0;
};

///////////////////////////////////////////////////////////////////////////////////
/** \brief  Abstract base class for subscribers of the AssetDeleted event.
  * \ingroup AssetDeletedGroup
  */
class DDD_AssetDeleted_Subscriber
{
public:
    /** The AssetDeleted event handling method in this observer
     * \param asset  asset instance that is about to be deleted
     */
    virtual void TriggerAssetDeleted(DDD_AssetBase* asset) = 0;
};


///////////////////////////////////////////////////////////////////////////////////
/** \brief  Abstract base class for subscribers of the AssetSelected event.
  * \ingroup AssetSelectedGroup
  */
class DDD_AssetSelected_Subscriber
{
public:
    /** The AssetSelected event handling method in this observer
     * \param asset  pointer to asset that is currently selected
     * \warning NULL should be handled gracefully. The Editor treats this case as an unselect event.
     */
    virtual void TriggerAssetSelected(DDD_AssetBase* asset) = 0;
};

///////////////////////////////////////////////////////////////////////////////////
/** \brief  Abstract base class for subscribers of the AssetShifted event.
  * \ingroup AssetShiftedGroup
  */
class DDD_AssetShifted_Subscriber
{
public:
    enum AssetShiftDirection
    { 
        ASSET_SHIFT_UP = 0,  /*!< asset has switched places with the one before it */
        ASSET_SHIFT_DOWN = 1 /*!< asset has switched places with the one behind it */
    };
    /** The AssetShifted event handling method in this observer
     * \param asset  pointer to asset that is to be shifted
     * \param direction  enum denoting asset's direction for shift.
     */
    virtual void TriggerAssetShifted(DDD_AssetBase* asset, AssetShiftDirection direction) = 0;
};

///////////////////////////////////////////////////////////////////////////////////
/** \brief  Abstract base class for subscribers of the AssetStarted event.
  * \ingroup AssetStartedGroup
  */
class DDD_AssetStarted_Subscriber
{
public:
    /** The AssetStarted event handling method in this observer
     * \param start  true = started; false = stopped
     * \param asset  pointer to asset that is to be started or stopped
     */
    virtual void TriggerAssetStarted(bool started, DDD_AssetBase* asset) = 0;
};

///////////////////////////////////////////////////////////////////////////////////
/** \brief  Abstract base class for subscribers of the ConfigurationCleared event.
  * \ingroup ConfigurationClearedGroup
  * \note  Generally, every subscriber should revert to blank / default state
  */
class DDD_ConfigurationCleared_Subscriber
{
public:
    /** The ClearConfiguration event handling method in this observer
     * \note  Subcribers should revert to default state and remove any residual 
     * DataDirector-specific data, lest they contain dangling pointers.
     */
    virtual void TriggerConfigurationCleared() = 0;
};

///////////////////////////////////////////////////////////////////////////////////
/** \brief  Abstract base class for subscribers of the ConnectionAdded event.
  * \ingroup ConnectionAddedGroup
  */
class DDD_ConnectionAdded_Subscriber
{
public:
    /** The ConnectionAdded event handling method in this observer
     * \param connection  pointer to connection that has been added to the Director
     */
    virtual void TriggerConnectionAdded(DDD_Connection* connection) = 0;
};

///////////////////////////////////////////////////////////////////////////////////
/** \brief  Abstract base class for subscribers of the ConnectionDeleted event.
  * \ingroup ConnectionDeletedGroup
  */
class DDD_ConnectionDeleted_Subscriber
{
public:
    /** The ConnectionDeleted event handling method in this observer
     * \param connection  pointer to connection that is about to be deleted from the Director
     * \post This subscriber should not contain any references to this connection.
     */
    virtual void TriggerConnectionDeleted(DDD_Connection* connection) = 0;
};

///////////////////////////////////////////////////////////////////////////////////
/** \brief  Abstract base class for subscribers of the ConnectionSelected event.
  * \ingroup ConnectionSelectedGroup
  */
class DDD_ConnectionSelected_Subscriber
{
public:
    /** The ConnectionSelected event handling method in this observer
     * \param connection  pointer to connection that is selected
     * \warning NULL should be handled gracefully. The Editor treats this case as an "unselect" event.
     */
    virtual void TriggerConnectionSelected(DDD_Connection* connection) = 0;
};

///////////////////////////////////////////////////////////////////////////////////
/** \brief  Abstract base class for subscribers of the ConnectionShifted event.
  * \ingroup ConnectionShiftedGroup
  */
class DDD_ConnectionShifted_Subscriber
{
public:
    enum ConnectionShiftDirection
    { 
        CONNECTION_SHIFT_UP = 0,  /*!< connection has switched places with the one before it */
        CONNECTION_SHIFT_DOWN = 1 /*!< connection has switched places with the one behind it */
    };
    /** The ConnectionShifted event handling method in this observer
     * \param connection  pointer to connection that is to be shifted
     * \param direction  enum denoting connection's direction for shift.
     */
    virtual void TriggerConnectionShifted(DDD_Connection* connection, ConnectionShiftDirection direction) = 0;
};

///////////////////////////////////////////////////////////////////////////////////
/** \brief  Abstract base class for subscribers of the ViewerRunning event.
  * \ingroup ViewerRunningGroup
  */
class DDD_ViewerRunning_Subscriber
{
public:
    /** The ViewerRunning event handling method in this observer
     * \param running  true = viewer started, false = viewer stopped
     */
    virtual void TriggerViewerRunning(bool running) = 0;
};

///////////////////////////////////////////////////////////////////////////////////
/** \brief  Abstract base class for subscribers of the XMLConfigLoading event.
  * \ingroup XMLConfigLoadingGroup
  */
class DDD_XMLConfigLoading_Subscriber
{
public:
    /** The XMLConfigLoading event handling method in this observer
     * \param loading  true = started loading, false = stopped loading
     */
    virtual void TriggerXMLConfigLoading(bool loading) = 0;
};


} // end of namespace disti


#endif