/home/cube/sources/osgearth/src/osgEarthDrivers/wms/WMSOptions

Go to the documentation of this file.

/* -*-c++-*- */
/* osgEarth - Dynamic map generation toolkit for OpenSceneGraph
 * Copyright 2008-2010 Pelican Mapping
 * http://osgearth.org
 *
 * osgEarth is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 */
#ifndef OSGEARTH_DRIVER_WMS_DRIVEROPTIONS
#define OSGEARTH_DRIVER_WMS_DRIVEROPTIONS 1

#include <osgEarth/Common>
#include <osgEarth/TileSource>


namespace osgEarth { namespace Drivers
{
    using namespace osgEarth;

    class WMSOptions : public TileSourceOptions // NO EXPORT; header only
    {
    public:
        optional<URI>& url() { return _url; }
        const optional<URI>& url() const { return _url; }

        optional<URI>& capabilitiesUrl() { return _capabilitiesUrl; }
        const optional<URI>& capabilitiesUrl() const { return _capabilitiesUrl; }

        optional<URI>& tileServiceUrl() { return _tileServiceUrl; }
        const optional<URI>& tileServiceUrl() const { return _tileServiceUrl; }

        optional<std::string>& layers() { return _layers; }
        const optional<std::string>& layers() const { return _layers; }

        optional<std::string>& style() { return _style; }
        const optional<std::string>& style() const { return _style; }

        optional<std::string>& format() { return _format; }
        const optional<std::string>& format() const { return _format; }

        optional<std::string>& wmsFormat() { return _wmsFormat; }
        const optional<std::string>& wmsFormat() const { return _wmsFormat; }

        optional<std::string>& wmsVersion() { return _wmsVersion; }
        const optional<std::string>& wmsVersion() const { return _wmsVersion; }

        optional<std::string>& elevationUnit() { return _elevationUnit; }
        const optional<std::string>& elevationUnit() const { return _elevationUnit; }

        optional<std::string>& srs() { return _srs; }
        const optional<std::string>& srs() const { return _srs; }

        optional<bool>& transparent() { return _transparent; }
        const optional<bool>& transparent() const { return _transparent; }

        optional<std::string>& times() { return _times; }
        const optional<std::string>& times() const { return _times; }

        optional<double>& secondsPerFrame() { return _secondsPerFrame; }
        const optional<double>& secondsPerFrame() const { return _secondsPerFrame; }

    public:
        WMSOptions( const TileSourceOptions& opt =TileSourceOptions() ) : TileSourceOptions( opt ),
            _wmsVersion( "1.1.1" ),
            _elevationUnit( "m" ),
            _transparent( true ),
            _secondsPerFrame( 1.0 )
        {
            setDriver( "wms" );
            fromConfig( _conf );
        }

    public:
        Config getConfig() const {
            Config conf = TileSourceOptions::getConfig();
            conf.updateIfSet("url", _url);
            conf.updateIfSet("capabilities_url", _capabilitiesUrl);
            conf.updateIfSet("tile_service_url", _tileServiceUrl);
            conf.updateIfSet("layers", _layers);
            conf.updateIfSet("style", _style);
            conf.updateIfSet("format", _format);
            conf.updateIfSet("wms_format", _wmsFormat);
            conf.updateIfSet("wms_version", _wmsVersion);
            conf.updateIfSet("elevation_unit", _elevationUnit);
            conf.updateIfSet("srs", _srs);
            conf.updateIfSet("transparent", _transparent);
            conf.updateIfSet("times", _times);
            conf.updateIfSet("seconds_per_frame", _secondsPerFrame );
            return conf;
        }

    protected:
        void mergeConfig( const Config& conf ) {
            TileSourceOptions::mergeConfig( conf );
            fromConfig( conf );
        }

    private:
        void fromConfig( const Config& conf ) {
            conf.getIfSet("url", _url);
            conf.getIfSet("capabilities_url", _capabilitiesUrl);
            conf.getIfSet("tile_service_url", _tileServiceUrl);
            conf.getIfSet("layers", _layers);
            conf.getIfSet("style", _style);
            conf.getIfSet("format", _format);
            conf.getIfSet("wms_format", _wmsFormat);
            conf.getIfSet("wms_version", _wmsVersion);
            conf.getIfSet("elevation_unit", _elevationUnit);
            conf.getIfSet("srs", _srs);
            conf.getIfSet("transparent", _transparent);
            conf.getIfSet("times", _times);
            conf.getIfSet("seconds_per_frame", _secondsPerFrame );
        }

        optional<URI>         _url;
        optional<URI>         _capabilitiesUrl;
        optional<URI>         _tileServiceUrl;
        optional<std::string> _layers;
        optional<std::string> _style;
        optional<std::string> _format;
        optional<std::string> _wmsFormat;
        optional<std::string> _wmsVersion;
        optional<std::string> _elevationUnit;
        optional<std::string> _srs;
        optional<bool>        _transparent;
        optional<std::string> _times;
        optional<double>      _secondsPerFrame;
    };

} } // namespace osgEarth::Drivers

#endif // OSGEARTH_DRIVER_WMS_DRIVEROPTIONS