Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

Event.h

00001 /*
00002  * Event.h -- class interface for events
00003  * Copyright (C) 2002  Eric Lemings <elemings@users.sourceforge.net>
00004  *
00005  * This software is free software; you can redistribute it and/or
00006  * modify it under the terms of the GNU General Public License
00007  * as published by the Free Software Foundation; either version 2
00008  * of the License, or (at your option) any later version.
00009  *
00010  * This software is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013  * GNU General Public License for more details.
00014  *
00015  * You should have received a copy of the GNU General Public License
00016  * along with this software; if not, write to the Free Software
00017  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
00018  * 02111-1307, USA
00019  *
00020  * RCS: $Id: Event.h,v 1.3 2003/04/08 21:43:14 elemings Exp $
00021  */
00022 
00023 #ifdef __cplusplus
00024 
00025 #  ifndef OGS_SUPPORT_EVENT_H
00026 #    define OGS_SUPPORT_EVENT_H
00027 
00028 #    include <string>
00029 
00030 #    include <ogs/support/Namespace.h>
00031 
00032 OGS_BEGIN_SUPPORT_NAMESPACE
00033 
00034 class Object;
00035 
00044 class Event {
00045   public:
00046     Event (Object& object);
00047     virtual ~Event () { }
00048 
00049     Object& getSource () const;
00050     virtual std::string toString () const;
00051 
00052   private:
00053     /*
00054      * The lifetime of the source is assumed to outlast the lifetime of
00055      * events that it creates.  If this assumption proves false, the
00056      * source type and perhaps the interface will have to be changed.
00057      */
00058     Object& _source;
00059 };
00060 
00066 inline Event::Event (Object& object):
00067   _source (object) {
00068   // empty constructor
00069 }
00070 
00076 inline Object&
00077 Event::getSource () const {
00078   return (this->_source);
00079 }
00080 
00081 OGS_END_SUPPORT_NAMESPACE
00082 
00083 #  endif /* !defined OGS_SUPPORT_EVENT_H */
00084 
00085 #endif /* defined __cplusplus */
00086 

Generated on Sun Apr 20 03:36:18 2003 for Open Gaming System (OGS) by doxygen1.3