gls_map_cadrg.h

Go to the documentation of this file.

/*! \file
  \brief  Declaration of the CADRGMapChartDataSource.

  \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_GLS_MAP_CADRG_H_INCLUDED
#define INCLUDED_GLS_MAP_CADRG_H_INCLUDED

#include "gls_map_chart_data_source.h"

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

#include <string>
namespace disti
{
class Image;
class CADRGMapChartLayerCache;
class CADRGMap;

// FIND_TOC is the default value and will depend on the A.TOC file.
// FIND_CADRG_FILES will ignore an existing A.TOC file and attempt to load data files directly.
enum ParseDirectoryRules
{
    FIND_TOC,
    FIND_CADRG_FILES,
};

//  PROCESS_LATER will delay loading of data files metadata and textures which will miminize memory usage at the expense of slightly slower loading time.
enum JustInTimeFileLoading
{
    PROCESS_LATER = true,
    PROCESS_NOW   = false,
};

/// \defgroup ds_CADRG CADRG
/// CADRG data source

/// Runtime implementation of an CADRGMapChartDataSource
/// \ingroup ds_CADRG
/// @{
class CADRGMapChartDataSource : public GlsMapChartDataSource
{
protected:
    GeoRect          _availableCoverage;
    MapChartCellList _masterCellList;

    unsigned long _userDefinedCADRGLayer;
    unsigned long _userDefinedCIBLayer;

    bool                        _useUserDefinedCADRGLayer;
    bool                        _useUserDefinedCIBLayer;
    const JustInTimeFileLoading _useJITFileLoading;

    CADRGMapChartLayerCache* _layerCache;    ///< Container for "old" data that is loaded but not currently shown.
    CADRGMap*                _cadrgMapStore; ///< Storage for map data.
    CADRGMapChartDataSource( const CADRGMapChartDataSource& );
    const CADRGMapChartDataSource& operator=( const CADRGMapChartDataSource& );

    void LoadFilesFromCoverage( const GeoRect& coverage_param, unsigned long layer );

public:
    explicit CADRGMapChartDataSource( JustInTimeFileLoading = PROCESS_LATER );
    ~CADRGMapChartDataSource();

    /// Use CADRG data from the specified directory
    void ParseDirectory( const char* directoryPath, ParseDirectoryRules = FIND_TOC );

    /// Uses the currentScaleString value to derive a new map layer from the existing layer identified by currentScaleString.
    /// \param currentScaleString should be the string of an existing layer e.g. "1:5M".
    /// The valid of currentScaleString values are:
    /// string - layer name
    /// "1:5M" - GNC
    /// "1:2M" - JNC
    /// "1:1M" - ONC
    /// "1:500K" - TPC
    /// "1:250K" - JOG
    /// "1:100K" - TLM
    /// "1:50K" - TLM
    /// \param customScaleString the string to be added to the above list of strings e.g."Custom1:5M".
    /// \param customExtension the two character non-numeric file extension that can be used to find files for this layer.
    void AddCustomMapLayer( const char* currentScaleString, const char* customScaleString, const char* customExtension );

    /// Gets the size of the layer container.  This gives an upper bound to SetCADRGLayer when using custom layers.
    unsigned int GetLayerCount() const;

    /// Get whether source will delay loading metdata for all files until they are shown.
    JustInTimeFileLoading IsJustInTimeFileLoadingEnabled( void ) const;

    /// 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( void ) const;

    // see base class
    bool GetAvailableCoverage( GeoRect* dest ) DISTI_METHOD_OVERRIDE;
    // see base class
    unsigned long GetBestLayer( GlsMapView* view, GlsMapChart* chart ) const 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 user-specificed layer to display for CADRG data.
    /// Note: This value will NOT be used unless the SetUseCADRGLayerFlag is true.
    /// The valid values are:
    /// 0 - OVERVIEW1
    /// 1 - GNC - 1:5M
    /// 2 - JNC - 1:2M
    /// 3 - ONC - 1:1M
    /// 4 - TPC - 1:500K
    /// 5 - JOG - 1:250K
    /// 6 - TLM - 1:100K
    /// 7 - TLM - 1:50K
    /// \param layer The layer to display. Should be in the range [0, LayerCount() - 1].
    void SetCADRGLayer( const unsigned long& layer );

    /// Set the layer to display for CADRG data by scale string.
    /// Note: This value will NOT be used unless the SetUseCADRGLayerFlag is true.
    /// The valid values are:
    /// string - layer name
    /// "1:5M" - GNC
    /// "1:2M" - JNC
    /// "1:1M" - ONC
    /// "1:500K" - TPC
    /// "1:250K" - JOG
    /// "1:100K" - TLM
    /// "1:50K" - TLM
    /// \param str The scale string of the layer to display. The strings are defined in the CADRG standard, i.e. "1:1M".
    void SetCADRGLayer( const std::string& str );

    /// Get the currently set layer for CADRG data.
    /// \returns The currently set layer for CADRG data.
    inline unsigned long GetCADRGLayer( void ) { return _userDefinedCADRGLayer; }

    /// Set the layer to display for CIB data.
    /// Note: This value will NOT be used unless the SetUseCADRGLayerFlag is true.
    /// The valid values are:
    /// 8 - 10M
    /// 9 - 5M
    /// \param layer The layer to display. Should be in the range [8, 10].
    void SetCIBLayer( const unsigned long& layer );

    /// Set the layer to display for CIB data by scale string.
    /// Note: This value will NOT be used unless the SetUseCADRGLayerFlag is true.
    /// The valid values are:
    /// "10M"
    /// "5M"
    /// \param str The scale string of the layer to display. The strings are defined int the CADRG standard, i.e. "1M".
    void SetCIBLayer( const std::string& str );

    /// Get the currently set layer for CIB data.
    /// \returns The currently set layer for CIB data.
    inline unsigned long GetCIBLayer( void ) { return _userDefinedCIBLayer; }

    /// Set the use CADRG layer flag, which turns on and off the use of the user specified layer for CADRG data.
    inline void SetUseCADRGLayerFlag( bool layerFlag ) { _useUserDefinedCADRGLayer = layerFlag; }

    /// Get the current setting of the use CADRG layer flag.
    inline bool GetUseCADRGLayerFlag( void ) { return _useUserDefinedCADRGLayer; }

    /// Set the use CIB layer flag, which turns on and off the use of the user specified layer for CIB data.
    inline void SetUseCIBLayerFlag( bool layerFlag ) { _useUserDefinedCIBLayer = layerFlag; }

    /// Get the current setting of the use CIB layer flag.
    inline bool GetUseCIBLayerFlag( void ) { return _useUserDefinedCIBLayer; }

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

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

    /// Updates the coverage area that is returned
    /// by GetAvailableCoverage.  This is called automatically
    /// when something causes the coverage area to change.
    /// This method is slow, users of the class should not need to call it directly.
    void CalcAvailableCoverage();

    /// Not normally called by user
    Image* LoadCellImage( MapChartCell* cell );
};
/// @}

} // namespace disti
#endif