User Manual, Developers Guide and API Documentation

IEvent.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. 16, 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_EVENTS_SCHEDULER_IEVENT_HPP
#define WNS_EVENTS_SCHEDULER_IEVENT_HPP

#include <WNS/RefCountable.hpp>
#include <WNS/simulator/Time.hpp>
#include <WNS/SmartPtr.hpp>
#include <WNS/events/scheduler/Callable.hpp>
#include <WNS/PythonicOutput.hpp>

namespace wns { namespace events { namespace scheduler {

    class IEvent :
    virtual public wns::RefCountable,
        virtual public wns::PythonicOutput
    {
    public:
        class CancelException :
            wns::Exception
        {
        public:
            CancelException(const std::string& s);
            ~CancelException() throw() {}
        };

        virtual
        ~IEvent();

        virtual wns::simulator::Time
        getScheduled() const = 0;

        virtual wns::simulator::Time
        getIssued() const = 0;

        virtual void
        cancel() = 0;

        virtual bool
        isNotSubmitted() const = 0;

        virtual bool
        isQueued() const = 0;

        virtual bool
        isRunning() const = 0;

        virtual bool
        isFinished() const = 0;

        virtual bool
        isCanceled() const = 0;

    protected:
        virtual std::string
        doToString() const;
    };

    typedef wns::SmartPtr<IEvent> IEventPtr;

}
}
}
#endif // NOT defined WNS_EVENTS_SCHEDULER_IEVENT_HPP

---