User Manual, Developers Guide and API Documentation

CommandPool.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_COMMANDPOOL_HPP
#define WNS_LDK_COMMANDPOOL_HPP

#include <WNS/ldk/CommandProxy.hpp>

#include <WNS/osi/PDU.hpp>
#include <WNS/osi/PCI.hpp>
#include <WNS/container/Registry.hpp>

#include <vector>

namespace wns { namespace ldk {

    class FunctionalUnit;
    class Command;
    class CommandTypeSpecifierInterface;

    class CommandPool :
        public wns::osi::PCI
    {
        // Only CommandProxy instances are allowed to create new CommandPool
        // instances and access their data directly.
        friend class CommandProxy;

        typedef std::vector<CommandProxy::CommandIDType> PathContainer;
        typedef std::vector<Command*> CommandContainer;
        // typedef wns::container::Registry<CommandProxy::CommandIDType, Command*> CommandContainer;

    public:
        CommandPool(const CommandPool& that);

        ~CommandPool();

        void
        calculateSizes(
            Bit& commandPoolSize,
            Bit& dataSize,
            const FunctionalUnit* questioner = NULL) const;

        virtual void
        setSDUPtr(wns::osi::PDUPtr& sdu);

        virtual std::string
        dumpCommandTypes() const;

        bool
        knowsSameCommandsAs(const CommandPool& other) const;

        const fun::FUN*
        getOrigin() const { return origin; }

        void
        setReceiver(const fun::FUN* rec) { receiver = rec; }

        const fun::FUN*
        getReceiver() const { return receiver; }

#ifndef NDEBUG
        virtual size_t
        calcObjSize() const;
#endif
    protected:
        CommandPool(const CommandProxy* proxy,
                const fun::FUN* orig);

        PathContainer path;

    private:
        void
        insert(
            const CommandProxy::CommandIDType& id,
            Command* command);

        Command*
        find(const CommandProxy::CommandIDType& id) const;

        bool
        knows(const CommandProxy::CommandIDType& id) const;

        const CommandProxy* proxy;

        CommandContainer commands;

        const wns::ldk::fun::FUN* origin;

        const wns::ldk::fun::FUN* receiver;
    };

} // ldk
} // wns

#endif // NOT defined WNS_LDK_COMMANDPOOL_HPP

---