Event.h

Go to the documentation of this file.

 
/*
 *    scampl4cpp/engine
 *
 *    Copyright by European Southern Observatory, 2012
 *    All rights reserved
 * 
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 2.1 of the License, or (at your option) any later version.
 *
 *    This library 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 library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 *    02111-1307 USA.
 */
 
#ifndef SCXML4CPP_EVENT_H
#define SCXML4CPP_EVENT_H
 
#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif
 
#include <string>
 
namespace scxml4cpp {
 
class Event
{
 public:
 
    enum EventType{
        CALL_EVENT = 0,
        CHANGE_EVENT,
        SIGNAL_EVENT,
        TIME_EVENT,
        ERROR_EVENT
    };
 
    enum EventStatus{
        TOBEPROCESSED = 0,
        PROCESSED,
        IGNORED,
        REJECTED,
        DEFERRED
    };
 
    Event();
 
    Event(const std::string& id, const EventType type);
 
    Event(const Event& e);
 
    Event& operator=(const Event& e);
 
    virtual ~Event();
 
    const std::string& getId() const;
 
    const EventType   getType() const;
 
    const EventStatus getStatus() const;
 
    void*       getPayload() const;
 
    void        setId(const std::string& id);
 
    void        setType(const EventType type);
 
    void        setStatus(const EventStatus status);
 
    void        setPayload(void* payload);
 
    bool        isNull() const;
 
 private:
    std::string mId;        
    EventType   mType;      
    EventStatus mStatus;    
    void*       mPayload;   
};
 
}  // namespace scxml4cpp
 
#endif  // SCXML4CPP_EVENT_H