lrcStateDbXmlBlock.h

Go to the documentation of this file.

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

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

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

#include <map>


// Define the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtLrcStateDatabaseXmlTag );
                      
class DtLrcStateDatabaseXmlBlock;
typedef DtBoost::shared_ptr<DtLrcStateDatabaseXmlBlock> DtLrcStateDatabaseXmlBlockSP;
typedef DtBoost::weak_ptr<DtLrcStateDatabaseXmlBlock>   DtLrcStateDatabaseXmlBlockWP;

// The DtLrcStateDatabaseXmlBlock holds the complete statistics collected by the spy about
// the lrc
class DT_DLL_WWW DtLrcStateDatabaseXmlBlock : public DtSpyXmlBlock
{
public:

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

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

   // Ctor to build from C++ data
   DtLrcStateDatabaseXmlBlock( DtEnvValueSP root );
   virtual ~DtLrcStateDatabaseXmlBlock();

   // Reset all values to zero
   virtual void reset();
   
   // Add a sent message to the tally
   virtual void messageSent( unsigned int fedId, DtRtiMsgKind msgKind, 
      unsigned int size, double sendTime );

   // Add a received message to the tally
   virtual void messageRead( unsigned int fedId, DtRtiMsgKind msgKind,
      unsigned int size, double recvTime );

   // 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 );

   // Add a new object (registered or discovered)
   virtual void addObject( bool isRegistered, unsigned int objHandle, unsigned int classHandle,
      const DtString& theClassName, const DtString& theObjectName );

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

   // Get a pointer to the current statistics for a specific message
   const DtMsgStatsXmlBlockSP msgStats( DtRtiMsgKind msgKind ) const;
   
   // 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 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 messages
   inline const std::map< DtRtiMsgKind, DtMsgStatsXmlBlockWP >& messages() const;

   // Access the complete list of RTI Amb. calls
   inline const std::map< DtString, DtApiStatsXmlBlockWP >& rtiAmbCalls() const;

   // Access the complete list of Fed. Amb. callbacks
   inline const std::map< DtString, DtApiStatsXmlBlockWP >& fedAmbCallbacks() const;
   
   // Access the complete list of RTI objects
   inline const std::map< unsigned int, DtObjIntStatsXmlBlockWP >& objects() const;
   
   // Access the complete list of RTI interactions
   inline const std::map< unsigned int, DtObjIntStatsXmlBlockWP >& interactions() const;
   
   
protected:

   // @defgroup Totals

   // Total num msgs and bandwidth sent (including anon)
   // @ingroup Totals
   DtStatisticsXmlBlock<unsigned int>::BlockWP mySentBytes;
   
   // Total num msgs and bandwidth read (including anon)
   // @ingroup Totals
   DtStatisticsXmlBlock<unsigned int>::BlockWP myReadBytes;

   // Total num msgs and bandwidth read from anon messages (may have been sent by self)
   // @ingroup Totals
   DtStatisticsXmlBlock<unsigned int>::BlockWP myAnonBytes;

   // Total num msgs and bandwidth read from stamped messages (definitely sent from other feds)
   // @ingroup Totals
   DtStatisticsXmlBlock<unsigned int>::BlockWP myStampedBytes;

   // Total time spent in socket reads
   // @ingroup Totals
   DtStatisticsXmlBlock<double>::BlockWP myNetworkReadTimes;

   // Total time spent in socket sends
   // @ingroup Totals
   DtStatisticsXmlBlock<double>::BlockWP myNetworkSendTimes;

   // 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;

   // @defgroup Individual Stats

   // Time spent in each individual RTI Amb. call
   // @ingroup Individual Stats
   std::map< DtString, DtApiStatsXmlBlockWP > myRtiAmbCalls;

   // Time spent in each individual Fed. Amb. callback
   // @ingroup Individual Stats
   std::map< DtString, DtApiStatsXmlBlockWP > myFedAmbCallbacks;

   // Stats on individual objects by object instance handle
   // @ingroup Individual Stats
   std::map< unsigned int, DtObjIntStatsXmlBlockWP > myObjects;
   
   // Stats on individual interactions by interaction handle
   // @ingroup Individual Stats
   std::map< unsigned int, DtObjIntStatsXmlBlockWP > myInteractions;

   // Stats on individual messages by message kind
   // @ingroup Individual Stats
   std::map< DtRtiMsgKind, DtMsgStatsXmlBlockWP > myMessages;
   

};

inline const std::map< DtRtiMsgKind, DtMsgStatsXmlBlockWP >& DtLrcStateDatabaseXmlBlock::messages() const
{
   return myMessages;
}

inline const std::map< DtString, DtApiStatsXmlBlockWP >& DtLrcStateDatabaseXmlBlock::rtiAmbCalls() const
{
   return myRtiAmbCalls;
}

inline const std::map< DtString, DtApiStatsXmlBlockWP >& DtLrcStateDatabaseXmlBlock::fedAmbCallbacks() const
{
   return myFedAmbCallbacks;
}

inline const std::map< unsigned int, DtObjIntStatsXmlBlockWP >& DtLrcStateDatabaseXmlBlock::objects() const
{
   return myObjects;
}
   
inline const std::map< unsigned int, DtObjIntStatsXmlBlockWP >& DtLrcStateDatabaseXmlBlock::interactions() const
{
   return myInteractions;
}


#endif // DtLrcStateDatabaseXmlBlock_H_