VRS - The Virtual Rendering System

version 3.3

sharedobj.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2000-2008 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * 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 FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

#ifndef VRS_CORE_SHAREDOBJ_H
#define VRS_CORE_SHAREDOBJ_H

#include <vrs/config.h>
#include <vrs/serializationmacros.h>
#include <vrs/transactionno.h>
#include <vrs/typeinfo.h>
#include <vrs/visitor.h>

namespace VRS {

class CallbackBase;
template<typename T> class Callback1;
template<typename T> class Iterator;
template<class T> class SO;
class WeakPointerBase;
template<class T> class WO;

class VRS_CORE_API SharedObj :
    public Visitable
{
public:
    SharedObj(); // default ctor
    SharedObj(const SharedObj& other); // copy-ctor
    virtual ~SharedObj(); // dtor






    virtual bool isEqual(const SharedObj* other) const;
    static bool IsEqual(const SharedObj* obj1, const SharedObj* obj2);
    bool operator==(const SharedObj& other) const;

    static const ClassInfo* ClassInfoVRS();
    virtual const ClassInfo* classInfoVRS() const;

    static const ID& ClassNameVRS();
    const ID& classNameVRS() const;
    bool isA(const ID& id) const;
    void ref(const void* debugPointerHolder = NULL) const;
    void unref(const void* debugPointerHolder = NULL) const;
    long references() const;
    void trackReferences();
    void outputReferences() const;
    static void outputAllTrackedObjectReferences();
    void setObjectName(const char* objName);
    void setObjectName(const std::string& objName);
    std::string getObjectName() const;
    static SO<SharedObj> getObjectByName(const std::string& objName);
    void setClientData(void* clientData);
    void* getClientData() const;
    
    virtual void modified();
    virtual const TransactionNo& lastTransactionNo() const;
    static const TransactionNo& currentTransactionNo();
    void registerDestructionCB(SO<Callback1<SharedObj*> > cb);
    void registerModificationCB(SO<Callback1<SharedObj*> > cb);
    void unregisterDestructionCB(SO<Callback1<SharedObj*> > cb);
    void unregisterModificationCB(SO<Callback1<SharedObj*> > cb);
    typedef SharedObj VRS_ThisClass;
    VRS_SERIALIZABLE(SharedObj);
    VRS_VISITABLE_BASE;

protected:
    void registerCB(const ID& service, SO<CallbackBase> cb);

    bool unregisterCB(const ID& service, SO<CallbackBase> cb);
    SO<Iterator<SO<CallbackBase> > > callbacks(const ID& service) const;

protected:
    friend class WeakPointerBase;

    void registerWO(const WeakPointerBase* wo) const;
    void unregisterWO(const WeakPointerBase* wo) const;

private:
    SharedObj& operator=(const SharedObj&);

    TransactionNo m_transactionNo;
    mutable long m_references; // use a compatible data type for WIN32 interlocked operations

    class AdditionalData;
    mutable int m_additionalDataFlags;
    mutable AdditionalData* m_additionalData;
}; // class SharedObj

} // namespace VRS

// always include the following files
#include <vrs/serializationmanager.h>
#include <vrs/so.h>
#include <vrs/errorhandler.h>

#endif // VRS_SHAREDOBJ_H

---

Generated on Thu May 24 06:00:15 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact