msgStatsXmlBlock.h

Go to the documentation of this file.

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

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

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

// Define the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtMsgStatsXmlTag );
DtDECLARE_SPY_XML_TAG( DtMsgStatsSentMsgCountXmlTag );
DtDECLARE_SPY_XML_TAG( DtMsgStatsReadMsgCountXmlTag );
DtDECLARE_SPY_XML_TAG( DtMsgStatsSentMsgKindXmlTag );
//DtDECLARE_SPY_XML_TAG( DtMsgStatsOverheadPerMsgXmlTag );
//DtDECLARE_SPY_XML_TAG( DtMsgStatsOverheadPercentXmlTag );
                      
class DtMsgStatsXmlBlock;
typedef DtBoost::shared_ptr<DtMsgStatsXmlBlock> DtMsgStatsXmlBlockSP;
typedef DtBoost::weak_ptr<DtMsgStatsXmlBlock>   DtMsgStatsXmlBlockWP;

// The DtMsgStatsXmlBlock holds statistics about a single message kind
class DT_DLL_WWW DtMsgStatsXmlBlock : public DtSpyXmlBlock
{
public:

   // Creator method
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   
   // Ctor to build from XML data
   DtMsgStatsXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );

   // Ctor to build from C++ data
   DtMsgStatsXmlBlock( DtRtiMsgKind msgKind, DtEnvValueSP root );
   virtual ~DtMsgStatsXmlBlock();

   // Reset data to initial state
   virtual void reset();

   // Record a new sent message's stats
   virtual void recordSentMsg( unsigned int msgBytes, double sendTime );

   // Record a new read message's stats
   virtual void recordReadMsg( unsigned int msgBytes, double readTime );   

   // Get the kind of message
   inline DtRtiMsgKind kind() const;

   // Get the current sent message stats
   inline unsigned int sendCount() const;
   inline DtStatisticsXmlBlock<unsigned int>::BlockSP sentBytes() const;
   inline DtStatisticsXmlBlock<double>::BlockSP sendTime() const;

   // Get the current received message stats
   inline unsigned int readCount() const;
   inline DtStatisticsXmlBlock<unsigned int>::BlockSP readBytes() const;
   inline DtStatisticsXmlBlock<double>::BlockSP readTime() const;
   
protected:

   DtSpyXmlBlockElement< unsigned int, true > myMsgKind;

   DtSpyXmlBlockElement< unsigned int, true > mySentMsgCount;
   DtStatisticsXmlBlock<unsigned int>::BlockWP mySentBytes;
   DtStatisticsXmlBlock<double>::BlockWP mySendTime;
   
   DtSpyXmlBlockElement< unsigned int, true > myReadMsgCount;
   DtStatisticsXmlBlock<unsigned int>::BlockWP myReadBytes;
   DtStatisticsXmlBlock<double>::BlockWP myReadTime;

   //DtSpyXmlBlockElement< DtMsgStatsOverheadPerMsgXmlTag, unsigned int, true > myOverheadPerMsg;
   //DtSpyXmlBlockElement< DtMsgStatsOverheadPercentXmlTag, double, true > myOverheadPercent;
};


DtRtiMsgKind DtMsgStatsXmlBlock::kind() const
{
   return static_cast<DtRtiMsgKind>( (unsigned int) myMsgKind );
}

unsigned int DtMsgStatsXmlBlock::sendCount() const
{
   return mySentMsgCount;
}

DtStatisticsXmlBlock<unsigned int>::BlockSP DtMsgStatsXmlBlock::sentBytes() const
{
   return mySentBytes.lock();
}

DtStatisticsXmlBlock<double>::BlockSP DtMsgStatsXmlBlock::sendTime() const
{
   return mySendTime.lock();
}

unsigned int DtMsgStatsXmlBlock::readCount() const
{
   return myReadMsgCount;
}

DtStatisticsXmlBlock<unsigned int>::BlockSP DtMsgStatsXmlBlock::readBytes() const
{
   return myReadBytes.lock();
}

DtStatisticsXmlBlock<double>::BlockSP DtMsgStatsXmlBlock::readTime() const
{
   return myReadTime.lock();
}

#endif // DtMsgStatsXmlBlock_H_