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

DL-OFDMA PHY test. More...

+ Inheritance diagram for TestDlOfdmaPhyTransmission:
+ Collaboration diagram for TestDlOfdmaPhyTransmission:

Public Member Functions

 TestDlOfdmaPhyTransmission ()
 
 ~TestDlOfdmaPhyTransmission () override
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor.
 
std::string GetName () const
 
TestCaseoperator= (const TestCase &)=delete
 

Private Member Functions

void CheckPhyState (Ptr< OfdmaSpectrumWifiPhy > phy, WifiPhyState expectedState)
 Schedule now to check the PHY state.
 
void CheckResultsSta1 (uint32_t expectedRxSuccess, uint32_t expectedRxFailure, uint32_t expectedRxBytes)
 Check the results for STA 1.
 
void CheckResultsSta2 (uint32_t expectedRxSuccess, uint32_t expectedRxFailure, uint32_t expectedRxBytes)
 Check the results for STA 2.
 
void CheckResultsSta3 (uint32_t expectedRxSuccess, uint32_t expectedRxFailure, uint32_t expectedRxBytes)
 Check the results for STA 3.
 
void DoCheckPhyState (Ptr< OfdmaSpectrumWifiPhy > phy, WifiPhyState expectedState)
 Check the PHY state now.
 
void DoRun () override
 Implementation to actually run this TestCase.
 
void DoSetup () override
 Implementation to do any local setup required for this TestCase.
 
void DoTeardown () override
 Implementation to do any local setup required for this TestCase.
 
void GenerateInterference (Ptr< SpectrumValue > interferencePsd, Time duration)
 Generate interference function.
 
void ResetResults ()
 Reset the results.
 
void RunOne ()
 Run one function.
 
void RxFailureSta1 (Ptr< const WifiPsdu > psdu)
 Receive failure function for STA 1.
 
void RxFailureSta2 (Ptr< const WifiPsdu > psdu)
 Receive failure function for STA 2.
 
void RxFailureSta3 (Ptr< const WifiPsdu > psdu)
 Receive failure function for STA 3.
 
void RxSuccessSta1 (Ptr< const WifiPsdu > psdu, RxSignalInfo rxSignalInfo, WifiTxVector txVector, std::vector< bool > statusPerMpdu)
 Receive success function for STA 1.
 
void RxSuccessSta2 (Ptr< const WifiPsdu > psdu, RxSignalInfo rxSignalInfo, WifiTxVector txVector, std::vector< bool > statusPerMpdu)
 Receive success function for STA 2.
 
void RxSuccessSta3 (Ptr< const WifiPsdu > psdu, RxSignalInfo rxSignalInfo, WifiTxVector txVector, std::vector< bool > statusPerMpdu)
 Receive success function for STA 3.
 
void SendMuPpdu (uint16_t rxStaId1, uint16_t rxStaId2)
 Send MU-PPDU function.
 
void StopInterference ()
 Stop interference function.
 

Private Attributes

uint16_t m_channelWidth
 channel width in MHz
 
uint32_t m_countRxBytesSta1
 count RX bytes for STA 1
 
uint32_t m_countRxBytesSta2
 count RX bytes for STA 2
 
uint32_t m_countRxBytesSta3
 count RX bytes for STA 3
 
uint32_t m_countRxFailureSta1
 count RX failure for STA 1
 
uint32_t m_countRxFailureSta2
 count RX failure for STA 2
 
uint32_t m_countRxFailureSta3
 count RX failure for STA 3
 
uint32_t m_countRxSuccessSta1
 count RX success for STA 1
 
uint32_t m_countRxSuccessSta2
 count RX success for STA 2
 
uint32_t m_countRxSuccessSta3
 count RX success for STA 3
 
Time m_expectedPpduDuration
 expected duration to send MU PPDU
 
uint16_t m_frequency
 frequency in MHz
 
Ptr< SpectrumWifiPhym_phyAp
 PHY of AP.
 
Ptr< WaveformGeneratorm_phyInterferer
 PHY of interferer.
 
Ptr< OfdmaSpectrumWifiPhym_phySta1
 PHY of STA 1.
 
Ptr< OfdmaSpectrumWifiPhym_phySta2
 PHY of STA 2.
 
Ptr< OfdmaSpectrumWifiPhym_phySta3
 PHY of STA 3.
 

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...
 
using instead = Duration
 
- Static Public Attributes inherited from ns3::TestCase
static constexpr auto EXTENSIVE = Duration::EXTENSIVE
 
