satellite-markov-container.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd.
 *
 * 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: Frans Laakso <frans.laakso@magister.fi>
 */
#ifndef SATELLITE_MARKOV_CONTAINER_H
#define SATELLITE_MARKOV_CONTAINER_H
 
#include "geo-coordinate.h"
#include "satellite-base-fading.h"
#include "satellite-loo-model.h"
#include "satellite-markov-conf.h"
#include "satellite-markov-model.h"
#include "satellite-rayleigh-model.h"
 
#include <ns3/traced-callback.h>
#include <ns3/vector.h>
 
#include <stdint.h>
 
namespace ns3
{
 
class SatMarkovContainer : public SatBaseFading
{
  public:
    static TypeId GetTypeId(void);
 
    SatMarkovContainer();
 
    SatMarkovContainer(Ptr<SatMarkovConf> markovConf,
                       SatBaseFading::ElevationCallback elevation,
                       SatBaseFading::VelocityCallback velocity);
 
    ~SatMarkovContainer();
 
    void DoDispose();
 
    double DoGetFading(Address macAddress, SatEnums::ChannelType_t channeltype);
 
    void UnlockSetAndState();
 
    void LockToSetAndState(uint32_t newSet, uint32_t newState);
 
    void LockToSet(uint32_t newSet);
 
    void RandomizeLockedSetAndState();
 
    void RandomizeLockedState(uint32_t set);
 
    typedef void (*FadingTraceCallback)(double time,
                                        SatEnums::ChannelType_t channelType,
                                        double value);
 
  private:
    Ptr<SatMarkovModel> m_markovModel;
 
    Ptr<SatMarkovConf> m_markovConf;
 
    Ptr<SatBaseFader> m_fader_up;
 
    Ptr<SatBaseFader> m_fader_down;
 
    uint32_t m_numOfStates;
 
    uint32_t m_numOfSets;
 
    uint32_t m_currentSet;
 
    uint32_t m_currentState;
 
    Time m_cooldownPeriodLength;
 
    double m_minimumPositionChangeInMeters;
 
    double m_latestCalculatedFadingValue_up;
 
    double m_latestCalculatedFadingValue_down;
 
    Time m_latestCalculationTime_up;
 
    Time m_latestCalculationTime_down;
 
    bool m_enableSetLock;
 
    bool m_enableStateLock;
 
    VelocityCallback m_velocity;
 
    Time m_latestStateChangeTime;
 
    ElevationCallback m_currentElevation;
 
    bool m_useDecibels;
 
    TracedCallback<double,                  // time
                   SatEnums::ChannelType_t, // channel type
                   double                   // fading value
                   >
        m_fadingTrace;
 
    void UpdateProbabilities(uint32_t set);
 
    void EvaluateStateChange(SatEnums::ChannelType_t channelType);
 
    double CalculateFading(SatEnums::ChannelType_t channelType);
 
    double CalculateElevation();
 
    bool HasCooldownPeriodPassed(SatEnums::ChannelType_t channelType);
 
    double GetCachedFadingValue(SatEnums::ChannelType_t channelType);
 
    void CreateFaders(SatMarkovConf::MarkovFaderType_t faderType);
 
    double CalculateDistanceSinceLastStateChange();
 
    void Reset();
};
 
} // namespace ns3
 
#endif /* SATELLITE_MARKOV_CONTAINER_H */