federationListXmlBlock.h

Go to the documentation of this file.

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

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

#include "federationStateXmlBlock.h"
//#include "syncPointXmlBlock.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( DtFederationListXmlTag );
DtDECLARE_SPY_XML_TAG( DtFederationCountXmlTag );
DtDECLARE_SPY_XML_TAG( DtSelectedFederationXmlTag );
DtDECLARE_SPY_XML_TAG( DtFederateListXmlTag );
DtDECLARE_SPY_XML_TAG( DtSyncPointListXmlTag );

class DtFederationListXmlBlock;
typedef DtBoost::shared_ptr<DtFederationListXmlBlock> DtFederationListXmlBlockSP;
typedef DtBoost::weak_ptr<DtFederationListXmlBlock>   DtFederationListXmlBlockWP;

// The DtFederationListXmlBlock holds the list of active federations
class DT_DLL_WWW DtFederationListXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::set< DtFederationStateXmlBlockSP > FederationStateXmlBlockSet;

   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtFederationListXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtFederationListXmlBlock( unsigned int count, const DtString& selectedFederation,
                             DtEnvValueSP root );
   virtual ~DtFederationListXmlBlock();

   // Add and Remove federations from the list
   virtual DtFederationStateXmlBlockSP addFederation( const DtString& name, unsigned int handle, 
      const DtString& fedFile, unsigned int numFederates);
   virtual DtFederationStateXmlBlockSP removeFederation( const DtString& name );
   virtual void removeFederation( DtFederationStateXmlBlockSP federationSP );

   // List the federations
   virtual FederationStateXmlBlockSet federations();

protected:


   DtSpyXmlBlockElement< unsigned int, false > myCount; 
   DtSpyXmlBlockElement< DtString, false >  mySelectedFederation;
};

#endif // DtFederationListXmlBlock_H_