static constexpr auto QUICK = Duration::QUICK
 
static constexpr auto 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

DL-OFDMA PHY test.

Definition at line 298 of file wifi-phy-ofdma-test.cc.

Constructor & Destructor Documentation

◆ TestDlOfdmaPhyTransmission()

TestDlOfdmaPhyTransmission::TestDlOfdmaPhyTransmission ( )

Definition at line 449 of file wifi-phy-ofdma-test.cc.

◆ ~TestDlOfdmaPhyTransmission()

TestDlOfdmaPhyTransmission::~TestDlOfdmaPhyTransmission ( )
override

Definition at line 569 of file wifi-phy-ofdma-test.cc.

Member Function Documentation

◆ CheckPhyState()

void TestDlOfdmaPhyTransmission::CheckPhyState ( Ptr< OfdmaSpectrumWifiPhy phy,
WifiPhyState  expectedState 
)
private

Schedule now to check the PHY state.

Parameters
phythe PHY
expectedStatethe expected state of the PHY

Definition at line 676 of file wifi-phy-ofdma-test.cc.

References DoCheckPhyState(), and ns3::Simulator::ScheduleNow().

Referenced by RunOne().

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

◆ CheckResultsSta1()

void TestDlOfdmaPhyTransmission::CheckResultsSta1 ( uint32_t  expectedRxSuccess,
uint32_t  expectedRxFailure,
uint32_t  expectedRxBytes 
)
private

Check the results for STA 1.

Parameters
expectedRxSuccessthe expected number of RX success
expectedRxFailurethe expected number of RX failures
expectedRxBytesthe expected number of RX bytes

Definition at line 628 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesSta1, m_countRxFailureSta1, m_countRxSuccessSta1, and NS_TEST_ASSERT_MSG_EQ.

Referenced by RunOne().

+ Here is the caller graph for this function:

◆ CheckResultsSta2()

void TestDlOfdmaPhyTransmission::CheckResultsSta2 ( uint32_t  expectedRxSuccess,
uint32_t  expectedRxFailure,
uint32_t  expectedRxBytes 
)
private

Check the results for STA 2.

Parameters
expectedRxSuccessthe expected number of RX success
expectedRxFailurethe expected number of RX failures
expectedRxBytesthe expected number of RX bytes

Definition at line 644 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesSta2, m_countRxFailureSta2, m_countRxSuccessSta2, and NS_TEST_ASSERT_MSG_EQ.

Referenced by RunOne().

+ Here is the caller graph for this function:

◆ CheckResultsSta3()

void TestDlOfdmaPhyTransmission::CheckResultsSta3 ( uint32_t  expectedRxSuccess,
uint32_t  expectedRxFailure,
uint32_t  expectedRxBytes 
)
private

Check the results for STA 3.

Parameters
expectedRxSuccessthe expected number of RX success
expectedRxFailurethe expected number of RX failures
expectedRxBytesthe expected number of RX bytes

Definition at line 660 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesSta3, m_countRxFailureSta3, m_countRxSuccessSta3, and NS_TEST_ASSERT_MSG_EQ.

Referenced by RunOne().

+ Here is the caller graph for this function:

◆ DoCheckPhyState()

void TestDlOfdmaPhyTransmission::DoCheckPhyState ( Ptr< OfdmaSpectrumWifiPhy phy,
WifiPhyState  expectedState 
)
private

Check the PHY state now.

Parameters
phythe PHY
expectedStatethe expected state of the PHY

Definition at line 684 of file wifi-phy-ofdma-test.cc.

References ns3::PointerValue::Get(), ns3::Simulator::Now(), NS_LOG_FUNCTION, and NS_TEST_ASSERT_MSG_EQ.

Referenced by CheckPhyState().

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

◆ DoRun()

void TestDlOfdmaPhyTransmission::DoRun ( )
overrideprivatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 1159 of file wifi-phy-ofdma-test.cc.

References ns3::Simulator::Destroy(), m_channelWidth, m_expectedPpduDuration, m_frequency, ns3::NanoSeconds(), and RunOne().

+ Here is the call graph for this function:

◆ DoSetup()

void TestDlOfdmaPhyTransmission::DoSetup ( )
overrideprivatevirtual

Implementation to do any local setup required for this TestCase.

Subclasses should override this method to perform any costly per-test setup before DoRun is invoked.

Reimplemented from ns3::TestCase.

Definition at line 700 of file wifi-phy-ofdma-test.cc.

