satellite-frame-symbol-load-probe.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2011 Bucknell University
 * Copyright (c) 2014 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
 *
 * Authors of original work (application-packet-probe.h) which this work
 * derives from:
 * - L. Felipe Perrone (perrone@bucknell.edu)
 * - Tiago G. Rodrigues (tgr002@bucknell.edu)
 * - Mitch Watrous (watrous@u.washington.edu)
 *
 * Modified for FrameLoadTrace trace source by:
 * - Budiarto Herman (budiarto.herman@magister.fi)
 */
 
#ifndef SATELLITE_FRAME_SYMBOL_LOAD_PROBE_H
#define SATELLITE_FRAME_SYMBOL_LOAD_PROBE_H
 
#include "ns3/nstime.h"
#include "ns3/probe.h"
#include "ns3/traced-callback.h"
 
#include <string>
 
namespace ns3
{

class SatFrameSymbolLoadProbe : public Probe
{
  public:
    static TypeId GetTypeId();

    SatFrameSymbolLoadProbe();

    virtual ~SatFrameSymbolLoadProbe();

    void SetValue(uint32_t frameId, double loadRatio);

    static void SetValueByPath(std::string path, uint32_t frameId, double loadRatio);

    virtual bool ConnectByObject(std::string traceSource, Ptr<Object> obj);

    virtual void ConnectByPath(std::string path);

    typedef void (*FrameSymbolLoadCallback)(uint32_t frameId, double loadRatio);
 
  private:
    void TraceSink(uint32_t frameId, double loadRatio);

    TracedCallback<uint32_t, double> m_output;
};
 
} // namespace ns3
 
#endif // SATELLITE_FRAME_SYMBOL_LOAD_PROBE_H