snr-tag.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005,2006 INRIA
 * Copyright (c) 2009 MIRKO BANCHI
 * Copyright (c) 2013 University of Surrey
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 *          Mirko Banchi <mk.banchi@gmail.com>
 *          Konstantinos Katsaros <dinos.katsaros@gmail.com>
 */
 
#ifndef SNR_TAG_H
#define SNR_TAG_H
 
#include "ns3/tag.h"
 
namespace ns3
{
 
class Tag;
 
class SnrTag : public Tag
{
  public:
    /**
     * \brief Get the type ID.
     * \return the object TypeId
     */
    static TypeId GetTypeId();
 
    /**
     * Create a SnrTag with the default SNR 0
     */
    SnrTag();
 
    TypeId GetInstanceTypeId() const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(TagBuffer i) const override;
    void Deserialize(TagBuffer i) override;
    void Print(std::ostream& os) const override;
 
    /**
     * Set the SNR to the given value.
     *
     * \param snr the value of the SNR to set in linear scale
     */
    void Set(double snr);
    /**
     * Return the SNR value.
     *
     * \return the SNR value in linear scale
     */
    double Get() const;
 
  private:
    double m_snr; //!< SNR value in linear scale
};
 
} // namespace ns3
 
#endif /* SNR_TAG_H */