References ns3::SpectrumWifiPhy::AddChannel(), ns3::WifiPhy::ConfigureStandard(), m_frequency, m_phyAp, m_phyInterferer, m_phySta1, m_phySta2, m_phySta3, ns3::MakeCallback(), RxFailureSta1(), RxFailureSta2(), RxFailureSta3(), RxSuccessSta1(), RxSuccessSta2(), RxSuccessSta3(), ns3::WaveformGenerator::SetChannel(), ns3::SpectrumWifiPhy::SetDevice(), ns3::WaveformGenerator::SetDevice(), ns3::WaveformGenerator::SetDutyCycle(), ns3::WifiPhy::SetErrorRateModel(), ns3::WifiPhy::SetInterferenceHelper(), ns3::WifiPhy::SetMobility(), ns3::WifiPhy::SetReceiveErrorCallback(), ns3::WifiPhy::SetReceiveOkCallback(), and ns3::WIFI_STANDARD_80211ax.

+ Here is the call graph for this function:

◆ DoTeardown()

void TestDlOfdmaPhyTransmission::DoTeardown ( )
overrideprivatevirtual

Implementation to do any local setup required for this TestCase.

Subclasses should override this method to perform any costly per-test teardown

Reimplemented from ns3::TestCase.

Definition at line 793 of file wifi-phy-ofdma-test.cc.

References ns3::Object::Dispose(), m_phyAp, m_phyInterferer, m_phySta1, m_phySta2, and m_phySta3.

+ Here is the call graph for this function:

◆ GenerateInterference()

void TestDlOfdmaPhyTransmission::GenerateInterference ( Ptr< SpectrumValue interferencePsd,
Time  duration 
)
private

Generate interference function.

Parameters
interferencePsdthe PSD of the interference to be generated
durationthe duration of the interference

Definition at line 555 of file wifi-phy-ofdma-test.cc.

References m_phyInterferer, ns3::Simulator::Schedule(), ns3::WaveformGenerator::SetPeriod(), ns3::WaveformGenerator::SetTxPowerSpectralDensity(), ns3::WaveformGenerator::Start(), and StopInterference().

Referenced by RunOne().

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

◆ ResetResults()

void TestDlOfdmaPhyTransmission::ResetResults ( )
private

Reset the results.

Definition at line 467 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesSta1, m_countRxBytesSta2, m_countRxBytesSta3, m_countRxFailureSta1, m_countRxFailureSta2, m_countRxFailureSta3, m_countRxSuccessSta1, m_countRxSuccessSta2, and m_countRxSuccessSta3.

Referenced by RunOne().

+ Here is the caller graph for this function:

◆ RunOne()

void TestDlOfdmaPhyTransmission::RunOne ( )
private

Run one function.

Definition at line 808 of file wifi-phy-ofdma-test.cc.

References ns3::WifiPhy::AssignStreams(), CheckPhyState(), CheckResultsSta1(), CheckResultsSta2(), CheckResultsSta3(), ns3::BandInfo::fc, ns3::BandInfo::fh, ns3::WifiPhyOperatingChannel::FindFirst(), ns3::BandInfo::fl, GenerateInterference(), m_channelWidth, m_expectedPpduDuration, m_frequency, m_phyAp, m_phySta1, m_phySta2, m_phySta3, ns3::MicroSeconds(), ns3::MilliSeconds(), ns3::NanoSeconds(), ResetResults(), ns3::Simulator::Run(), ns3::Simulator::Schedule(), ns3::Seconds(), SendMuPpdu(), ns3::WifiPhy::SetOperatingChannel(), ns3::RngSeedManager::SetRun(), ns3::RngSeedManager::SetSeed(), ns3::WIFI_PHY_BAND_5GHZ, and ns3::WIFI_STANDARD_80211ax.

Referenced by DoRun().

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

◆ RxFailureSta1()

void TestDlOfdmaPhyTransmission::RxFailureSta1 ( Ptr< const WifiPsdu psdu)
private

Receive failure function for STA 1.

Parameters
psduthe PSDU

Definition at line 607 of file wifi-phy-ofdma-test.cc.

References m_countRxFailureSta1, and NS_LOG_FUNCTION.

Referenced by DoSetup().

+ Here is the caller graph for this function:

◆ RxFailureSta2()

void TestDlOfdmaPhyTransmission::RxFailureSta2 ( Ptr< const WifiPsdu psdu)
private

Receive failure function for STA 2.

Parameters
psduthe PSDU

