User Manual, Developers Guide and API Documentation

Command.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_COMMAND_HPP
#define WNS_LDK_COMMAND_HPP

#include <WNS/simulator/Bit.hpp>
#include <WNS/Assure.hpp>

#include <cstdlib>

namespace wns { namespace ldk {

    class Command
    {
        friend class CommandProxy;

    public:
        Command() :
            commited(false),
            commandPoolSize(0),
            payloadSize(0)
        {}

        virtual
        ~Command()
        {}

        virtual Bit
        getSize() const
        {
            return 0;
        }

    private:
        bool sizeCommited() const
            {
            return commited;
        }

        Bit getCommandPoolSize() const
        {
            assure(commited, "You may only retrieve the size of the command pool after committing!");
            return commandPoolSize;
        }

        void setCommandPoolSize(const Bit size)
        {
            assure(!commited, "You may not modify the size after commiting!");
            commandPoolSize = size;
        }

        Bit getPayloadSize() const
        {
            assure(commited, "You may only retrieve the size of the payload after committing!");
            return payloadSize;
        }

        void setPayloadSize(const Bit size)
        {
            assure(!commited, "You may not modify the size after commiting!");
            payloadSize = size;
        }
        void commit()
        {
            assure(!commited, "You may not commit the size of the command twice!");
            commited = true;
        }

        bool commited;
        Bit commandPoolSize;
        Bit payloadSize;

    };

    class EmptyCommand :
        public Command
    {
    public:
        EmptyCommand() :
            local(),
            peer(),
            magic()
        {}

        struct {} local;

        struct {} peer;

        struct {} magic;
    };

} // ldk
} // wns

#endif // NOT defined WNS_LDK_COMMAND_HPP

---