gls_map_aif.h

Go to the documentation of this file.

/*! \file
  \brief  The AifMapChartDataSource class definition.

  \par Copyright Information

  Copyright (c) 2017 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 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 INCLUDED_GLSMAPAIF_H
#define INCLUDED_GLSMAPAIF_H

#include "gls_map_aif_view_manager.h"
#include "gls_map_chart_data_source.h"
#include "gls_map_util.h"
#include <map>
#include <string>
#include <vector>

#define LIB_BASE_NAME "gls_map_aif"
#include "gls_auto_lib.h"
#undef LIB_BASE_NAME

namespace disti
{
class AifMapChartCell;
class AIFMapChartLayerCache;
class GeoRect;

/// Type definitions for a multimap containing resoulution to AifMapChartCell pointer mappings.
typedef std::pair<double, AifMapChartCell*>     ResolutionCellPair;
typedef std::multimap<double, AifMapChartCell*> ResolutionCellMultiMap;

/// Type definitions for a multimap containing overlay name to resolution/cell multimap mappings.
typedef std::pair<std::string, ResolutionCellMultiMap>     OverlayCellPair;
typedef std::multimap<std::string, ResolutionCellMultiMap> OverlayCellMultiMap;

/// Type definitions for a vector of overlay name / resolution pairs.
typedef std::pair<std::string, double> OverlayListPair;
typedef std::vector<OverlayListPair>   OverlayListType;

typedef std::vector<double> ResolutionList;

/// \defgroup ds_AIF AIF
/// AIF data source

/// Runtime implementation of an AifMapChartDataSource
/// \ingroup ds_AIF
/// @{
class AifMapChartDataSource : public GlsMapChartDataSource
{
public:
    /// Create a new AifMapChartDataSource.
    /// \param UseDefaultCache whether to use the default caching system. See \ref AIFMapChartLayerCache for more information
    AifMapChartDataSource( bool UseDefaultCache = true );

    /// Destructs a AifMapChartDataSource object.
    ~AifMapChartDataSource();

    /// Load an AIF File with the given file name.
    /// \param filename The name of the AIF file to load. Can be absolute or relative to the executing directory.
    void LoadAifFile( std::string filename );

    /// If using custom cache, set it here. Caller responsible for its deallocation if necessary
    /// \param cache Custom cache to use
    virtual void SetCache( AIFMapChartLayerCache& cache );

    /// See base class
    bool GetAvailableCoverage( GeoRect* dest ) DISTI_METHOD_OVERRIDE;

    /// See base class
    void GetCellList( const GeoRect& coverage, unsigned long layerID, double viewLogicalHeight, double viewGeoHeight, MapChartCellList& viewList ) DISTI_METHOD_OVERRIDE;

    /// Add an overlay layer to the list of layers to display.
    /// \param overlay The name of the overlay layer to display. Must correspond to an overlay defined in the AIF file.
    /// \param resolution The resolution of the overlay to display. Must correspond to a resolution of an overlay defined in the AIF file.
    void AddOverlay( const std::string& overlay, double resolution );

    /// Insert an overlay layer to the list of layers to display at the given position.
    /// \param index The index to insert the overlay at, if -1 or greater than the length of the overlay list then inserts at end.
    /// \param overlay The name of the overlay layer to display. Must correspond to an overlay defined in the AIF file.
    /// \param resolution The resolution of the overlay to display. Must correspond to a resolution of an overlay defined in the AIF file.
    void InsertOverlay( int index, const std::string& overlay, double resolution );

    /// Remove an overlay layer from the list of layers to display.
    /// \param overlay The name of the overlay layer to remove. Must correspond to an overlay defined in the AIF file.
    /// \param resolution The resolution of the overlay to remove. Must correspond to a resolution of an overlay defined in the AIF file.
    void RemoveOverlay( const std::string& overlay, double resolution );

    /// Remove all overlay layers with the given overlay name.
    /// \param overlay The name of the set of overlay layers to remove.
    void RemoveOverlay( const std::string& overlay );

    /// Remove all overlay layers with the given resolution.
    /// \param resolution The resolution of the set of overlay layers to remove.
    void RemoveOverlay( double resolution );

    /// \param memSize Set the cached size (megabytes) of images
    void SetCacheSize( const float memSize );

    /// Get the cached size (megabytes) of images
    float GetCacheSize() const;

    /// Get the amount of memory used
    float GetCurrentCacheAllocated();

    /// Install the view manager. The view manager (after being initialized by the user)
    /// will set this class up to add/remove overlays automatically based on the view height
    /// \param mgr Manager to install
    void InstallViewManager( AIFViewManager& mgr );

    /// Uninstall the view manager.
    void UninstallViewManager();

    /// Precache based on geo-rect area. This uses the AIFMapChartCache as the mechanism to
    /// precache images
    /// \param area Geometric rect area to pre-cache
    void PreCache( const GeoRect& area );

    /// Precache based on resolution
    /// \param resolution Resolution to precache at.
    void PreCache( const double resolution );

    /// Set the target rate in hz at which cells will be loaded
    /// \param targetCellLoadRate target rate in hz else 0.0 for no target rate
    ///                           ( i.e. load as quickly as possible )
    void SetTargetCellLoadRate( const double targetCellLoadRate );

    /// Get the target rate in hz at which cells will be loaded
    /// \return target rate in hz else 0.0 for no target rate ( i.e. load as quickly as possible )
    double GetTargetCellLoadRate() const;

protected:
    /// The multimap containing all loaded cells for this Map Chart Data Source.
    OverlayCellMultiMap _cells;

    /// A list of the resolutions in this AIF file for speeding up the
    /// selection of a resolution at cell load list time.
    ResolutionList _resolutionList;

    /// The lat/lon boundries of the data contained in this Map Chart Data Source.
    GeoRect _extents;

    /// A list of all currently displayed overlay layers.
    OverlayListType _overlayList;

    /// The cache
    AIFMapChartLayerCache* _pCache;

    /// The View manager
    AIFViewManager* _pViewMgr;

    /// Using default cache
    bool _usingDefaultCache;
};

} // namespace disti

#endif