gls_map_geotiff.h

Go to the documentation of this file.

/*! \file
  \brief  The GeoTIFFMapChartDataSource class.

  \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 _GEOTIFF_MAP_CHART_DATA_SOURCE_H
#define _GEOTIFF_MAP_CHART_DATA_SOURCE_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_geotiff"
#include "gls_auto_lib.h"
#undef LIB_BASE_NAME

namespace disti
{
class GeoTIFFMapChartCell;
class GeoTIFFImageHolder;

/** \defgroup ds_GeoTIFF GeoTIFF 
    * GeoTIFF data source
    */

/** Runtime implementation of a GlsMapGeoTIFF 
    * \ingroup ds_GeoTIFF
    * @{
    */
class GeoTIFFMapChartDataSource : public GlsMapChartDataSource
{
public:
    /** Create a new GlsMapGeoTIFF. */
    GeoTIFFMapChartDataSource();

    /** Destructs a GlsMapGeoTIFF object */
    ~GeoTIFFMapChartDataSource();

    /// Load one or more GeoTIFF images.
    /// \param str A string containing one filename, a comma separated list of filenames
    /// a directory to parse, recursively, looking for files to load.
    void LoadGeoTIFF( const std::string& str );

    /// Unload one or more GeoTIFF images.
    /// \param str Must be the same string passed to LoadGeoTIFF
    void UnloadGeoTIFF( const std::string& str );

    /// 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;

    /// 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;

    /// Set the count of the layer cache
    /// \param cacheCount max number of layers to cache else 0u to disable layer caching
    void SetCacheCount( const unsigned int cacheCount );

    // Get the count of the layer cache
    // \return max number of layers to cache ( 0u if caching is disabled )
    unsigned int GetCacheCount() const;

protected:
    void SearchDirectory( const std::string& entity, const std::string& originalLoadString );
    void LoadGeoTIFF( const std::string& str, const std::string& originalLoadString );

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

    std::vector<GeoTIFFImageHolder*> _imageHolders;
};
/// @}
} // namespace disti

#endif // _GEOTIFF_MAP_CHART_DATA_SOURCE_H