spectrum-transmit-filter.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 University of Washington
 *
 * 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
 */
 
#ifndef SPECTRUM_TRANSMIT_FILTER_H
#define SPECTRUM_TRANSMIT_FILTER_H
 
#include <ns3/object.h>
 
namespace ns3
{
 
struct SpectrumSignalParameters;
class SpectrumPhy;
 
class SpectrumTransmitFilter : public Object
{
  public:
    SpectrumTransmitFilter();
 
    static TypeId GetTypeId();
 
    void SetNext(Ptr<SpectrumTransmitFilter> next);
 
    Ptr<const SpectrumTransmitFilter> GetNext() const;
 
    bool Filter(Ptr<const SpectrumSignalParameters> params, Ptr<const SpectrumPhy> receiverPhy);
 
    int64_t AssignStreams(int64_t stream);
 
  protected:
    void DoDispose() override;
    virtual int64_t DoAssignStreams(int64_t stream) = 0;
 
  private:
    virtual bool DoFilter(Ptr<const SpectrumSignalParameters> params,
                          Ptr<const SpectrumPhy> receiverPhy) = 0;
 
    Ptr<SpectrumTransmitFilter> m_next{nullptr}; 
};
 
} // namespace ns3
 
#endif /* SPECTRUM_TRANSMIT_FILTER_H */