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

Energy Harvester Test. More...

+ Inheritance diagram for BasicEnergyHarvesterTestCase:
+ Collaboration diagram for BasicEnergyHarvesterTestCase:

Public Member Functions

 BasicEnergyHarvesterTestCase ()
 
 ~BasicEnergyHarvesterTestCase () override
 
void DoRun () override
 Implementation to actually run this TestCase.
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor.
 
std::string GetName () const
 
TestCaseoperator= (const TestCase &)=delete
 

Public Attributes

ObjectFactory m_energyHarvester
 Energy harvester factory.
 
ObjectFactory m_energySource
 Energy source factory.
 
double m_timeS
 Time, in seconds.
 
double m_tolerance
 Tolerance for energy estimation.
 

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
 
- 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.
 

Detailed Description

Energy Harvester Test.

Definition at line 30 of file basic-energy-harvester-test.cc.

Constructor & Destructor Documentation

◆ BasicEnergyHarvesterTestCase()

BasicEnergyHarvesterTestCase::BasicEnergyHarvesterTestCase ( )

Definition at line 45 of file basic-energy-harvester-test.cc.

References m_timeS, and m_tolerance.

◆ ~BasicEnergyHarvesterTestCase()

BasicEnergyHarvesterTestCase::~BasicEnergyHarvesterTestCase ( )
override

Definition at line 52 of file basic-energy-harvester-test.cc.

Member Function Documentation

◆ DoRun()

void BasicEnergyHarvesterTestCase::DoRun ( )
overridevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 57 of file basic-energy-harvester-test.cc.

References ns3::ObjectFactory::Create(), ns3::CreateObject(), ns3::Simulator::Destroy(), m_energyHarvester, m_energySource, m_timeS, m_tolerance, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_TEST_ASSERT_MSG_EQ_TOL, ns3::Simulator::Run(), ns3::Simulator::Schedule(), ns3::Seconds(), ns3::ObjectFactory::SetTypeId(), ns3::Simulator::Stop(), and ns3::energy::BasicEnergySource::UpdateEnergySource().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_energyHarvester

ObjectFactory BasicEnergyHarvesterTestCase::m_energyHarvester

Energy harvester factory.

Definition at line 42 of file basic-energy-harvester-test.cc.

Referenced by DoRun().

◆ m_energySource

ObjectFactory BasicEnergyHarvesterTestCase::m_energySource

Energy source factory.

Definition at line 41 of file basic-energy-harvester-test.cc.

Referenced by DoRun().

◆ m_timeS

double BasicEnergyHarvesterTestCase::m_timeS

Time, in seconds.

Definition at line 38 of file basic-energy-harvester-test.cc.

Referenced by BasicEnergyHarvesterTestCase(), and DoRun().

◆ m_tolerance

double BasicEnergyHarvesterTestCase::m_tolerance

Tolerance for energy estimation.

Definition at line 39 of file basic-energy-harvester-test.cc.

Referenced by BasicEnergyHarvesterTestCase(), and DoRun().


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