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

Acoustic Modem Energy Depletion Test Case. More...

+ Inheritance diagram for AcousticModemEnergyDepletionTestCase:
+ Collaboration diagram for AcousticModemEnergyDepletionTestCase:

Public Member Functions

 AcousticModemEnergyDepletionTestCase ()
 
 ~AcousticModemEnergyDepletionTestCase () override
 
void DepletionHandler ()
 Depletion handler function.
 
void DoRun () override
 Implementation to actually run this TestCase.
 
void SendOnePacket (Ptr< Node > node)
 Send one packet function.
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor.
 
std::string GetName () const
 
TestCaseoperator= (const TestCase &)=delete
 

Public Attributes

uint32_t m_callbackCount
 callback count
 
Ptr< Nodem_node
 the node
 
uint32_t m_packetSize
 packet size
 
double m_simTime
 Simulation time.
 

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

Acoustic Modem Energy Depletion Test Case.

Definition at line 209 of file uan-energy-model-test.cc.

Constructor & Destructor Documentation

◆ AcousticModemEnergyDepletionTestCase()

AcousticModemEnergyDepletionTestCase::AcousticModemEnergyDepletionTestCase ( )

Definition at line 231 of file uan-energy-model-test.cc.

◆ ~AcousticModemEnergyDepletionTestCase()

AcousticModemEnergyDepletionTestCase::~AcousticModemEnergyDepletionTestCase ( )
override

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

References m_node.

Member Function Documentation

◆ DepletionHandler()

void AcousticModemEnergyDepletionTestCase::DepletionHandler ( )

Depletion handler function.

Definition at line 245 of file uan-energy-model-test.cc.

References m_callbackCount.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ DoRun()

void AcousticModemEnergyDepletionTestCase::DoRun ( )
overridevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 267 of file uan-energy-model-test.cc.

References ns3::Object::AggregateObject(), ns3::CreateObject(), DepletionHandler(), ns3::Simulator::Destroy(), ns3::Object::GetObject(), ns3::DeviceEnergyModelHelper::Install(), ns3::EnergySourceHelper::Install(), ns3::UanHelper::Install(), m_callbackCount, m_node, m_simTime, ns3::MakeCallback(), NS_TEST_ASSERT_MSG_EQ, ns3::Simulator::Run(), ns3::Simulator::ScheduleNow(), ns3::Seconds(), SendOnePacket(), ns3::BasicEnergySourceHelper::Set(), ns3::AcousticModemEnergyModelHelper::SetDepletionCallback(), and ns3::Simulator::Stop().

+ Here is the call graph for this function:

◆ SendOnePacket()

void AcousticModemEnergyDepletionTestCase::SendOnePacket ( Ptr< Node > node)

Send one packet function.

Parameters
nodethe node to send to

Definition at line 252 of file uan-energy-model-test.cc.

References ns3::Create(), m_packetSize, ns3::Simulator::Schedule(), ns3::Seconds(), and SendOnePacket().

Referenced by DoRun(), and SendOnePacket().

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

Member Data Documentation

◆ m_callbackCount

uint32_t AcousticModemEnergyDepletionTestCase::m_callbackCount

callback count

Definition at line 226 of file uan-energy-model-test.cc.

Referenced by DepletionHandler(), and DoRun().

◆ m_node

Ptr<Node> AcousticModemEnergyDepletionTestCase::m_node

the node

Definition at line 228 of file uan-energy-model-test.cc.

Referenced by ~AcousticModemEnergyDepletionTestCase(), and DoRun().

◆ m_packetSize

uint32_t AcousticModemEnergyDepletionTestCase::m_packetSize

packet size

Definition at line 227 of file uan-energy-model-test.cc.

Referenced by SendOnePacket().

◆ m_simTime

double AcousticModemEnergyDepletionTestCase::m_simTime

Simulation time.

Definition at line 225 of file uan-energy-model-test.cc.

Referenced by DoRun().


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