pubSubXmlBlock.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2006 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: pubSubXmlBlock.h,v $ $Revision: 1.7 $ $State: Exp $
 *******************************************************************************/
#ifndef DtPubSubXmlBlock_H_
#define DtPubSubXmlBlock_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( DtPubSubXmlTag );
DtDECLARE_SPY_XML_TAG( DtPubSubObjectXmlTag );
DtDECLARE_SPY_XML_TAG( DtPubSubObjectClassHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtPubSubObjectSubsXmlTag );
DtDECLARE_SPY_XML_TAG( DtPubSubObjectPubsXmlTag );
DtDECLARE_SPY_XML_TAG( DtPubSubInteractionsXmlTag );
DtDECLARE_SPY_XML_TAG( DtPubSubInteractionSubsXmlTag );
DtDECLARE_SPY_XML_TAG( DtPubSubInteractionPubsXmlTag );
                      
class DtFomClassMgr;
class DtObjectClassInfo;
class DtInteractionClassInfo;
class DtPubSubXmlBlock;
class DtPubSubObjectsXmlBlock;
class DtPubSubInteractionsXmlBlock;
typedef DtBoost::shared_ptr<DtPubSubXmlBlock> DtPubSubXmlBlockSP;
typedef DtBoost::weak_ptr<DtPubSubXmlBlock>   DtPubSubXmlBlockWP;
typedef DtBoost::shared_ptr<DtPubSubObjectsXmlBlock> DtPubSubObjectsXmlBlockSP;
typedef DtBoost::weak_ptr<DtPubSubObjectsXmlBlock>   DtPubSubObjectsXmlBlockWP;
typedef DtBoost::shared_ptr<DtPubSubInteractionsXmlBlock> DtPubSubInteractionsXmlBlockSP;
typedef DtBoost::weak_ptr<DtPubSubInteractionsXmlBlock>   DtPubSubInteractionsXmlBlockWP;



// The DtPubSubObjectsXmlBlock holds an object class handle and lists of sub'd and
// pub'd attributes
// Sub and Pub handle sets are stored in JSON string format for compactness:
// ex. mySubs = DtString( "{[handle1, handle2, ..., handleN]}" );
class DT_DLL_WWW DtPubSubObjectsXmlBlock : public DtSpyXmlBlock
{
public:
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtPubSubObjectsXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtPubSubObjectsXmlBlock( unsigned long handle, const DtString& subAttrSet,
      const DtString& pubAttrSet, DtEnvValueSP root );
   virtual ~DtPubSubObjectsXmlBlock();

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

   // Subscription Attr set in JSON format
   virtual void setSubs( const DtString& subs );
   inline DtString subs() const;

   // Publication Attr set in JSON format
   virtual void setPubs( const DtString& pubs );
   inline DtString pubs() const;
   
protected:

   DtSpyXmlBlockElement< unsigned long, true > myHandle; 
                         
   DtSpyXmlBlockElement< DtString, true > mySubscriptions;
   DtSpyXmlBlockElement< DtString, true > myPublications;       
};

// The DtPubSubInteractionsXmlBlock holds a list of pub'd and sub'd interaction classes
//
// Sub and Pub handle sets are stored in JSON string format for compactness:
// ex. mySubs = DtString( "{[handle1, handle2, ..., handleN]}" );
class DT_DLL_WWW DtPubSubInteractionsXmlBlock : public DtSpyXmlBlock
{
public:
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtPubSubInteractionsXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtPubSubInteractionsXmlBlock( const DtString& subAttrSet,
      const DtString& pubAttrSet, DtEnvValueSP root );
   virtual ~DtPubSubInteractionsXmlBlock();

   // Subscription Handle set in JSON format
   virtual void setSubs( const DtString& subs );
   inline DtString subs() const;

   // Publication Handle set in JSON format
   virtual void setPubs( const DtString& pubs );
   inline DtString pubs() const;
   
protected:

   DtSpyXmlBlockElement< DtString, true > mySubscriptions;
   DtSpyXmlBlockElement< DtString, true > myPublications;       
};


// The DtPubSubXmlBlock holds a complete WWW request message
class DT_DLL_WWW DtPubSubXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::set< DtPubSubObjectsXmlBlockSP > PubSubObjectXmlBlockSet;

   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

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

   // Build list of pubs and subs from the FOM manager state
   virtual void updatePubsAndSubs( const DtFomClassMgr& fom );

   // Add and Remove objects from the list
   // If added object exists, addObject replaces existing
   virtual DtPubSubObjectsXmlBlockSP addObject( unsigned long handle, const DtString& pubs, const DtString& subs );
   virtual DtPubSubObjectsXmlBlockSP removeObject( unsigned long handle );
   virtual void removeObject( DtPubSubObjectsXmlBlockSP objectSP );

   // List the sub'd and pub'd object classes
   virtual PubSubObjectXmlBlockSet objects();

   // Set the list of pub'd and sub'd Interaction Classes (overwrites existing)
   // (this is different than objects which are sub'd and pub'd on a per class per attribute basis)
   virtual DtPubSubInteractionsXmlBlockSP setInteractions( const DtString& pubs, const DtString& subs );
   
   // List the sub'd and pub'd interaction classes
   virtual DtPubSubInteractionsXmlBlockSP interactions();

protected:

   // Get the object sub and pub data
   void updateObjectPubsAndSubs( DtObjectClassInfo* obj );

   // Get per-attribute sub and pub data
   void getAttrSubsAndPubs( DtObjectClassInfo* obj );

   // Get the interaction sub and pub data
   void updateInteractionPubsAndSubs( DtInteractionClassInfo* inter,
      DtString& interSubs, DtString& interPubs, bool& addCommaToSubs, bool& addCommaToPubs );

protected:

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

unsigned long DtPubSubObjectsXmlBlock::handle() const { return myHandle; }
inline DtString DtPubSubObjectsXmlBlock::subs() const { return mySubscriptions; }
inline DtString DtPubSubObjectsXmlBlock::pubs() const { return myPublications; }
inline DtString DtPubSubInteractionsXmlBlock::subs() const { return mySubscriptions; }
inline DtString DtPubSubInteractionsXmlBlock::pubs() const { return myPublications; }

#endif // DtPubSubXmlBlock_H_