three-gpp-http-variables.h

Go to the documentation of this file.

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions
 *
 * 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: Budiarto Herman <budiarto.herman@magister.fi>
 *
 */

#ifndef THREE_GPP_HTTP_VARIABLES_H
#define THREE_GPP_HTTP_VARIABLES_H

#include <ns3/object.h>
#include <ns3/nstime.h>
#include <ns3/random-variable-stream.h>


namespace ns3 {


class ThreeGppHttpVariables : public Object
{
public:
  ThreeGppHttpVariables ();

  static TypeId GetTypeId ();

  uint32_t GetMtuSize ();

  uint32_t GetRequestSize ();

  Time GetMainObjectGenerationDelay ();

  uint32_t GetMainObjectSize ();

  Time GetEmbeddedObjectGenerationDelay ();

  uint32_t GetEmbeddedObjectSize ();

  uint32_t GetNumOfEmbeddedObjects ();

  Time GetReadingTime ();

  Time GetParsingTime ();

  int64_t AssignStreams (int64_t stream);

  // SETTER METHODS

  void SetRequestSize (uint32_t constant);
  void SetMainObjectGenerationDelay (Time constant);
  void SetMainObjectSizeMean (uint32_t mean);
  void SetMainObjectSizeStdDev (uint32_t stdDev);
  void SetEmbeddedObjectGenerationDelay (Time constant);
  void SetEmbeddedObjectSizeMean (uint32_t mean);
  void SetEmbeddedObjectSizeStdDev (uint32_t stdDev);
  void SetNumOfEmbeddedObjectsMax (uint32_t max);
  void SetNumOfEmbeddedObjectsShape (double shape);
  void SetNumOfEmbeddedObjectsScale (uint32_t scale);
  void SetReadingTimeMean (Time mean);
  void SetParsingTimeMean (Time mean);

private:
  void UpdateMainObjectMuAndSigma (void);
  void UpdateEmbeddedObjectMuAndSigma (void);
  
  void DoInitialize (void);   // overridden from base class

  Ptr<UniformRandomVariable>      m_mtuSizeRng;
  Ptr<ConstantRandomVariable>     m_requestSizeRng;
  Ptr<ConstantRandomVariable>     m_mainObjectGenerationDelayRng;
  Ptr<LogNormalRandomVariable>    m_mainObjectSizeRng;
  uint32_t                        m_mainObjectSizeMean;
  uint32_t                        m_mainObjectSizeStdDev;
  uint32_t                        m_mainObjectSizeMin;
  uint32_t                        m_mainObjectSizeMax;
  uint32_t m_lowMtu;
  uint32_t m_highMtu;
  double m_highMtuProbability;
  Ptr<ConstantRandomVariable>     m_embeddedObjectGenerationDelayRng;
  Ptr<LogNormalRandomVariable>    m_embeddedObjectSizeRng;
  uint32_t                        m_embeddedObjectSizeMean;
  uint32_t                        m_embeddedObjectSizeStdDev;
  uint32_t                        m_embeddedObjectSizeMin;
  uint32_t                        m_embeddedObjectSizeMax;
  Ptr<ParetoRandomVariable>       m_numOfEmbeddedObjectsRng;
  uint32_t                        m_numOfEmbeddedObjectsScale;
  Ptr<ExponentialRandomVariable>  m_readingTimeRng;
  Ptr<ExponentialRandomVariable>  m_parsingTimeRng;

}; // end of `class ThreeGppHttpVariables`


} // end of `namespace ns3`

#endif /* THREE_GPP_HTTP_VARIABLES_H */