A Discrete-Event Network Simulator
API
SpectrumIdealPhyTestCase Class Reference

Ideal Spectrum PHY Test. More...

+ Inheritance diagram for SpectrumIdealPhyTestCase:
+ Collaboration diagram for SpectrumIdealPhyTestCase:

Public Member Functions

 SpectrumIdealPhyTestCase (double snrLinear, uint64_t phyRate, bool rateIsAchievable, std::string channelType)
 Constructor. More...
 
 ~SpectrumIdealPhyTestCase () 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...
 

Static Private Member Functions

static std::string Name (std::string channelType, double snrLinear, uint64_t phyRate)
 Get the test name. More...
 

Private Attributes

std::string m_channelType
 Channel type. More...
 
uint64_t m_phyRate
 PHY rate (bps) More...
 
bool m_rateIsAchievable
 Check if the rate is achievable. More...
 
double m_snrLinear
 SNR (linear) 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

Ideal Spectrum PHY Test.

Definition at line 70 of file spectrum-ideal-phy-test.cc.

Constructor & Destructor Documentation

◆ SpectrumIdealPhyTestCase()

SpectrumIdealPhyTestCase::SpectrumIdealPhyTestCase ( double  snrLinear,
uint64_t  phyRate,
bool  rateIsAchievable,
std::string  channelType 
)

Constructor.

Parameters
snrLinearSNR (linear)
phyRatePHY rate (bps)
rateIsAchievableCheck if the rate is achievable
channelTypeChannel type

Definition at line 112 of file spectrum-ideal-phy-test.cc.

◆ ~SpectrumIdealPhyTestCase()

SpectrumIdealPhyTestCase::~SpectrumIdealPhyTestCase ( )
override

Definition at line 124 of file spectrum-ideal-phy-test.cc.

Member Function Documentation

◆ DoRun()

void SpectrumIdealPhyTestCase::DoRun ( )
overrideprivatevirtual

◆ Name()

std::string SpectrumIdealPhyTestCase::Name ( std::string  channelType,
double  snrLinear,
uint64_t  phyRate 
)
staticprivate

Get the test name.

Parameters
channelTypeChannel type
snrLinearSNR (linear)
phyRatePHY rate (bps)
Returns
the test name

Definition at line 104 of file spectrum-ideal-phy-test.cc.

Member Data Documentation

◆ m_channelType

std::string SpectrumIdealPhyTestCase::m_channelType
private

Channel type.

Definition at line 100 of file spectrum-ideal-phy-test.cc.

Referenced by DoRun().

◆ m_phyRate

uint64_t SpectrumIdealPhyTestCase::m_phyRate
private

PHY rate (bps)

Definition at line 98 of file spectrum-ideal-phy-test.cc.

Referenced by DoRun().

◆ m_rateIsAchievable

bool SpectrumIdealPhyTestCase::m_rateIsAchievable
private

Check if the rate is achievable.

Definition at line 99 of file spectrum-ideal-phy-test.cc.

Referenced by DoRun().

◆ m_snrLinear

double SpectrumIdealPhyTestCase::m_snrLinear
private

SNR (linear)

Definition at line 97 of file spectrum-ideal-phy-test.cc.

Referenced by DoRun().


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