User Manual, Developers Guide and API Documentation

Component.hpp

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2009
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 5, D-52074 Aachen, Germany
 * email: info@openwns.org
 * www: http://www.openwns.org
 * _____________________________________________________________________________
 *
 * openWNS is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 2 as published by the
 * Free Software Foundation;
 *
 * openWNS is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/


#ifndef WIMAC_COMPONENT_HPP
#define WIMAC_COMPONENT_HPP
#include <WNS/node/component/Component.hpp>
#include <WNS/ldk/Layer.hpp>
#include <WNS/service/phy/ofdma/DataTransmission.hpp>
#include <WNS/probe/bus/ContextProvider.hpp>
#include <WNS/probe/bus/ContextProviderCollection.hpp>
#include <WNS/service/dll/DataTransmission.hpp>
#include <WNS/ldk/fun/Main.hpp>

#include <WIMAC/ConnectionIdentifier.hpp>


namespace wimac {

    namespace service {
        class ControlPlaneManagerInterface;
        class ConnectionManager;
    }

    class FunctionalUnit;
    class CommandProxy;

    class StationType
    {
    public:
        enum {
            AP,
            FRS,
            UT,
            RT
        };

        static std::string toString(int type)
        {
            switch (type)
            {
            case AP:
                return "AP";
            case FRS:
                return "FRS";
            case UT:
                return "UT";
            case RT:
                return "RT";
            default:
                wns::Exception e("Unknown station type with id: ");
                e << type;
                throw e;
            }
        }
    };

    class Component:
        public wns::node::component::Component,
        public wns::ldk::Layer,
        public wns::probe::bus::ContextProvider
    {
    public:
        typedef ConnectionIdentifier::StationID StationID;
        typedef ConnectionIdentifier::QoSCategory QoSCategory;

        Component(wns::node::Interface*, const wns::pyconfig::View&);

        std::string
        getName() const;

        unsigned int getCellID() const;

        unsigned int getID() const
        {
            return id_;
        }


        unsigned int getRing() const;

        wns::service::dll::UnicastAddress getDLLAddress() const
        {
            return address_;
        }

        wns::ldk::fun::Main*
        getFUN();

        int getNumberOfQueuedPDUs(ConnectionIdentifiers cis);

        // ComponentInterface
        virtual void onNodeCreated();
        virtual void onWorldCreated();
        virtual void onShutdown();

        int getStationType() const
        {
            return stationType_;
        }

        void doVisit(wns::probe::bus::IContext&) const;


        wns::service::dll::UnicastAddress
        getMACAddress() const
        {
            return address_;
        }

    private:
        Component(const Component&); // disallow copy constructor
        Component& operator=(const Component&); // disallow assignment

        virtual void
        doStartup();


        wns::ldk::fun::Main* fun_;

        //Values form PyConfig
        int stationType_;
        unsigned int id_;
        wns::service::dll::UnicastAddress address_;
        unsigned int ring_;

        wns::probe::bus::ContextProviderCollection contextProviders_;
    };
}

#endif

---