objIntStatsXmlBlock.h

Go to the documentation of this file.

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

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

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

// Define the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtObjIntStatsXmlTag );
DtDECLARE_SPY_XML_TAG( DtObjIntStatsIsObjectXmlTag );
DtDECLARE_SPY_XML_TAG( DtObjIntStatsFomHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtObjIntStatsInstanceHandleXmlTag );
DtDECLARE_SPY_XML_TAG( DtObjIntStatsRegisteredNotDiscoveredXmlTag );
DtDECLARE_SPY_XML_TAG( DtObjIntStatsUpdatesReceivedXmlTag );
DtDECLARE_SPY_XML_TAG( DtObjIntStatsBytesReceivedXmlTag );
DtDECLARE_SPY_XML_TAG( DtObjIntStatsUpdatesSentXmlTag );
DtDECLARE_SPY_XML_TAG( DtObjIntStatsBytesSentXmlTag );
DtDECLARE_SPY_XML_TAG( DtObjIntStatsIsDeletedXmlTag );
DtDECLARE_SPY_XML_TAG( DtObjIntStatsIsRemovedXmlTag );
                      
class DtObjIntStatsXmlBlock;
typedef DtBoost::shared_ptr<DtObjIntStatsXmlBlock> DtObjIntStatsXmlBlockSP;
typedef DtBoost::weak_ptr<DtObjIntStatsXmlBlock>   DtObjIntStatsXmlBlockWP;

// The DtObjIntStatsXmlBlock holds the list of active federations
// NOTE: for interactions the instance handle is 0 and the instance name
//       is the handle converted to string
class DT_DLL_WWW DtObjIntStatsXmlBlock : public DtSpyXmlBlock
{
public:

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

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

   // Ctor to build from C++ data
   DtObjIntStatsXmlBlock( bool isObjNotInter, unsigned int objectHandle,
                          unsigned int classHandle, bool isRegistered, DtEnvValueSP root );
   virtual ~DtObjIntStatsXmlBlock();

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

   // Register sent and received updates or interactions
   virtual void received( unsigned int size );
   virtual void sent( unsigned int size );

   // Register that the object has been deleted
   virtual void deleted();

   // Register that the object has been removed
   virtual void removed();

   // Accessors
   inline bool isObject() const;
   inline unsigned int instanceHandle() const;
   inline unsigned int classHandle() const;
   inline bool isRegistered() const;
   inline unsigned int updatesReceived() const;
   inline unsigned int bytesReceived() const;
   inline unsigned int updatesSent() const;
   inline unsigned int bytesSent() const;
   inline bool isDeleted() const;
   inline bool isRemoved() const;
   
protected:

   DtSpyXmlBlockElement< bool, true > myIsObject;
   DtSpyXmlBlockElement< unsigned int, true > myInstanceHandle;
   DtSpyXmlBlockElement< bool, true > myRegisteredNotDiscovered;
   DtSpyXmlBlockElement< unsigned int, true > myUpdatesReceived;
   DtSpyXmlBlockElement< unsigned int, true > myBytesReceived;
   DtSpyXmlBlockElement< unsigned int, true > myUpdatesSent;
   DtSpyXmlBlockElement< unsigned int, true > myBytesSent;
   DtSpyXmlBlockElement< unsigned int, true > myFomHandle;
   DtSpyXmlBlockElement< bool, true > myDeleted;
   DtSpyXmlBlockElement< bool, true > myRemoved;
};


inline bool DtObjIntStatsXmlBlock::isObject() const
{
   return myIsObject;
}

inline unsigned int DtObjIntStatsXmlBlock::instanceHandle() const
{
   return myInstanceHandle;
}

inline unsigned int DtObjIntStatsXmlBlock::classHandle() const
{
   return myFomHandle;
}

inline bool DtObjIntStatsXmlBlock::isRegistered() const
{
   return myRegisteredNotDiscovered;
}

inline unsigned int DtObjIntStatsXmlBlock::updatesReceived() const
{
   return myUpdatesReceived;
}

inline unsigned int DtObjIntStatsXmlBlock::bytesReceived() const
{
   return myBytesReceived;
}

inline unsigned int DtObjIntStatsXmlBlock::updatesSent() const
{
   return myUpdatesSent;
}

inline unsigned int DtObjIntStatsXmlBlock::bytesSent() const
{
   return myBytesSent;
}

inline bool DtObjIntStatsXmlBlock::isDeleted() const
{
   return myDeleted;
}

inline bool DtObjIntStatsXmlBlock::isRemoved() const
{
   return myRemoved;
}

#endif // DtObjIntStatsXmlBlock_H_