AbstractAnimationInterfaceTestCase Class Reference

Abstract Animation Interface Test Case. More...

Inheritance diagram for AbstractAnimationInterfaceTestCase:

Collaboration diagram for AbstractAnimationInterfaceTestCase:

Public Member Functions
	AbstractAnimationInterfaceTestCase (std::string name)
	Constructor.
	~AbstractAnimationInterfaceTestCase () override
	Destructor.
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
TestCase &	operator= (const TestCase &)=delete

Protected Attributes
AnimationInterface *	m_anim
	animation
NodeContainer	m_nodes
	the nodes

Private Member Functions
virtual void	CheckFileExistence ()
	Check file existence.
virtual void	CheckLogic ()=0
	Check logic function.
virtual void	PrepareNetwork ()=0
	Prepare network function.

Private Attributes
const char *	m_traceFileName
	trace file name

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.
TestCase *	GetParent () 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

Abstract Animation Interface Test Case.

Definition at line 37 of file netanim-test.cc.

Constructor & Destructor Documentation

AbstractAnimationInterfaceTestCase()

AbstractAnimationInterfaceTestCase::AbstractAnimationInterfaceTestCase

(

std::string

name

)

Constructor.

Parameters

name	testcase name

Definition at line 69 of file netanim-test.cc.

~AbstractAnimationInterfaceTestCase()

AbstractAnimationInterfaceTestCase::~AbstractAnimationInterfaceTestCase ( )

override

Destructor.

Definition at line 76 of file netanim-test.cc.

References m_anim.

Member Function Documentation

CheckFileExistence()

void AbstractAnimationInterfaceTestCase::CheckFileExistence ( )

privatevirtual

Check file existence.

Definition at line 95 of file netanim-test.cc.

References m_traceFileName, and NS_TEST_ASSERT_MSG_NE.

Referenced by DoRun().

Here is the caller graph for this function:

CheckLogic()

virtual void AbstractAnimationInterfaceTestCase::CheckLogic ( )

privatepure virtual

Check logic function.

Implemented in AnimationInterfaceTestCase, and AnimationRemainingEnergyTestCase.

Referenced by DoRun().

Here is the caller graph for this function:

DoRun()

void AbstractAnimationInterfaceTestCase::DoRun ( )

overridevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 82 of file netanim-test.cc.

References CheckFileExistence(), CheckLogic(), ns3::Simulator::Destroy(), m_anim, m_traceFileName, PrepareNetwork(), and ns3::Simulator::Run().

Here is the call graph for this function:

PrepareNetwork()

virtual void AbstractAnimationInterfaceTestCase::PrepareNetwork ( )

privatepure virtual

Prepare network function.

Implemented in AnimationInterfaceTestCase, and AnimationRemainingEnergyTestCase.

Referenced by DoRun().

Here is the caller graph for this function:

Member Data Documentation

m_anim

AnimationInterface* AbstractAnimationInterfaceTestCase::m_anim

protected

animation

Definition at line 54 of file netanim-test.cc.

Referenced by ~AbstractAnimationInterfaceTestCase(), AnimationInterfaceTestCase::CheckLogic(), AnimationRemainingEnergyTestCase::CheckLogic(), and DoRun().

m_nodes

NodeContainer AbstractAnimationInterfaceTestCase::m_nodes

protected

the nodes

Definition at line 53 of file netanim-test.cc.

Referenced by AnimationRemainingEnergyTestCase::CheckLogic(), AnimationInterfaceTestCase::PrepareNetwork(), and AnimationRemainingEnergyTestCase::PrepareNetwork().

m_traceFileName

const char* AbstractAnimationInterfaceTestCase::m_traceFileName

private

trace file name

Definition at line 66 of file netanim-test.cc.

Referenced by CheckFileExistence(), and DoRun().

---

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

• src/netanim/test/netanim-test.cc