objOwnershipInfoXmlBlock.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2006 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: objOwnershipInfoXmlBlock.h,v $ $Revision: 1.7 $ $State: Exp $
 *******************************************************************************/
#ifndef DtObjOwnershipInfoXmlBlock_H_
#define DtObjOwnershipInfoXmlBlock_H_

#include <rtiMsConfig.h>
#include "spyXmlBlock.h"
#include <mtl/env.h>
#include "webSpyUtils.h"

#include <vlutil/vlString.h>
#include <vlutil/vlFilename.h>
#include <vlutil/vlSmartPointers.h>

#include <iosfwd>
#include <map>

// Define the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtObjOwnershipInfoXmlTag );
DtDECLARE_SPY_XML_TAG( DtAttrOwnershipInfoXmlTag );
DtDECLARE_SPY_XML_TAG( DtAttrOwnershipInfoInstanceHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtAttrOwnershipInfoActualHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtAttrOwnershipInfoKnownHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtAttrOwnershipInfoIsRegXmlTag );
DtDECLARE_SPY_XML_TAG( DtAttrOwnershipInfoAttrsXmlTag );
DtDECLARE_SPY_XML_TAG( DtAttrOwnershipInfoPubsXmlTag );
                      
class DtRtiObject;
class DtObjectClassInfo;
class DtAttrInfo;
class DtObjOwnershipInfoXmlBlock;
class DtAttrOwnershipInfoXmlBlock;

typedef DtBoost::shared_ptr<DtObjOwnershipInfoXmlBlock> DtObjOwnershipInfoXmlBlockSP;
typedef DtBoost::weak_ptr<DtObjOwnershipInfoXmlBlock>   DtObjOwnershipInfoXmlBlockWP;
typedef DtBoost::shared_ptr<DtAttrOwnershipInfoXmlBlock> DtAttrOwnershipInfoXmlBlockSP;
typedef DtBoost::weak_ptr<DtAttrOwnershipInfoXmlBlock>   DtAttrOwnershipInfoXmlBlockWP;


// The DtAttrOwnershipInfoXmlBlock holds an object instance handle and lists of 
// owned attributes
// Owned attr handle sets are stored in JSON string format for compactness:
// ex. myAttrSet = DtString( "{[attrInfo1, attrInfo2, ..., attrInfoN]}" );
//     and
//     attrInfo1 = { handle : attrHandle1, adv : updatesOnNotOff, subs : [ subscriber1, ..., subscriberN ]}
class DT_DLL_WWW DtAttrOwnershipInfoXmlBlock : public DtSpyXmlBlock
{
public:
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtAttrOwnershipInfoXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtAttrOwnershipInfoXmlBlock( const DtString& instanceName, unsigned long handle, unsigned long actualClassHandle,
      unsigned long knownClassHandle, const DtString& ownedAttrSet, DtEnvValueSP root );
   virtual ~DtAttrOwnershipInfoXmlBlock();

   // Object instance handle
   inline unsigned long handle() const;

   // Object class handle
   inline unsigned long actual() const;

   // Known Object class handle
   inline unsigned long known() const;

   // Owned Attr set in JSON format
   virtual void setAttrs( const DtString& attrs );
   inline DtString attrs() const;

protected:

   DtSpyXmlBlockElement< unsigned long, true > myHandle; 
   DtSpyXmlBlockElement< unsigned long, true > myActualClassHandle; 
   DtSpyXmlBlockElement< unsigned long, true > myKnownHandle; 
                         
   DtSpyXmlBlockElement< DtString, true > myAttrSet;
};


// The DtObjOwnershipInfoXmlBlock holds a complete list of known objects and ownership states
class DT_DLL_WWW DtObjOwnershipInfoXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::set< DtAttrOwnershipInfoXmlBlockSP > AttrOwnershipInfoXmlBlockSet;

   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtObjOwnershipInfoXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtObjOwnershipInfoXmlBlock( DtEnvValueSP root );
   virtual ~DtObjOwnershipInfoXmlBlock();

   // Add and Remove objects from the list
   // If added object exists, addObject replaces existing
   virtual DtAttrOwnershipInfoXmlBlockSP addObject( const DtRtiObject& obj,
      const DtObjectClassInfo& actualClass );
   virtual DtAttrOwnershipInfoXmlBlockSP removeObject( unsigned long handle );
   virtual void removeObject( DtAttrOwnershipInfoXmlBlockSP objectSP );

   // List the known object instances and owned attrs
   virtual AttrOwnershipInfoXmlBlockSet objects();

protected:

   // Get a list of owned attributes for an object in JSON Format
   DtString getOwnedAttrs( const DtRtiObject& obj, const DtObjectClassInfo& actualClass );
   DtString getAttrInfo( const DtAttrInfo& handle, bool updatesOn );

protected:

   // Local cached pointers to children for faster lookups
   typedef std::map< unsigned long, DtAttrOwnershipInfoXmlBlockSP > HandleToObjectSpMap;
   HandleToObjectSpMap myObjectsByHandle;
};

unsigned long DtAttrOwnershipInfoXmlBlock::handle() const { return myHandle; }
unsigned long DtAttrOwnershipInfoXmlBlock::actual() const { return myActualClassHandle; }
unsigned long DtAttrOwnershipInfoXmlBlock::known() const { return myKnownHandle; }
inline DtString DtAttrOwnershipInfoXmlBlock::attrs() const { return myAttrSet; }

#endif // DtObjOwnershipInfoXmlBlock_H_