User Manual, Developers Guide and API Documentation

CommandTypeSpecifier.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_COMMANDTYPESPECIFIER_HPP
#define WNS_LDK_COMMANDTYPESPECIFIER_HPP

#include <WNS/ldk/fun/FUN.hpp>
#include <WNS/ldk/Command.hpp>
#include <WNS/ldk/FunctionalUnit.hpp>
#include <WNS/ldk/Connector.hpp>
#include <WNS/ldk/CommandReaderInterface.hpp>

#include <WNS/Assure.hpp>

#include <WNS/osi/PCI.hpp>

#include <vector>
#include <cstdlib>              // NULL, size_t
#include <limits>


namespace wns { namespace ldk {
    class CommandPool;

    template <typename T = EmptyCommand>
    class CommandTypeSpecifier :
        public virtual CommandTypeSpecifierInterface
    {
    public:
        typedef T COMMANDTYPE;

        CommandTypeSpecifier(fun::FUN* _fun) :
                fuNet(_fun)
        {
            assure(fuNet, "No fuNet, my friend. No fuNet.");
            // assure, that every Command contains the following entries
            int satisfyCompiler;
            satisfyCompiler = sizeof(&COMMANDTYPE::local);
            satisfyCompiler = sizeof(&COMMANDTYPE::peer);
            satisfyCompiler = sizeof(&COMMANDTYPE::magic);
        }

        virtual ~CommandTypeSpecifier()
        {}

        CommandTypeSpecifier(const CommandTypeSpecifier& other) :
            CommandTypeSpecifierInterface(),
            fuNet(other.fuNet)
        {
        }

        CommandTypeSpecifier&
        operator=(const CommandTypeSpecifier& other)
        {
            assure(fuNet == other.fuNet, "Assignment is only supported within the same fun");
            fuNet = other.fuNet;
        }

        COMMANDTYPE* getCommand(const CommandPool* commandPool) const
        {
            assure(commandPool != NULL, "Invalid argument.");

            Command* command = getFUN()->getProxy()->getCommand(commandPool, this);

            assureType(command, COMMANDTYPE*);
            return static_cast<COMMANDTYPE*>(command);
        }

        COMMANDTYPE* getCommand(const CompoundPtr& compound) const
        {
            assure(compound != CompoundPtr(), "Invalid argument.");
            return this->getCommand(compound->getCommandPool());
        }

        COMMANDTYPE* activateCommand(CommandPool* commandPool) const
        {
            assure(commandPool != NULL, "Invalid argument.");
            Command* command = getFUN()->getProxy()->activateCommand(commandPool, this);
            assureType(command, COMMANDTYPE*);
            return static_cast<COMMANDTYPE*>(command);
        }

        void commitSizes(CommandPool* commandPool) const
        {
            assure(commandPool, "Invalid argument.");
            getFUN()->getProxy()->commitSizes(commandPool, this);
        }
    public:
        virtual CommandPool*
        createReply(const CommandPool* original) const
        {
            return getFUN()->getProxy()->createReply(original, this);
        } // createReply

        virtual void
        calculateSizes(const CommandPool* commandPool, Bit& commandPoolSize, Bit& dataSize) const
        {
            getFUN()->getProxy()->calculateSizes(commandPool, commandPoolSize, dataSize, this);
            Command* command = getFUN()->getProxy()->getCommand(commandPool, this);

            commandPoolSize += command->getSize();
        } // calculateSizes

        virtual Bit
        getLengthInBits(const CompoundPtr& compound) const
        {
            Bit commandPoolSize;
            Bit sduSize;

            getFUN()->getProxy()->calculateSizes(compound->getCommandPool(), commandPoolSize, sduSize, this);
            return commandPoolSize + sduSize;
        } // getLengthInBits

        virtual fun::FUN*
        getFUN() const
        {
            return fuNet;
        } // getFUN

        virtual CopyCommandInterface*
        getCopyCommandInterface() const
        {
            return new CopyCommand<COMMANDTYPE>;
        }

#ifndef NDEBUG
        virtual size_t
        getCommandObjSize() const
        {
            return sizeof( COMMANDTYPE );
        }
#endif

    private:
        COMMANDTYPE*
        createCommand() const
        {
            return new COMMANDTYPE();
        } // createCommand

        COMMANDTYPE*
        copyCommand(const Command* src) const
        {
            CopyCommand<COMMANDTYPE> f;
            return f.copy(src);
        } // copyCommand


        template<typename COMMAND>
        class CopyCommand :
            virtual public CopyCommandInterface
        {
        public:
            virtual
            ~CopyCommand(){}

            virtual COMMAND*
            copy(const Command* src) const
            {
                assureType(src, const COMMAND*);
                return new COMMAND(*(dynamic_cast<const COMMAND*>(src)));
            }
        };

        class CommandReader :
            virtual public CommandReaderInterface
        {
            const unsigned long int id;
            CommandProxy* proxy;

            virtual CommandProxy*
            getProxy() const
            {
                return proxy;
            }

            virtual const unsigned long int
            getPCIID() const
            {
                return id;
            }

        public:
            CommandReader(const unsigned long int _id, CommandProxy* _proxy) :
                id(_id),
                proxy(_proxy)
            {}

            virtual
            ~CommandReader(){}

            virtual bool
            commandIsActivated(const CommandPool* commandPool) const
            {
                assure(commandPool != NULL, "Invalid argument.");
                return proxy->commandIsActivated(commandPool, id);
            }

        };

        virtual CommandReaderInterface*
        getCommandReader(CommandProxy* proxy)
        {
            return new CommandReader(this->getPCIID(), proxy);
        }

        fun::FUN* fuNet;
    };

} // ldk
} // wns

#endif // NOT defined WNS_LDK_COMMANDTYPESPECIFIER_HPP

---