OSGRemoteAspect.h

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 *                                OpenSG                                     *
 *                                                                           *
 *                                                                           *
 *             Copyright (C) 2000-2002 by the OpenSG Forum                   *
 *                                                                           *
 *                            www.opensg.org                                 *
 *                                                                           *
 *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
 *                                                                           *
\*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*\
 *                                License                                    *
 *                                                                           *
 * This library is free software; you can redistribute it and/or modify it   *
 * under the terms of the GNU Library General Public License as published    *
 * by the Free Software Foundation, version 2.                               *
 *                                                                           *
 * 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         *
 * Library General Public License for more details.                          *
 *                                                                           *
 * You should have received a copy of the GNU Library General Public         *
 * License along with this library; if not, write to the Free Software       *
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
 *                                                                           *
\*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*\
 *                                Changes                                    *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
\*---------------------------------------------------------------------------*/


#ifndef _REMOTEASPECT_H_
#define _REMOTEASPECT_H_
#ifdef __sgi
#pragma once
#endif

#include <map>
#include <set>
#include <OSGSystemDef.h>
#include <OSGBaseTypes.h>
#include <OSGFieldContainerPtr.h>
#include <OSGFieldContainerFactory.h>
#include <OSGChangeList.h>
#include <OSGConnection.h>
#include <OSGTypedFunctors.h>
#include <OSGStatCollector.h>
#include <OSGStatElemTypes.h>

OSG_BEGIN_NAMESPACE

class OSG_SYSTEMLIB_DLLMAPPING RemoteAspect
{ 
    /*==========================  PUBLIC  =================================*/
  public:
    enum DataTypes 
    {
        SYNCENDED =1,
        CREATED   =2,
        DESTROYED =3,
        NEWTYPE   =4,
        CHANGED   =5,
        ADDREFED  =6,
        SUBREFED  =7,
        IDMAPPING =8
    };

    typedef ArgsCollector<RemoteAspect *> FunctorArgs;
    typedef TypedFunctor2Base<bool, 
                              CPtrRefCallArg<FieldContainerPtr>, 
                              FunctorArgs                      > Functor;

    typedef std::map<UInt64,UInt32>    LocalFCMapT;
    typedef std::map<UInt32,UInt64>    RemoteFCMapT;
    typedef std::map<UInt32,UInt32>    LocalTypeMapT;

    typedef std::set<UInt32>           IdSetT;

    typedef std::map<UInt32,BitVector> FieldFilterT;
    typedef std::map<UInt32,BitVector> FieldMaskMapT;

    /*---------------------------------------------------------------------*/
    RemoteAspect(UInt32 aspectId=0);
    virtual ~RemoteAspect(void); 

    /*---------------------------------------------------------------------*/
    void receiveSync      ( Connection &connection,
                            bool applyToChangelist=false   );
    void sendSync         ( Connection &connection,
                            ChangeList *changeList=NULL    );
    void registerCreated  ( const FieldContainerType &type, 
                            const Functor &func            );
    void registerDestroyed( const FieldContainerType &type, 
                            const Functor &func            );
    void registerChanged  ( const FieldContainerType &type, 
                            const Functor &func            );
    static void addFieldFilter   ( UInt32 typeId,BitVector mask   );
    static void subFieldFilter   ( UInt32 typeId,BitVector mask   );
    
    static void restoreChangeList   (ChangeList *tocl);
    static void storeChangeList     (ChangeList *cl  );
    static UInt32 getStoreSize      (void            );

    typedef std::map<UInt32, UInt32> clStoreMap;
    typedef clStoreMap::iterator clStoreIt;
    static clStoreMap &getStore     (void            );

    static void createCurrentStateChangeList(const FieldContainerPtr &start,
                                             ChangeList *cl);

    /*---------------------------------------------------------------------*/
    void setStatistics( StatCollector * stat );

    /*=========================  PROTECTED  ===============================*/
  protected:
    /*---------------------------------------------------------------------*/
    UInt32                            _aspectId;

    LocalFCMapT                       _localFC;
    RemoteFCMapT                      _remoteFC;
    LocalTypeMapT                     _localType;

    IdSetT                            _sentFC;
    IdSetT                            _receivedFC;

    IdSetT                            _mappedFC;
    IdSetT                            _mappedType;

    UInt32                            _remoteAspectId;

#if 0

    std::map<UInt32,BitVector>        _sentFC;
#endif

    static FieldFilterT               _fieldFilter;
    std::vector<Functor>              _createdFunctors;
    std::vector<Functor>              _destroyedFunctors;
    std::vector<Functor>              _changedFunctors;
    StatCollector                    *_statistics;

    static std::map<UInt32, UInt32>   _clStore;
    
    /*---------------------------------------------------------------------*/
    bool   callCreated   ( FieldContainerPtr &node   );
    bool   callDestroyed ( FieldContainerPtr &node   );
    bool   callChanged   ( FieldContainerPtr &node   );

    /*==========================  PRIVATE  ================================*/
  private:
    /*---------------------------------------------------------------------*/
    void handleFCMapping   (Connection &connection               );
    void clearFCMapping    (UInt32 localId,UInt32 remoteId       );
    bool getLocalId        (UInt32  remoteId,
                            UInt32 &localId                      );
    UInt64 getFullRemoteId (UInt32  remoteId                     );

    /*---------------------------------------------------------------------*/
    static bool _defaultCreatedFunction  (FieldContainerPtr& fcp,
                                          RemoteAspect * aspect);
    static bool _defaultDestroyedFunction(FieldContainerPtr& fcp,
                                          RemoteAspect * aspect);
    static bool _defaultChangedFunction  (FieldContainerPtr& fcp,
                                          RemoteAspect * aspect);

    static StatElemDesc<StatTimeElem> statSyncTime;
    friend class RemoteAspectFieldContainerMapper;
    // prohibit default functions (move to 'public' if you need one)
    RemoteAspect(const RemoteAspect &source);
    RemoteAspect &operator =(const RemoteAspect &source);
};

// class pointer
typedef RemoteAspect *RemoteAspectP;

struct RemoteAspectFieldContainerMapper:public FieldContainerMapper
{                                              
    virtual UInt32 map(UInt32 uiId);
    RemoteAspect *_remoteAspect;
};

OSG_END_NAMESPACE

#define OSGREMOTEASPECT_HEADER_CVSID "@(#)$Id:$"

#endif /* _REMOTEASPECT_H_ */

---