dadada/ns-3-leo
dadada/ns-3-leo
1
0
Fork 0
mirror of https://gitlab.ibr.cs.tu-bs.de/tschuber/ns-3-leo.git synced 2025-07-29 18:20:07 +02:00
Code Issues Releases Wiki Activity

Update doxygen documentation

Browse source
This commit is contained in:
Tim Schubert 2020-09-06 21:37:47 +02:00
parent 61b6fd7ea1
commit f17ff6abc6
38 changed files with 1023 additions and 124 deletions
Download patch file Download diff file Expand all files Collapse all files

24
test/ground-node-helper-test-suite.cc
View file

@ -28,6 +28,18 @@
using namespace ns3;
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class EmptyGndNodeHelperTestCase : public TestCase
{
public:
@ -60,6 +72,12 @@ EmptyGndNodeHelperTestCase::DoRun (void)
// ------------------------------------------------------------------------- //
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class SomeGndNodeHelperTestCase : public TestCase
{
public:
@ -92,6 +110,12 @@ SomeGndNodeHelperTestCase::DoRun (void)
NS_ASSERT_MSG (mob != Ptr<MobilityModel> (), "Mobility model is valid");
}
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class GndNodeHelperTestSuite : public TestSuite
{
public:

24
test/isl-mock-channel-test-suite.cc
View file

@ -27,6 +27,18 @@
using namespace ns3;
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class IslMockChannelTransmitUnknownTestCase : public TestCase
{
public:
@ -49,6 +61,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class IslMockChannelTransmitKnownTestCase : public TestCase
{
public:
@ -82,6 +100,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class IslMockChannelTestSuite : public TestSuite
{
public:

24
test/isl-propagation-test-suite.cc
View file

@ -25,6 +25,18 @@ using namespace ns3;
#define EARTH_RAD 6.3781e6
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class IslPropagationAngleTestCase1 : public TestCase
{
public:
@ -42,6 +54,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class IslPropagationAngleTestCase2 : public TestCase
{
public:
@ -59,6 +77,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class IslPropagationTestSuite : public TestSuite
{
public:

18
test/isl-test-suite.cc
View file

@ -30,6 +30,18 @@
using namespace ns3;
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class IslIcmpTestCase : public TestCase
{
public:
@ -109,6 +121,12 @@ IslIcmpTestCase::DoRun (void)
Simulator::Destroy ();
}
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class IslTestSuite : public TestSuite
{
public:

22
test/leo-anim-test-suite.cc
View file

@ -30,6 +30,18 @@
using namespace ns3;
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoAnimTestCase1 : public TestCase
{
public:
@ -118,10 +130,12 @@ LeoAnimTestCase1::DoRun (void)
Simulator::Destroy ();
}
// The TestSuite class names the TestSuite, identifies what type of TestSuite,
// and enables the TestCases to be run. Typically, only the constructor for
// this class must be defined
//
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoAnimTestSuite : public TestSuite
{
public:

24
test/leo-input-fstream-container-test-suite.cc
View file

@ -21,6 +21,18 @@
using namespace ns3;
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoWaypointFileEmptyTestCase : public TestCase
{
public:
@ -57,6 +69,12 @@ LeoWaypointFileEmptyTestCase::DoRun (void)
NS_TEST_ASSERT_MSG_EQ ((i == 0), true, "Reading waypoints from empty");
}
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoWaypointSomeEntriesTestCase : public TestCase
{
public:
@ -93,6 +111,12 @@ LeoWaypointSomeEntriesTestCase::DoRun (void)
NS_TEST_ASSERT_MSG_EQ ((i > 0), true, "Reading from non-empty stream succeeds");
}
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoWaypointsTestSuite : public TestSuite
{
public:

18
test/leo-mobility-test-suite.cc
View file

@ -24,6 +24,18 @@ using namespace ns3;
NS_LOG_COMPONENT_DEFINE ("LeoMobilityTestSuite");
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoMobilityWaypointTestCase : public TestCase
{
public:
@ -57,6 +69,12 @@ LeoMobilityWaypointTestCase::DoRun (void)
NS_TEST_ASSERT_MSG_EQ ((mobility->WaypointsLeft () > 2), true, "Reading waypoints from empty");
}
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoMobilityTestSuite : public TestSuite
{
public:

42
test/leo-mock-channel-test-suite.cc
View file

@ -27,6 +27,18 @@
using namespace ns3;
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoMockChannelTransmitUnknownTestCase : public TestCase
{
public:
@ -49,6 +61,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoMockChannelTransmitKnownTestCase : public TestCase
{
public:
@ -86,6 +104,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoMockChannelTransmitSpaceGroundTestCase : public TestCase
{
public:
@ -123,6 +147,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoMockChannelTransmitSpaceSpaceTestCase : public TestCase
{
public:
@ -160,6 +190,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoMockChannelTransmitGroundGroundTestCase : public TestCase
{
public:
@ -197,6 +233,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoMockChannelTestSuite : public TestSuite
{
public:

48
test/leo-orbit-test-suite.cc
View file

@ -27,6 +27,18 @@
using namespace ns3;
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoOrbitSpeedTestCase : public TestCase
{
public:
@ -42,6 +54,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoOrbitPositionTestCase : public TestCase
{
public:
@ -58,6 +76,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoOrbitProgressTestCase : public TestCase
{
public:
@ -85,6 +109,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoOrbitLatitudeTestCase : public TestCase
{
public:
@ -106,6 +136,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoOrbitOffsetTestCase : public TestCase
{
public:
@ -127,6 +163,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoOrbitTracingTestCase : public TestCase
{
public:
@ -178,6 +220,12 @@ void LeoOrbitTracingTestCase::CourseChange (std::string context, Ptr<const Mobil
}
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoOrbitTestSuite : TestSuite
{
public:

36
test/leo-propagation-test-suite.cc
View file

@ -24,6 +24,18 @@
using namespace ns3;
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoPropagationRxNoLosTestCase : public TestCase
{
public:
@ -44,6 +56,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoPropagationRxLosTestCase : public TestCase
{
public:
@ -67,6 +85,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoPropagationBadAngleTestCase : public TestCase
{
public:
@ -87,6 +111,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoPropagationLossTestCase : public TestCase
{
public:
@ -109,6 +139,12 @@ private:
}
};
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoPropagationTestSuite : public TestSuite
{
public:

22
test/leo-test-suite.cc
View file

@ -29,6 +29,18 @@
using namespace ns3;
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoTestCase1 : public TestCase
{
public:
@ -146,10 +158,12 @@ LeoTestCase1::DoRun (void)
Simulator::Destroy ();
}
// The TestSuite class names the TestSuite, identifies what type of TestSuite,
// and enables the TestCases to be run. Typically, only the constructor for
// this class must be defined
//
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoTestSuite : public TestSuite
{
public:

22
test/leo-trace-test-suite.cc
View file

@ -29,6 +29,18 @@
using namespace ns3;
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoTraceTestCase1 : public TestCase
{
public:
@ -135,10 +147,12 @@ LeoTraceTestCase1::DoRun (void)
Simulator::Destroy ();
}
// The TestSuite class names the TestSuite, identifies what type of TestSuite,
// and enables the TestCases to be run. Typically, only the constructor for
// this class must be defined
//
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class LeoTraceTestSuite : public TestSuite
{
public:

24
test/satellite-node-helper-test-suite.cc
View file

@ -28,6 +28,18 @@
using namespace ns3;
/**
* \ingroup leo
* \defgroup leo-test LEO module tests
*/
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class EmptySatNodeHelperTestCase : public TestCase
{
public:
@ -60,6 +72,12 @@ EmptySatNodeHelperTestCase::DoRun (void)
// ------------------------------------------------------------------------- //
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class SingleSatNodeHelperTestCase : public TestCase
{
public:
@ -96,6 +114,12 @@ SingleSatNodeHelperTestCase::DoRun (void)
NS_ASSERT_MSG (mob != Ptr<MobilityModel> (), "Mobility model is valid");
}
/**
* \ingroup leo-test
* \ingroup tests
*
* \brief Unit tests
*/
class SatNodeHelperTestSuite : public TestSuite
{
public: