A Discrete-Event Network Simulator
API
WaveformGeneratorTestCase Class Reference

Waveform generator Test. More...

+ Inheritance diagram for WaveformGeneratorTestCase:
+ Collaboration diagram for WaveformGeneratorTestCase:

Public Member Functions

 WaveformGeneratorTestCase (double period, double dutyCycle, double stop)
 Constructor. More...
 
 ~WaveformGeneratorTestCase () override
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor. More...
 
std::string GetName () const
 
TestCaseoperator= (const TestCase &)=delete
 

Private Member Functions

void DoRun () override
 Implementation to actually run this TestCase. More...
 
void TraceWave (Ptr< const Packet > newPkt)
 Trace if the waveform is active. More...
 

Private Attributes

double m_dutyCycle
 waveform duty cycle More...
 
int m_fails
 failure check More...
 
double m_period
 waveform period (seconds) More...
 
double m_stop
 stop time (seconds) More...
 

Additional Inherited Members

- Public Types inherited from ns3::TestCase
enum  TestDuration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
 How long the test takes to execute. More...
 
- Protected Member Functions inherited from ns3::TestCase
 TestCase (std::string name)
 Constructor. More...
 
void AddTestCase (TestCase *testCase, TestDuration duration=QUICK)
 Add an individual child TestCase to this test suite. More...
 
TestCaseGetParent () const
 Get the parent of this TestCase. More...
 
bool IsStatusFailure () const
 Check if any tests failed. More...
 
bool IsStatusSuccess () const
 Check if all tests passed. More...
 
void SetDataDir (std::string directory)
 Set the data directory where reference trace files can be found. More...
 
void ReportTestFailure (std::string cond, std::string actual, std::string limit, std::string message, std::string file, int32_t line)
 Log the failure of this TestCase. More...
 
bool MustAssertOnFailure () const
 Check if this run should assert on failure. More...
 
bool MustContinueOnFailure () const
 Check if this run should continue on failure. More...
 
std::string CreateDataDirFilename (std::string filename)
 Construct the full path to a file in the data directory. More...
 
std::string CreateTempDirFilename (std::string filename)
 Construct the full path to a file in a temporary directory. More...
 

Detailed Description

Waveform generator Test.

Definition at line 32 of file spectrum-waveform-generator-test.cc.

Constructor & Destructor Documentation

◆ WaveformGeneratorTestCase()

WaveformGeneratorTestCase::WaveformGeneratorTestCase ( double  period,
double  dutyCycle,
double  stop 
)

Constructor.

Parameters
periodwaveform period (seconds)
dutyCyclewaveform duty cycle
stopstop time (seconds)

Definition at line 68 of file spectrum-waveform-generator-test.cc.

◆ ~WaveformGeneratorTestCase()

WaveformGeneratorTestCase::~WaveformGeneratorTestCase ( )
override

Definition at line 77 of file spectrum-waveform-generator-test.cc.

Member Function Documentation

◆ DoRun()

◆ TraceWave()

void WaveformGeneratorTestCase::TraceWave ( Ptr< const Packet newPkt)
private

Trace if the waveform is active.

Parameters
newPktunused.

Definition at line 60 of file spectrum-waveform-generator-test.cc.

References ns3::Now().

Referenced by DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_dutyCycle

double WaveformGeneratorTestCase::m_dutyCycle
private

waveform duty cycle

Definition at line 54 of file spectrum-waveform-generator-test.cc.

Referenced by DoRun().

◆ m_fails

int WaveformGeneratorTestCase::m_fails
private

failure check

Definition at line 56 of file spectrum-waveform-generator-test.cc.

Referenced by DoRun().

◆ m_period

double WaveformGeneratorTestCase::m_period
private

waveform period (seconds)

Definition at line 53 of file spectrum-waveform-generator-test.cc.

Referenced by DoRun().

◆ m_stop

double WaveformGeneratorTestCase::m_stop
private

stop time (seconds)

Definition at line 55 of file spectrum-waveform-generator-test.cc.

Referenced by DoRun().


The documentation for this class was generated from the following file: