envObjectSync.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2025 MAK Technologies, Inc
** All rights reserved.
******************************************************************************/



#ifndef envObjectSync_H__
#define envObjectSync_H__

#include "appEnv.h"
#include <vlutil/vlString.h>
#include <vlutil/vlSmartPointers.h>
#include <utility>
#include <map>

#include "envValue.h"

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

class DT_DLL_MTL DtEnvObject;
class DT_DLL_MTL DtEnvObjectSync;
class DT_DLL_MTL DtEnvironment;

typedef std::weak_ptr<DtEnvObjectSync> DtEnvObjectSyncWP;

class DT_DLL_MTL DtEnvObjectSync
{
public:

   DtEnvObjectSync();

   virtual ~DtEnvObjectSync();
   
   virtual void generateObject(DtEnvironment&, const DtString& name);

   virtual void bind(DtEnvValueSP value,bool createMissingAttributes);
   
   virtual void unbind();

   virtual DtEnvValueSP binding() const;

   virtual void addAttributeSync(const DtString&,DtEnvObjectSync*);   
   
   virtual void removeAttributeSync(const DtString&);

   virtual void removeAllAttributeSyncs();

   virtual DtEnvObjectSync* attributeSync(const DtString&);


   /* CALLBACKS */

   /* Mandatory callbacks */
   
   virtual void syncInCB(const DtEnvObject&) = 0;

   virtual void syncOutCB(DtEnvObject&) const = 0;

   virtual DtString syncType() const = 0;
   
   /* Optional callbacks */

   virtual void unboundAttributeSyncInCB(DtEnvValue*);

   virtual void attributeAddedCB(DtEnvValueSP);

   virtual void attributeRemovedCB(DtEnvValueSP);

protected:


   //typedef std::pair<DtEnvObjectSync*,DtEnvValueSP> DtAttributeBinding;    
   typedef std::map<DtString,DtEnvObjectSync*> DtAttributeSyncMap;
   DtAttributeSyncMap myAttributeMap;
   DtEnvValueWP       myBoundObject;
};

#ifdef DtUSE_UTILITIES_NAMESPACE
}
#endif

#endif