object.h

Go to the documentation of this file.
00001 /** @file nub/object.h base class for objects to be exposed to a
00002     scripting language */
00003 
00004 ///////////////////////////////////////////////////////////////////////
00005 //
00006 // Copyright (c) 2001-2004 California Institute of Technology
00007 // Copyright (c) 2004-2007 University of Southern California
00008 // Rob Peters <rjpeters at usc dot edu>
00009 //
00010 // created: Tue Jun  5 10:23:15 2001
00011 // commit: $Id: object.h 8249 2007-04-12 06:03:40Z rjpeters $
00012 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/nub/object.h $
00013 //
00014 // --------------------------------------------------------------------
00015 //
00016 // This file is part of GroovX.
00017 //   [http://ilab.usc.edu/rjpeters/groovx/]
00018 //
00019 // GroovX is free software; you can redistribute it and/or modify it
00020 // under the terms of the GNU General Public License as published by
00021 // the Free Software Foundation; either version 2 of the License, or
00022 // (at your option) any later version.
00023 //
00024 // GroovX is distributed in the hope that it will be useful, but
00025 // WITHOUT ANY WARRANTY; without even the implied warranty of
00026 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00027 // General Public License for more details.
00028 //
00029 // You should have received a copy of the GNU General Public License
00030 // along with GroovX; if not, write to the Free Software Foundation,
00031 // Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
00032 //
00033 ///////////////////////////////////////////////////////////////////////
00034 
00035 #ifndef GROOVX_NUB_OBJECT_H_UTC20050626084018_DEFINED
00036 #define GROOVX_NUB_OBJECT_H_UTC20050626084018_DEFINED
00037 
00038 #include "nub/refcounted.h"
00039 #include "nub/uid.h"
00040 
00041 namespace rutz
00042 {
00043   class fstring;
00044 }
00045 
00046 namespace nub
00047 {
00048   class object;
00049 }
00050 
00051 ///////////////////////////////////////////////////////////////////////
00052 /**
00053  *
00054  * nub::object is a base class for objects that are to be exposed to a
00055  * scripting language. Associates with each object a unique integer
00056  * identifier. nub::object's are reference counted for automatic
00057  * memory management, and are generally passed around via nub::ref's
00058  * or nub::soft_ref's, which automatically manage the reference count.
00059  *
00060  **/
00061 ///////////////////////////////////////////////////////////////////////
00062 
00063 
00064 class nub::object : public nub::ref_counted
00065 {
00066 protected:
00067   /// Default constructor.
00068   /** Can't have an empty throw() spec here, because ref_counted's
00069       constructor might throw (because it has to allocate memory for
00070       a nub::ref_counts object). */
00071   object();
00072 
00073   /// Virtual destructor.
00074   virtual ~object() GVX_DTOR_NOTHROW;
00075 
00076 public:
00077   /** Returns the unique id for this object. The unique id will always
00078       be strictly positive; zero is always an invalid unique id. */
00079   nub::uid id() const throw();
00080 
00081   /// Returns the typename of the full object.
00082   /** The result is a demangled version of \c typeid(*this).name(), which
00083       should very closely resemble the way the object was declared in
00084       source code. */
00085   rutz::fstring real_typename() const;
00086 
00087   /// Returns the (apparent) typename of the full object.
00088   /** The default implementation just returns real_typename(). However,
00089       certain kinds of objects -- e.g., proxy objects -- might usefully
00090       choose to have obj_typename() return something besides the
00091       real_typename(), in order to masquerade as a different type of
00092       object.  */
00093   virtual rutz::fstring obj_typename() const;
00094 
00095   /// Returns a short string describing the object by its typename and id.
00096   rutz::fstring unique_name() const;
00097 
00098 private:
00099   nub::uid m_uid;
00100 };
00101 
00102 static const char __attribute__((used)) vcid_groovx_nub_object_h_utc20050626084018[] = "$Id: object.h 8249 2007-04-12 06:03:40Z rjpeters $ $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/nub/object.h $";
00103 #endif // !GROOVX_NUB_OBJECT_H_UTC20050626084018_DEFINED
Generated on Sun May 8 08:41:07 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3