A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
WrapToRangeTestCase Class Reference

Test bounds for various WrapTo... methods (WrapTo180, WrapTo360, WrapToPi, and WrapTo2Pi) by using a std::function wrapper. More...

+ Inheritance diagram for WrapToRangeTestCase:
+ Collaboration diagram for WrapToRangeTestCase:

Public Member Functions

 WrapToRangeTestCase (WrapToRangeFunction wrapper, double lowerBound, double upperBound)
 Constructor.
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor.
 
std::string GetName () const
 
TestCaseoperator= (const TestCase &)=delete
 

Static Public Member Functions

static std::string BuildNameString (double lowerBound, double upperBound)
 Build the test name.
 

Protected Member Functions

void CheckWrappingPoint (double wrapPoint)
 The given wrapper shall wrap an angle into the expected range.
 
- Protected Member Functions inherited from ns3::TestCase
 TestCase (std::string name)
 Constructor.
 
void AddTestCase (TestCase *testCase, Duration duration=Duration::QUICK)
 Add an individual child TestCase to this test suite.
 
TestCaseGetParent () const
 Get the parent of this TestCase.
 
bool IsStatusFailure () const
 Check if any tests failed.
 
bool IsStatusSuccess () const
 Check if all tests passed.
 
void SetDataDir (std::string directory)
 Set the data directory where reference trace files can be found.
 
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.
 
bool MustAssertOnFailure () const
 Check if this run should assert on failure.
 
bool MustContinueOnFailure () const
 Check if this run should continue on failure.
 
std::string CreateDataDirFilename (std::string filename)
 Construct the full path to a file in the data directory.
 
std::string CreateTempDirFilename (std::string filename)
 Construct the full path to a file in a temporary directory.
 

Private Member Functions

void DoRun () override
 Implementation to actually run this TestCase.
 

Private Attributes

double m_lowerBound
 the corresponding lower bound
 
double m_upperBound
 the corresponding upper bound
 
WrapToRangeFunction m_wrapper
 the wrapper function
 

Additional Inherited Members

- Public Types inherited from ns3::TestCase
enum class  Duration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
 How long the test takes to execute. More...
 
- Static Public Attributes inherited from ns3::TestCase
static constexpr auto QUICK = Duration::QUICK
 Deprecated test duration simple enums.
 
static constexpr auto EXTENSIVE = Duration::EXTENSIVE
 
static constexpr auto TAKES_FOREVER = Duration::TAKES_FOREVER
 

Detailed Description

Test bounds for various WrapTo... methods (WrapTo180, WrapTo360, WrapToPi, and WrapTo2Pi) by using a std::function wrapper.

Definition at line 134 of file test-angles.cc.

Constructor & Destructor Documentation

◆ WrapToRangeTestCase()

WrapToRangeTestCase::WrapToRangeTestCase ( WrapToRangeFunction wrapper,
double lowerBound,
double upperBound )

Constructor.

Parameters
wrapperfor one of WrapTo180, WrapTo360, WrapToPi, and WrapTo2Pi
lowerBoundthe corresponding lower bound
upperBoundthe corresponding upper bound

Definition at line 175 of file test-angles.cc.

Member Function Documentation

◆ BuildNameString()

std::string WrapToRangeTestCase::BuildNameString ( double lowerBound,
double upperBound )
static

Build the test name.

Parameters
lowerBoundthe lower bound of the WrapTo... function
upperBoundthe upper bound of the WrapTo... function
Returns
the test name

Definition at line 168 of file test-angles.cc.

◆ CheckWrappingPoint()

void WrapToRangeTestCase::CheckWrappingPoint ( double wrapPoint)
protected

The given wrapper shall wrap an angle into the expected range.

Parameters
wrapPointan angle

Definition at line 193 of file test-angles.cc.

References dir, m_lowerBound, m_upperBound, m_wrapper, and NS_TEST_EXPECT_MSG_EQ.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ DoRun()

void WrapToRangeTestCase::DoRun ( )
overrideprivatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 186 of file test-angles.cc.

References CheckWrappingPoint(), m_lowerBound, and m_upperBound.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_lowerBound

double WrapToRangeTestCase::m_lowerBound
private

the corresponding lower bound

Definition at line 163 of file test-angles.cc.

Referenced by CheckWrappingPoint(), and DoRun().

◆ m_upperBound

double WrapToRangeTestCase::m_upperBound
private

the corresponding upper bound

Definition at line 164 of file test-angles.cc.

Referenced by CheckWrappingPoint(), and DoRun().

◆ m_wrapper

WrapToRangeFunction WrapToRangeTestCase::m_wrapper
private

the wrapper function

Definition at line 162 of file test-angles.cc.

Referenced by CheckWrappingPoint().


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