BasicEnergyDepletionTest Class Reference

Test case of energy depletion handling for BasicEnergySource and WifiRadioEnergyModel. More...

Inheritance diagram for BasicEnergyDepletionTest:

Collaboration diagram for BasicEnergyDepletionTest:

Public Member Functions
	BasicEnergyDepletionTest ()
virtual	~BasicEnergyDepletionTest ()
Public Member Functions inherited from ns3::TestCase
virtual	~TestCase ()
	Destructor. More...

Private Member Functions
void	DepletionHandler (void)
	Callback invoked when energy is drained from source. More...
bool	DepletionTestCase (double simTimeS, double updateIntervalS)
void	DoRun (void)
	Implementation to actually run this TestCase. More...

Private Attributes
int	m_callbackCount
int	m_numOfNodes
double	m_simTimeS
double	m_timeStepS
double	m_updateIntervalS

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)
void	AddTestCase (TestCase *testCase) NS_DEPRECATED
	Add an individual child TestCase case to this TestCase. More...
void	AddTestCase (TestCase *testCase, enum TestDuration duration)
	Add an individual child TestCase to this test suite. More...
std::string	CreateDataDirFilename (std::string filename)
std::string	CreateTempDirFilename (std::string filename)
bool	GetErrorStatus (void) const NS_DEPRECATED
std::string	GetName (void) const
bool	IsStatusFailure (void) const
bool	IsStatusSuccess (void) const
bool	MustAssertOnFailure (void) const
bool	MustContinueOnFailure (void) const
void	ReportTestFailure (std::string cond, std::string actual, std::string limit, std::string message, std::string file, int32_t line)
void	SetDataDir (std::string directory)

Detailed Description

Test case of energy depletion handling for BasicEnergySource and WifiRadioEnergyModel.

Definition at line 212 of file basic-energy-model-test.cc.

Constructor & Destructor Documentation

BasicEnergyDepletionTest::BasicEnergyDepletionTest

(

)

Definition at line 244 of file basic-energy-model-test.cc.

References m_callbackCount, m_numOfNodes, m_simTimeS, m_timeStepS, and m_updateIntervalS.

BasicEnergyDepletionTest::~BasicEnergyDepletionTest ( )

virtual

Definition at line 254 of file basic-energy-model-test.cc.

Member Function Documentation

void BasicEnergyDepletionTest::DepletionHandler ( void  )

private

Callback invoked when energy is drained from source.

Definition at line 277 of file basic-energy-model-test.cc.

References m_callbackCount.

Referenced by DepletionTestCase().

Here is the caller graph for this function:

bool BasicEnergyDepletionTest::DepletionTestCase ( double  simTimeS, double  updateIntervalS  )

private

Parameters

simTimeS	Simulation time, in seconds.
updateIntervalS	Device model update interval, in seconds.

Returns

False if all is good.

Runs simulation with specified simulation time and update interval.

Definition at line 283 of file basic-energy-model-test.cc.

References ns3::YansWifiChannelHelper::Create(), ns3::NodeContainer::Create(), DepletionHandler(), first::devices, ns3::EnergySourceHelper::Install(), ns3::DeviceEnergyModelHelper::Install(), ns3::WifiHelper::Install(), m_callbackCount, m_numOfNodes, ns3::MakeCallback(), NS_LOG_DEBUG, NS_TEST_ASSERT_MSG_EQ_RETURNS_BOOL, ns3::BasicEnergySourceHelper::Set(), ns3::YansWifiPhyHelper::Set(), ns3::YansWifiPhyHelper::SetChannel(), ns3::Config::SetDefault(), ns3::WifiRadioEnergyModelHelper::SetDepletionCallback(), ns3::YansWifiPhyHelper::SetPcapDataLinkType(), ns3::YansWifiChannelHelper::SetPropagationDelay(), ns3::WifiHelper::SetRemoteStationManager(), ns3::WifiHelper::SetStandard(), ns3::NqosWifiMacHelper::SetType(), and ns3::WIFI_PHY_STANDARD_80211b.

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

void BasicEnergyDepletionTest::DoRun ( void  )

privatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 259 of file basic-energy-model-test.cc.

References DepletionTestCase(), m_callbackCount, m_simTimeS, m_timeStepS, m_updateIntervalS, and NS_TEST_ASSERT_MSG_EQ.

Here is the call graph for this function:

Member Data Documentation

int BasicEnergyDepletionTest::m_callbackCount

private

Definition at line 237 of file basic-energy-model-test.cc.

Referenced by BasicEnergyDepletionTest(), DepletionHandler(), DepletionTestCase(), and DoRun().

int BasicEnergyDepletionTest::m_numOfNodes

private

Definition at line 236 of file basic-energy-model-test.cc.

Referenced by BasicEnergyDepletionTest(), and DepletionTestCase().

double BasicEnergyDepletionTest::m_simTimeS

private

Definition at line 238 of file basic-energy-model-test.cc.

Referenced by BasicEnergyDepletionTest(), and DoRun().

double BasicEnergyDepletionTest::m_timeStepS

private

Definition at line 239 of file basic-energy-model-test.cc.

Referenced by BasicEnergyDepletionTest(), and DoRun().

double BasicEnergyDepletionTest::m_updateIntervalS

private

Definition at line 240 of file basic-energy-model-test.cc.

Referenced by BasicEnergyDepletionTest(), and DoRun().

---

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

• src/energy/test/basic-energy-model-test.cc