Definition at line 614 of file wifi-phy-ofdma-test.cc.

References m_countRxFailureSta2, and NS_LOG_FUNCTION.

Referenced by DoSetup().

+ Here is the caller graph for this function:

◆ RxFailureSta3()

void TestDlOfdmaPhyTransmission::RxFailureSta3 ( Ptr< const WifiPsdu psdu)
private

Receive failure function for STA 3.

Parameters
psduthe PSDU

Definition at line 621 of file wifi-phy-ofdma-test.cc.

References m_countRxFailureSta3, and NS_LOG_FUNCTION.

Referenced by DoSetup().

+ Here is the caller graph for this function:

◆ RxSuccessSta1()

void TestDlOfdmaPhyTransmission::RxSuccessSta1 ( Ptr< const WifiPsdu psdu,
RxSignalInfo  rxSignalInfo,
WifiTxVector  txVector,
std::vector< bool >  statusPerMpdu 
)
private

Receive success function for STA 1.

Parameters
psduthe PSDU
rxSignalInfothe info on the received signal (
See also
RxSignalInfo)
Parameters
txVectorthe transmit vector
statusPerMpdureception status per MPDU

Definition at line 574 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesSta1, m_countRxSuccessSta1, and NS_LOG_FUNCTION.

Referenced by DoSetup().

+ Here is the caller graph for this function:

◆ RxSuccessSta2()

void TestDlOfdmaPhyTransmission::RxSuccessSta2 ( Ptr< const WifiPsdu psdu,
RxSignalInfo  rxSignalInfo,
WifiTxVector  txVector,
std::vector< bool >  statusPerMpdu 
)
private

Receive success function for STA 2.

Parameters
psduthe PSDU
rxSignalInfothe info on the received signal (
See also
RxSignalInfo)
Parameters
txVectorthe transmit vector
statusPerMpdureception status per MPDU

Definition at line 585 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesSta2, m_countRxSuccessSta2, and NS_LOG_FUNCTION.

Referenced by DoSetup().

+ Here is the caller graph for this function:

◆ RxSuccessSta3()

void TestDlOfdmaPhyTransmission::RxSuccessSta3 ( Ptr< const WifiPsdu psdu,
RxSignalInfo  rxSignalInfo,
WifiTxVector  txVector,
std::vector< bool >  statusPerMpdu 
)
private

Receive success function for STA 3.

Parameters
psduthe PSDU
rxSignalInfothe info on the received signal (
See also
RxSignalInfo)
Parameters
txVectorthe transmit vector
statusPerMpdureception status per MPDU

Definition at line 596 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesSta3, m_countRxSuccessSta3, and NS_LOG_FUNCTION.

Referenced by DoSetup().

+ Here is the caller graph for this function:

◆ SendMuPpdu()

void TestDlOfdmaPhyTransmission::SendMuPpdu ( uint16_t  rxStaId1,
uint16_t  rxStaId2 
)
private

Send MU-PPDU function.

Parameters
rxStaId1the ID of the recipient STA for the first PSDU
rxStaId2the ID of the recipient STA for the second PSDU

Definition at line 481 of file wifi-phy-ofdma-test.cc.

