DDD_ProgressPublisher.h

Go to the documentation of this file.

/*! \file DDD_ProgressPublisher.h
  \brief  Publishes progress information to a progress subscriber for purposes of
          displaying a progress bar to the user

  \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_PROGRESS_PUBLISHER_H_
#define _DDD_PROGRESS_PUBLISHER_H_


#include "DDD_Include.h"


namespace disti
{

/** \brief Progress Callback function
  * \param percentage  Completion percentage from \c 0.0f to \c 100.0f
  */
typedef void (*ProgressCallback)(float);

/** \brief  Base class used by children of processes requesting periodic status updates. 
  * \remark  The \c percentage value is local; this object should start at 0 and finish at 100. Let the parent
   worry about the relative progress. */
class DDD_EXPORT DDD_ProgressPublisher
{
public:
    /** Constructor */
    DDD_ProgressPublisher();

    /** Set a progress callback for notifying parent processes of our current progress level (0.0-100.0%)
      * \param callback The callback that will be called whenever progress is updated
      * \note For performance the subscriber may not want to do an action everytime this callback is triggered
      */
    void SetProgressCallback(ProgressCallback callback);

    /** Update the progress value
      * \param percentage  The new progress value (0-100%)
      */
    void UpdateProgress(float percentage);

protected:
    ProgressCallback _progressCb;  /**< The progress callback */
    float _currentProgress;        /**< The current progress value */
};


}

#endif