boolean-probe.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011 Bucknell University
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Authors: L. Felipe Perrone (perrone@bucknell.edu)
 *          Tiago G. Rodrigues (tgr002@bucknell.edu)
 *
 * Modified by: Mitch Watrous (watrous@u.washington.edu)
 */
 
#ifndef BOOL_PROBE_H
#define BOOL_PROBE_H
 
#include "probe.h"
 
#include "ns3/boolean.h"
#include "ns3/callback.h"
#include "ns3/object.h"
#include "ns3/simulator.h"
#include "ns3/traced-value.h"
 
namespace ns3
{
 
/**
 * \ingroup probes
 *
 * This class is designed to probe an underlying ns3 TraceSource exporting
 * a bool.  This probe exports a trace source "Output" of type bool.
 * The Output trace source emits a value when either the trace source
 * emits a new value, or when SetValue () is called.
 *
 * The current value of the probe can be polled with the GetValue ()
 * method.
 */
class BooleanProbe : public Probe
{
  public:
    /**
     * \brief Get the type ID.
     * \return the object TypeId
     */
    static TypeId GetTypeId();
    BooleanProbe();
    ~BooleanProbe() override;
 
    /**
     * \return the most recent value
     */
    bool GetValue() const;
 
    /**
     * \param value set the traced bool to a new value
     */
    void SetValue(bool value);
 
    /**
     * \brief Set a probe value by its name in the Config system
     *
     * \param path Config path to access the probe
     * \param value set the traced bool to a new value
     */
    static void SetValueByPath(std::string path, bool value);
 
    /**
     * \brief connect to a trace source attribute provided by a given object
     *
     * \param traceSource the name of the attribute TraceSource to connect to
     * \param obj ns3::Object to connect to
     * \return true if the trace source was successfully connected
     */
    bool ConnectByObject(std::string traceSource, Ptr<Object> obj) override;
 
    /**
     * \brief connect to a trace source provided by a config path
     *
     * \param path Config path to bind to
     *
     * Note, if an invalid path is provided, the probe will not be connected
     * to anything.
     */
    void ConnectByPath(std::string path) override;
 
  private:
    /**
     * \brief Method to connect to an underlying ns3::TraceSource of type bool
     *
     * \param oldData previous value of the bool
     * \param newData new value of the bool
     */
    void TraceSink(bool oldData, bool newData);
 
    TracedValue<bool> m_output; //!< Output trace source.
};
 
} // namespace ns3
 
#endif // BOOL_PROBE_H