gls_map_aif_view_manager.h

Go to the documentation of this file.

/*! \file
  \brief  The AIF View Manager class.

  \par Copyright Information

  Copyright (c) 2008 The DiSTI Corporation.<br>
  11486 Corporate Blvd; Suite 190<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 POSSIBILITY
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 AIF_VIEW_MANAGER_
#define AIF_VIEW_MANAGER_

#include "gls_map_chart_data_source.h"
#include <string>
#include <vector>

namespace disti
{
class AifMapChartCell;

class AIFViewManager
{
public:
    AIFViewManager(){};
    virtual ~AIFViewManager();

    /** The class containing the information found in a data query
      * Contains the resolution and name of the overlay returned from the query
      */
    class FoundData
    {
    public:
        double      _res;
        std::string _name;
    };

    /** Vector used in data query returns
      */
    typedef std::vector<FoundData> OverlayAtResolution;

    /** Registers an overlay at given heights
      * \param heightLower lower end of the height range for this overlay
      * \param heightUpper upper end of the height range for this overlay
      * \param overlayName name of the overlay
      * \param resolution resolution of the overlay
      */
    virtual void RegisterOverlay( double heightLower, double heightUpper,
        const std::string overlayName,
        const double      resolution );

    /** Removes an overlay from the registry
      * \param overlayName name of the overlay to be removed
      * \param resolution resolution of the overlay to be removed
      */
    virtual void UnregisterOverlay( const std::string overlayName,
        const double                                  resolution );

    /** Queries the registry for all overlays which are active at the given height
      * \param height height at which to find overlays
      * \param result A vector containing the active overlays
      */
    virtual void QueryCollectionAtHeight( const double height, AIFViewManager::OverlayAtResolution& result );

protected:
    class RangeEntry
    {
    public:
        double      _h1;
        double      _h2;
        double      _res;
        std::string _name;
    };

    std::vector<RangeEntry*> _cells;
};

} // namespace disti
#endif