A Discrete-Event Network Simulator
API
CosineAntennaModelTestCase Class Reference

CosineAntennaModel Test. More...

+ Inheritance diagram for CosineAntennaModelTestCase:
+ Collaboration diagram for CosineAntennaModelTestCase:

Public Member Functions

 CosineAntennaModelTestCase (Angles a, double b, double o, double g, double expectedGainDb, CosineAntennaModelGainTestCondition cond)
 Constructor. More...
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor. More...
 
std::string GetName (void) const
 
TestCaseoperator= (const TestCase &)=delete
 

Static Public Member Functions

static std::string BuildNameString (Angles a, double b, double o, double g)
 Build the test name. More...
 

Private Member Functions

virtual void DoRun (void)
 Implementation to actually run this TestCase. More...
 

Private Attributes

Angles m_a
 Antenna angle. More...
 
double m_b
 Horizontal and Vertical Beamwidth. More...
 
CosineAntennaModelGainTestCondition m_cond
 Test condition. More...
 
double m_expectedGain
 Expected gain. More...
 
double m_g
 MaxGain. More...
 
double m_o
 Orientation. 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 TestCsse. More...
 
bool IsStatusFailure (void) const
 Check if any tests failed. More...
 
bool IsStatusSuccess (void) 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 (void) const
 Check if this run should assert on failure. More...
 
bool MustContinueOnFailure (void) 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

CosineAntennaModel Test.

Definition at line 51 of file test-cosine-antenna.cc.

Constructor & Destructor Documentation

◆ CosineAntennaModelTestCase()

CosineAntennaModelTestCase::CosineAntennaModelTestCase ( Angles  a,
double  b,
double  o,
double  g,
double  expectedGainDb,
CosineAntennaModelGainTestCondition  cond 
)

Constructor.

Parameters
aAntenna angle
bHorizontal and Vertical Beamwidth
oOrientation
gMaxGain
expectedGainDbExpeted antenna gain
condTest condition

Definition at line 96 of file test-cosine-antenna.cc.

Member Function Documentation

◆ BuildNameString()

std::string CosineAntennaModelTestCase::BuildNameString ( Angles  a,
double  b,
double  o,
double  g 
)
static

Build the test name.

Parameters
aAntenna angle
bHorizontal and Vertical Beamwidth
oOrientation
gMaxGain
Returns
the test name

Definition at line 85 of file test-cosine-antenna.cc.

References ns3::Angles::GetAzimuth(), and ns3::Angles::GetInclination().

Referenced by DoRun().

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

◆ DoRun()

void CosineAntennaModelTestCase::DoRun ( void  )
privatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 108 of file test-cosine-antenna.cc.

References BuildNameString(), EQUAL, LESSTHAN, m_a, m_b, m_cond, m_expectedGain, m_g, m_o, NS_LOG_FUNCTION, NS_TEST_EXPECT_MSG_EQ_TOL, and NS_TEST_EXPECT_MSG_LT.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_a

Angles CosineAntennaModelTestCase::m_a
private

Antenna angle.

Definition at line 77 of file test-cosine-antenna.cc.

Referenced by DoRun().

◆ m_b

double CosineAntennaModelTestCase::m_b
private

Horizontal and Vertical Beamwidth.

Definition at line 78 of file test-cosine-antenna.cc.

Referenced by DoRun().

◆ m_cond

CosineAntennaModelGainTestCondition CosineAntennaModelTestCase::m_cond
private

Test condition.

Definition at line 82 of file test-cosine-antenna.cc.

Referenced by DoRun().

◆ m_expectedGain

double CosineAntennaModelTestCase::m_expectedGain
private

Expected gain.

Definition at line 81 of file test-cosine-antenna.cc.

Referenced by DoRun().

◆ m_g

double CosineAntennaModelTestCase::m_g
private

MaxGain.

Definition at line 80 of file test-cosine-antenna.cc.

Referenced by DoRun().

◆ m_o

double CosineAntennaModelTestCase::m_o
private

Orientation.

Definition at line 79 of file test-cosine-antenna.cc.

Referenced by DoRun().


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