User Manual, Developers Guide and API Documentation

Stub.hpp

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2007
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 5, D-52074 Aachen, Germany
 * phone: ++49-241-80-27910,
 * fax: ++49-241-80-22242
 * 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 WNS_LDK_TOOLS_STUB_HPP
#define WNS_LDK_TOOLS_STUB_HPP

#include <WNS/ldk/CommandTypeSpecifier.hpp>
#include <WNS/ldk/HasReceptor.hpp>
#include <WNS/ldk/HasConnector.hpp>
#include <WNS/ldk/HasDeliverer.hpp>
#include <WNS/ldk/Command.hpp>

#include <WNS/Cloneable.hpp>
#include <WNS/pyconfig/View.hpp>

#include <deque>


namespace wns { namespace ldk { namespace tools {

    class StubCommand :
        public wns::ldk::Command
    {
    public:
        StubCommand()
        {
            // initialize to something invalid
            this->magic.sendDataTime = -1.0;
            // initialize to something invalid
            this->magic.onDataTime = -1.0;
                        this->magic.sequenceNumber = 0;
        }

        struct {
        } local;

        struct {
        } peer;

        struct {
            // when has sendData been called?
            simTimeType sendDataTime;
            // when has onData been called?
            simTimeType onDataTime;
                    int sequenceNumber;
        } magic;
    };

    class StubBase :
        public virtual FunctionalUnit,
        public HasReceptor<>,
        public HasConnector<>,
        public HasDeliverer<>
    {
    public:
        typedef std::deque<CompoundPtr> ContainerType;

        virtual
        ~StubBase();

        void
        setStepping(bool _stepping);

        void
        setSizes(Bit addToPCISize, Bit addToPDUSize);

        void
        setAcceptanceSize(Bit compoundSize);

        void
        flush();

        void
        open(bool wakeup = true);

        void
        close();

        void
        step();

        virtual void
        calculateSizes(const CommandPool* commandPool, Bit& commandPoolSize, Bit& dataSize) const;

        virtual void
        onFUNCreated();

        bool
        integrityCheck();

        ContainerType received;

        ContainerType sent;

        long wakeupCalled;

        long onFUNCreatedCalled;

    protected:
        StubBase();

    protected:
        // CompoundHandlerInterface
        virtual void
        doSendData(const CompoundPtr& sdu);

        virtual void
        doOnData(const CompoundPtr& compound);

        virtual bool
        doIsAccepting(const CompoundPtr& compound) const;

        virtual void
        doWakeup();

        bool stepping;
        bool accepting;

        int addToPCISize;
        int addToPDUSize;
            int compoundAcceptanceSize;
    }; // StubBase


    class Stub :
        public StubBase,
        public CommandTypeSpecifier<StubCommand>,
        public Cloneable<Stub>
    {
    public:
        Stub(fun::FUN* fuNet, const pyconfig::View& config);

        // we need a unique overrider
        virtual void
        calculateSizes(const CommandPool* commandPool, Bit& commandPoolSize, Bit& dataSize) const
        {
            StubBase::calculateSizes(commandPool, commandPoolSize, dataSize);
        } // calculateSizes

    private:
        virtual void
        doSendData(const CompoundPtr& sdu);

        virtual void
        doOnData(const CompoundPtr& sdu);

            int sequenceNumber;
    }; // Stub

}}}


#endif // NOT defined WNS_LDK_TOOLS_STUB_HPP

---