lrcApiStatsXmlBlock.h

Go to the documentation of this file.

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

#include <rtiMsConfig.h>
#include "spyXmlBlock.h"
#include "apiStatsXmlBlock.h"
#include "statisticsXmlBlock.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( DtLrcApiStatsXmlTag );
DtDECLARE_SPY_XML_TAG( DtTotalRtiApiTimesXmlTag );
DtDECLARE_SPY_XML_TAG( DtTotalFedAmbCallbackTimesXmlTag );

class DtLrcApiStatsXmlBlock;
typedef DtBoost::shared_ptr<DtLrcApiStatsXmlBlock> DtLrcApiStatsXmlBlockSP;
typedef DtBoost::weak_ptr<DtLrcApiStatsXmlBlock>   DtLrcApiStatsXmlBlockWP;

// The DtLrcApiStatsXmlBlock holds the current statistics for the rtiAmbCalls and fedAmbCalls
// known by a given LRC
class DT_DLL_WWW DtLrcApiStatsXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::map< DtString, DtApiStatsXmlBlockSP > ApiCallsByNameMap;
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

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

   // Reset all values to zero
   virtual void reset();

   // Add an RTI Amb. API call to the tally
   virtual void rtiAmbCalled( const DtString& callName, double callTime );

   // Add a Fed. Amb. API call to the tally
   virtual void fedAmbCalled( const DtString& callName, double callTime );

   // Get a pointer to the current statistics for a specific RTI Amb. call
   const DtApiStatsXmlBlockSP rtiAmbCallStats( const DtString& method ) const;

   // Get a pointer to the current statistics for a specific Fed. Amb. callback
   const DtApiStatsXmlBlockSP fedAmbCallbackStats( const DtString& method ) const;
   
   // Get the complete list of RTI Ambassador calls
   inline const ApiCallsByNameMap& rtiAmbCalls() const;

   // Get the complete list of Fed Ambassador calls
   inline const ApiCallsByNameMap& fedAmbCalls() const;
   
protected:

   // @defgroup Totals

   // Total time spent in RTI Amb. calls
   // @ingroup Totals
   DtStatisticsXmlBlock<double>::BlockWP myRtiApiTimes;

   // Total time spent in Fed. Amb. callbacks
   // @ingroup Totals
   DtStatisticsXmlBlock<double>::BlockWP myFedAmbCallbackTimes;

   ApiCallsByNameMap myRtiAmbCalls;
   ApiCallsByNameMap myFedAmbCalls;
};

const DtLrcApiStatsXmlBlock::ApiCallsByNameMap& DtLrcApiStatsXmlBlock::rtiAmbCalls() const
{
   return myRtiAmbCalls;
}
const DtLrcApiStatsXmlBlock::ApiCallsByNameMap& DtLrcApiStatsXmlBlock::fedAmbCalls() const
{
   return myFedAmbCalls;
}


#endif // DtLrcApiStatsXmlBlock_H_