lrcObjInterStatsXmlBlock.h

Go to the documentation of this file.

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

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

#include <vlutil/vlFedTarget.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( DtLrcObjInterStatsXmlTag );
DtDECLARE_SPY_XML_TAG( DtLrcObjIntStatsTimeStampXmlTag );

class DtLrcObjInterStatsXmlBlock;
typedef DtBoost::shared_ptr<DtLrcObjInterStatsXmlBlock> DtLrcObjInterStatsXmlBlockSP;
typedef DtBoost::weak_ptr<DtLrcObjInterStatsXmlBlock>   DtLrcObjInterStatsXmlBlockWP;

// The DtLrcObjInterStatsXmlBlock holds the current statistics for the objects and interactions
// known by a given LRC
class DT_DLL_WWW DtLrcObjInterStatsXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::map< unsigned long, DtObjIntStatsXmlBlockSP > ObjectInstancesByHandleMap;
   typedef std::map< unsigned long, DtObjIntStatsXmlBlockSP > InteractionClassesByHandleMap;
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

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

   // Reset all values to zero
   virtual void reset();
   
   // Add a new object (registered or discovered)
   virtual void addObject( bool isRegistered, unsigned int objHandle, unsigned int classHandle );

   // Record statistics about an update message
   void recordUpdate( bool isSent, unsigned int msgSize, double time, unsigned int handle );
   
   // Record statistics about an interaction message   
   void recordInteraction( bool isSent, unsigned int msgSize, double time, unsigned int handle );

   // Record that an object has been deleted
   void recordDeletion( unsigned int handle );

   // Record that an object has been removed
   void recordRemoval( unsigned int handle );

   // Get a pointer to the current statistics for a specific object instance
   const DtObjIntStatsXmlBlockSP objectStats( unsigned int handle ) const;

   // Get a pointer to the current statistics for a specific interaction class
   const DtObjIntStatsXmlBlockSP interactionStats( unsigned int handle ) const;


   // Access the complete list of RTI objects
   inline const ObjectInstancesByHandleMap& objects() const;
   
   // Access the complete list of RTI interactions
   inline const InteractionClassesByHandleMap& interactions() const;

   // Timestamp access
   inline void setTimeStamp();
   inline DtTime timeStamp() const;
   
protected:

   DtClock myClock;
   DtSpyXmlBlockElement< double, true > myTimestamp;
   ObjectInstancesByHandleMap myObjects;
   InteractionClassesByHandleMap myInteractions;
};

inline void DtLrcObjInterStatsXmlBlock::setTimeStamp()
{
   myTimestamp = myClock.absRealTime();
}

inline DtTime DtLrcObjInterStatsXmlBlock::timeStamp() const
{
   return myTimestamp;
}

inline const DtLrcObjInterStatsXmlBlock::ObjectInstancesByHandleMap& DtLrcObjInterStatsXmlBlock::objects() const
{
   return myObjects;
}

inline const DtLrcObjInterStatsXmlBlock::InteractionClassesByHandleMap& DtLrcObjInterStatsXmlBlock::interactions() const
{
   return myInteractions;
}


#endif // DtLrcObjInterStatsXmlBlock_H_