syncPointXmlBlock.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2006 MaK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/
/*******************************************************************************
 ** $RCSfile: syncPointXmlBlock.h,v $ $Revision: 1.6 $ $State: Exp $
 *******************************************************************************/
#ifndef DtSyncPointXmlBlock_H_
#define DtSyncPointXmlBlock_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( DtSyncPointXmlTag );
DtDECLARE_SPY_XML_TAG( DtSyncPointFederateXmlTag );
DtDECLARE_SPY_XML_TAG( DtSyncPointFederateStatusXmlTag );
DtDECLARE_SPY_XML_TAG( DtSyncPointFederateHandleXmlTag );

class DtSyncPointXmlBlock;
class DtSyncPointFederateXmlBlock;

typedef DtBoost::shared_ptr<DtSyncPointXmlBlock> DtSyncPointXmlBlockSP;
typedef DtBoost::weak_ptr<DtSyncPointXmlBlock>   DtSyncPointXmlBlockWP;
typedef DtBoost::shared_ptr<DtSyncPointFederateXmlBlock> DtSyncPointFederateXmlBlockSP;
typedef DtBoost::weak_ptr<DtSyncPointFederateXmlBlock>   DtSyncPointFederateXmlBlockWP;


// The DtSyncPointFederateXmlBlock holds the status of a single federate participating
// in a sync point federate set
class DT_DLL_WWW DtSyncPointFederateXmlBlock : public DtSpyXmlBlock
{
public:
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtSyncPointFederateXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtSyncPointFederateXmlBlock( unsigned long handle, const DtString& status, DtEnvValueSP root );
   virtual ~DtSyncPointFederateXmlBlock();
   
   // Get the federate handle
   inline unsigned long handle() const;

   // Set/Get current status w.r.t. sync point
   virtual void setStatus( const DtString& status );
   inline DtString status() const;

protected:

   DtSpyXmlBlockElement< unsigned long, true > myHandle;
   DtSpyXmlBlockElement< DtString, true > myStatus;
};


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

   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtSyncPointXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtSyncPointXmlBlock( const DtString& name, DtEnvValueSP root );
   virtual ~DtSyncPointXmlBlock();

   // Add and Remove federates from the sync. set
   virtual DtSyncPointFederateXmlBlockSP addFederate( unsigned long handle, const DtString& status );
   virtual DtSyncPointFederateXmlBlockSP removeFederate( unsigned long handle );
   virtual void removeFederate( DtSyncPointFederateXmlBlockSP federateSP );

   // List the participating federate set
   virtual SyncPointFederateXmlBlockSet federates();

   // Set the status of a federate with respect to the point
   virtual void setFederateStatus( unsigned long handle, const DtString& status );
};

unsigned long DtSyncPointFederateXmlBlock::handle() const { return myHandle; }
DtString DtSyncPointFederateXmlBlock::status() const { return myStatus; }

#endif // DtSyncPointXmlBlock_H_