model/plc-noise.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2012 University of British Columbia, Vancouver
 *
 * 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
 *
 * Author: Alexander Schloegl <alexander.schloegl@gmx.de>
 */

#ifndef PLC_NOISE_H_
#define PLC_NOISE_H_

#include <ns3/simple-ref-count.h>
#include <ns3/random-variable.h>
#include <ns3/spectrum-value.h>

#include "plc-time.h"
#include "plc-channel.h"

namespace ns3 {

#define MAX_PULSE_NOISE_DURATION        1
#define MAX_PULSE_GAP_DURATION          2

class PLC_ColoredNoiseFloor : public SimpleRefCount<PLC_ColoredNoiseFloor>
{
public:

        PLC_ColoredNoiseFloor(double a, double b, double c, Ptr<const SpectrumModel> sm);

        Ptr<SpectrumValue> GetNoisePsd(void);

protected:
        Ptr<SpectrumValue> m_noisePsd;
};

class PLC_NoiseSource : public Object
{
public:
        static TypeId GetTypeId(void);

        enum NoiseSourceType {
                STATIC,
                TIMEVARIANT,
                IMPULSIVE
        };

        PLC_NoiseSource() {}

        PLC_NoiseSource(Ptr<PLC_Node> src_node, Ptr<SpectrumValue> noisePsd, NoiseSourceType type);
        virtual ~PLC_NoiseSource() = 0;

        void SetNoisePsd(Ptr<SpectrumValue> psd) { m_noisePsd = psd; }

        Ptr<SpectrumValue> GetNoisePsd(void) { return m_noisePsd; }

        NoiseSourceType GetNoiseSourceType(void);

        void SetNode(Ptr<PLC_Node> node) { m_src_node = node; }

        Ptr<PLC_Node> GetNode(void) { return m_src_node; }

        void SetChannel(Ptr<PLC_Channel> channel) { m_channel = channel; }

        Ptr<PLC_Channel> GetChannel(void) { return m_channel; }

        void Init(void);

        virtual void Enable(void);

        virtual void Disable(void);

        bool IsEnabled(void);

protected:
    // pure virtual dummy function to keep pybindgen happy
    virtual void pureVirtualDummy(void) = 0;

        NoiseSourceType m_noise_source_type;
        uint32_t m_noise_srcId;
        Ptr<PLC_Node> m_src_node;
        Ptr<SpectrumValue> m_noisePsd;
        Ptr<PLC_Channel> m_channel;
        Ptr<PLC_TxInterface> m_txInterface;
        bool m_is_enabled;
        bool m_is_initialized;
};

class PLC_StaticNoiseSource : public PLC_NoiseSource
{
public:
        static TypeId GetTypeId(void);

        PLC_StaticNoiseSource (Ptr<PLC_Node> src_node, Ptr<SpectrumValue> noisePsd);

        void Start (Time duration);

protected:
    // dummy function to keep pybindgen happy
    virtual void pureVirtualDummy(void) {}

private:
        Ptr<SpectrumValue> m_noisePsd;
};

class PLC_ImpulseNoiseSource : public PLC_NoiseSource
{
public:
        static TypeId GetTypeId(void);

        PLC_ImpulseNoiseSource();
        PLC_ImpulseNoiseSource(Ptr<PLC_Node> m_src_node, Ptr<SpectrumValue> noisePsd, double p);

        void SetProbability(double p);
        double GetProbability(void);

protected:
    // dummy function to keep pybindgen happy
    virtual void pureVirtualDummy(void) {}

private:
        double m_p;
};

class PLC_ImpulsiveNoiseSource : public PLC_NoiseSource
{
public:
        static TypeId GetTypeId(void);

        PLC_ImpulsiveNoiseSource();
        PLC_ImpulsiveNoiseSource(Ptr<PLC_Node> m_src_node, Ptr<SpectrumValue> noisePsd);

        PLC_ImpulsiveNoiseSource(Ptr<PLC_Node> src_node, Ptr<SpectrumValue> noisePsd, RandomVariable *pulselen_gen, RandomVariable *pulsegap_gen);

        void Enable(void);

        void PulseStart(void);

        void PulseEnd(void);

protected:
    // dummy function to keep pybindgen happy
    virtual void pureVirtualDummy(void) {}

private:
        RandomVariable          *m_pulse_len;
        RandomVariable          *m_pulse_gap;
};

}

#endif /* PLC_NOISE_H_ */