receivepropertiescontrolmessage.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 EMANECONTROLSRECEIVEPROPERTIESMESSAGE_HEADER_
#define EMANECONTROLSRECEIVEPROPERTIESMESSAGE_HEADER_

#include "emane/controlmessage.h"
#include "emane/controls/controlmessageids.h"
#include "emane/frequencysegment.h"

#include <memory>
#include <cstdint>

namespace EMANE
{
  namespace Controls
  {
    class ReceivePropertiesControlMessage : public ControlMessage
    {
    public:
      static
      ReceivePropertiesControlMessage * create(const TimePoint & txTime,
                                               const Microseconds & propagation,
                                               const Microseconds & span,
                                               double dReceiverSensitivitydBm);

      ReceivePropertiesControlMessage * clone() const override;

      ~ReceivePropertiesControlMessage();
      
      TimePoint getTxTime() const;

      
      Microseconds getPropagationDelay() const;

      Microseconds getSpan() const;
      
      double getReceiverSensitivitydBm() const;
      
      enum {IDENTIFIER = EMANE_CONTROL_MEASSGE_RECEIVE_PROPERTIES};
      
    private:
      class Implementation;
      std::unique_ptr<Implementation> pImpl_;
      
      ReceivePropertiesControlMessage(const TimePoint & sot,
                                      const Microseconds & propagation,
                                      const Microseconds & span,
                                      double dReceiverSensitivitydBm);
      
      ReceivePropertiesControlMessage(const ReceivePropertiesControlMessage &);

      ReceivePropertiesControlMessage &
      operator=(const ReceivePropertiesControlMessage &) = delete;
    };
  }
}

#endif // EMANECONTROLSRECEIVEPROPERTIESMESSAGE_HEADER_