spectrumserviceprovider.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2014 - Adjacent Link LLC, Bridgewater, New Jersey
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 * * Neither the name of Adjacent Link LLC nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef EMANESPECTRUMSERVICEPROVIDER_HEADER_
#define EMANESPECTRUMSERVICEPROVIDER_HEADER_

#include "emane/types.h"

#include <set>
#include <vector>
#include <tuple>

namespace EMANE
{
  using FrequencySet = std::set<std::uint64_t>;

  using SpectrumWindow = std::tuple<std::vector<double>,TimePoint,Microseconds,double,bool>;

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


    virtual FrequencySet getFrequencies() const = 0;

    virtual double getReceiverSensitivitydBm() const = 0;

    virtual SpectrumWindow request(std::uint64_t u64FrequencyHz,
                                   const Microseconds & duration = Microseconds::zero(),
                                   const TimePoint & startTime = TimePoint::min()) const = 0;

  protected:
    SpectrumServiceProvider() = default;
  };
}

#endif //EMANESPECTRUMSERVICEPROVIDER_HEADER_