netMapXmlBlock.h

Go to the documentation of this file.

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

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

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


#include <iosfwd>
#include <map>
#include <vector>

// Define the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtNetMapXmlTag );
                      
class DtNetMapXmlBlock;
typedef DtBoost::shared_ptr<DtNetMapXmlBlock> DtNetMapXmlBlockSP;
typedef DtBoost::weak_ptr<DtNetMapXmlBlock>   DtNetMapXmlBlockWP;


// The DtNetMapXmlBlock holds a complete network map as known by a single forwarder
// - this may be a partial map of the complete HLA network during the process of building
//   a full map
class DT_DLL_WWW DtNetMapXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::set< DtNetMapForwarderXmlBlockSP > NetMapForwarderXmlBlockSet;

   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

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

   // Add a new forwarder as a child of this map
   // (convenience function to avoid creating child node and parenting it manually)
   virtual void addChildForwarder( DtNetMapForwarderXmlBlockSP forwarder );
   virtual DtNetMapForwarderXmlBlockSP addChildForwarder( const DtString& name, 
      unsigned long connId, const DtString& ip );

   // Get the list of child forwarders
   virtual NetMapForwarderXmlBlockSet childForwarders() const;


};


#endif // DtNetMapXmlBlock_H_