References ns3::HePhy::GetHeMcs7(), ns3::HePhy::GetHeMcs9(), ns3::VhtPhy::GetVhtMcs5(), m_channelWidth, m_phyAp, NS_ASSERT_MSG, NS_LOG_FUNCTION, ns3::HeRu::RU_106_TONE, ns3::HeRu::RU_242_TONE, ns3::HeRu::RU_484_TONE, ns3::HeRu::RU_996_TONE, ns3::WifiPhy::Send(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetNss(), ns3::WifiMacHeader::SetQosTid(), ns3::WifiTxVector::SetRu(), ns3::WifiTxVector::SetRuAllocation(), ns3::WifiMacHeader::SetSequenceNumber(), ns3::WifiTxVector::SetSigBMode(), ns3::WifiMacHeader::SetType(), ns3::WIFI_MAC_QOSDATA, and ns3::WIFI_PREAMBLE_HE_MU.

Referenced by RunOne().

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

◆ StopInterference()

void TestDlOfdmaPhyTransmission::StopInterference ( )
private

Stop interference function.

Definition at line 564 of file wifi-phy-ofdma-test.cc.

References m_phyInterferer, and ns3::WaveformGenerator::Stop().

Referenced by GenerateInterference().

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

Member Data Documentation

◆ m_channelWidth

uint16_t TestDlOfdmaPhyTransmission::m_channelWidth
private

channel width in MHz

Definition at line 445 of file wifi-phy-ofdma-test.cc.

Referenced by DoRun(), RunOne(), and SendMuPpdu().

◆ m_countRxBytesSta1

uint32_t TestDlOfdmaPhyTransmission::m_countRxBytesSta1
private

count RX bytes for STA 1

Definition at line 434 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta1(), ResetResults(), and RxSuccessSta1().

◆ m_countRxBytesSta2

uint32_t TestDlOfdmaPhyTransmission::m_countRxBytesSta2
private

count RX bytes for STA 2

Definition at line 435 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta2(), ResetResults(), and RxSuccessSta2().

◆ m_countRxBytesSta3

uint32_t TestDlOfdmaPhyTransmission::m_countRxBytesSta3
private

count RX bytes for STA 3

Definition at line 436 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta3(), ResetResults(), and RxSuccessSta3().

◆ m_countRxFailureSta1

uint32_t TestDlOfdmaPhyTransmission::m_countRxFailureSta1
private

count RX failure for STA 1

Definition at line 431 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta1(), ResetResults(), and RxFailureSta1().

◆ m_countRxFailureSta2

uint32_t TestDlOfdmaPhyTransmission::m_countRxFailureSta2
private

count RX failure for STA 2

Definition at line 432 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta2(), ResetResults(), and RxFailureSta2().

◆ m_countRxFailureSta3

uint32_t TestDlOfdmaPhyTransmission::m_countRxFailureSta3
private

count RX failure for STA 3

Definition at line 433 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta3(), ResetResults(), and RxFailureSta3().

◆ m_countRxSuccessSta1

uint32_t TestDlOfdmaPhyTransmission::m_countRxSuccessSta1
private

count RX success for STA 1

Definition at line 428 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta1(), ResetResults(), and RxSuccessSta1().

◆ m_countRxSuccessSta2

uint32_t TestDlOfdmaPhyTransmission::m_countRxSuccessSta2
private

count RX success for STA 2

Definition at line 429 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta2(), ResetResults(), and RxSuccessSta2().

◆ m_countRxSuccessSta3

uint32_t TestDlOfdmaPhyTransmission::m_countRxSuccessSta3
private

count RX success for STA 3

Definition at line 430 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta3(), ResetResults(), and RxSuccessSta3().

◆ m_expectedPpduDuration

Time TestDlOfdmaPhyTransmission::m_expectedPpduDuration
private

expected duration to send MU PPDU

Definition at line 446 of file wifi-phy-ofdma-test.cc.

Referenced by DoRun(), and RunOne().

◆ m_frequency

uint16_t TestDlOfdmaPhyTransmission::m_frequency
private

frequency in MHz

Definition at line 444 of file wifi-phy-ofdma-test.cc.

Referenced by DoRun(), DoSetup(), and RunOne().

◆ m_phyAp

Ptr<SpectrumWifiPhy> TestDlOfdmaPhyTransmission::m_phyAp
private

PHY of AP.

Definition at line 438 of file wifi-phy-ofdma-test.cc.

Referenced by DoSetup(), DoTeardown(), RunOne(), and SendMuPpdu().

◆ m_phyInterferer

Ptr<WaveformGenerator> TestDlOfdmaPhyTransmission::m_phyInterferer
private

PHY of interferer.

Definition at line 442 of file wifi-phy-ofdma-test.cc.

Referenced by DoSetup(), DoTeardown(), GenerateInterference(), and StopInterference().

◆ m_phySta1

Ptr<OfdmaSpectrumWifiPhy> TestDlOfdmaPhyTransmission::m_phySta1
private

PHY of STA 1.

Definition at line 439 of file wifi-phy-ofdma-test.cc.

Referenced by DoSetup(), DoTeardown(), and RunOne().

◆ m_phySta2

Ptr<OfdmaSpectrumWifiPhy> TestDlOfdmaPhyTransmission::m_phySta2
private

PHY of STA 2.

Definition at line 440 of file wifi-phy-ofdma-test.cc.

Referenced by DoSetup(), DoTeardown(), and RunOne().

◆ m_phySta3

Ptr<OfdmaSpectrumWifiPhy> TestDlOfdmaPhyTransmission::m_phySta3
private

PHY of STA 3.

Definition at line 441 of file wifi-phy-ofdma-test.cc.

Referenced by DoSetup(), DoTeardown(), and RunOne().


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