satellite-frame-user-load-probe.cc

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.cc) 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 FrameUtLoadTrace trace source by:
 * - Budiarto Herman (budiarto.herman@magister.fi)
 */
 
#include "ns3/satellite-frame-user-load-probe.h"
 
#include "ns3/callback.h"
#include "ns3/config.h"
#include "ns3/log.h"
#include "ns3/names.h"
#include "ns3/simulator.h"
 
NS_LOG_COMPONENT_DEFINE("SatFrameUserLoadProbe");
 
namespace ns3
{
 
NS_OBJECT_ENSURE_REGISTERED(SatFrameUserLoadProbe);
 
TypeId
SatFrameUserLoadProbe::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::SatFrameUserLoadProbe")
            .SetParent<Probe>()
            .AddConstructor<SatFrameUserLoadProbe>()
            .AddTraceSource("Output",
                            "The frame ID and the number of scheduled users that serve as the "
                            "output for this probe",
                            MakeTraceSourceAccessor(&SatFrameUserLoadProbe::m_output),
                            "ns3::SatFrameUserLoadProbe::FrameUserLoadCallback");
    return tid;
}
 
SatFrameUserLoadProbe::SatFrameUserLoadProbe()
{
    NS_LOG_FUNCTION(this);
}
 
SatFrameUserLoadProbe::~SatFrameUserLoadProbe()
{
    NS_LOG_FUNCTION(this);
}
 
void
SatFrameUserLoadProbe::SetValue(uint32_t frameId, uint32_t utCount)
{
    NS_LOG_FUNCTION(this << frameId << utCount);
    m_output(frameId, utCount);
}
 
void
SatFrameUserLoadProbe::SetValueByPath(std::string path, uint32_t frameId, uint32_t utCount)
{
    NS_LOG_FUNCTION(path << frameId << utCount);
    Ptr<SatFrameUserLoadProbe> probe = Names::Find<SatFrameUserLoadProbe>(path);
    NS_ASSERT_MSG(probe, "Error:  Can't find probe for path " << path);
    probe->SetValue(frameId, utCount);
}
 
bool
SatFrameUserLoadProbe::ConnectByObject(std::string traceSource, Ptr<Object> obj)
{
    NS_LOG_FUNCTION(this << traceSource << obj);
    NS_LOG_DEBUG("Name of probe (if any) in names database: " << Names::FindPath(obj));
    bool connected =
        obj->TraceConnectWithoutContext(traceSource,
                                        MakeCallback(&ns3::SatFrameUserLoadProbe::TraceSink, this));
    return connected;
}
 
void
SatFrameUserLoadProbe::ConnectByPath(std::string path)
{
    NS_LOG_FUNCTION(this << path);
    NS_LOG_DEBUG("Name of probe to search for in config database: " << path);
    Config::ConnectWithoutContext(path, MakeCallback(&ns3::SatFrameUserLoadProbe::TraceSink, this));
}
 
void
SatFrameUserLoadProbe::TraceSink(uint32_t frameId, uint32_t utCount)
{
    NS_LOG_FUNCTION(this << frameId << utCount);
    if (IsEnabled())
    {
        m_output(frameId, utCount);
    }
}
 
} // namespace ns3