statisticsXmlBlock.h

Go to the documentation of this file.

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

// file statisticsXmlBlock.h

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

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

// Define the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtStatisticsXmlTag );
DtDECLARE_SPY_XML_TAG( DtUintStatisticsXmlTag );
DtDECLARE_SPY_XML_TAG( DtIntStatisticsXmlTag );
DtDECLARE_SPY_XML_TAG( DtFloatStatisticsXmlTag );
DtDECLARE_SPY_XML_TAG( DtDoubleStatisticsXmlTag );
DtDECLARE_SPY_XML_TAG( DtStatisticsTotalXmlTag );
DtDECLARE_SPY_XML_TAG( DtStatisticsCountXmlTag );
DtDECLARE_SPY_XML_TAG( DtStatisticsMinXmlTag );
DtDECLARE_SPY_XML_TAG( DtStatisticsMaxXmlTag );
DtDECLARE_SPY_XML_TAG( DtStatisticsAvgXmlTag );

template < typename NumericType >
class DtStatisticsXmlBlock : public DtSpyXmlBlock
{
public:
   typedef NumericType ValueType;
   typedef DtBoost::shared_ptr< DtStatisticsXmlBlock< NumericType > > BlockSP;
   typedef DtBoost::weak_ptr< DtStatisticsXmlBlock< NumericType > >   BlockWP;
   
   // Creator method
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

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

   // Ctor to build from C++ data
   DtStatisticsXmlBlock( const MAKRti::DtString& name, MAKRti::DtEnvValueSP root );   
   virtual ~DtStatisticsXmlBlock();

   // Reset the data
   virtual void reset();

   // Force the value
   virtual void set( unsigned int count, ValueType total, ValueType minimum,
      ValueType maximum, ValueType average );


   // Add an element and update stats
   virtual void addStatistic( const NumericType& stat );

   // Accessors
   unsigned int count() const;
   ValueType total() const;
   ValueType minimum() const;
   ValueType maximum() const;   
   double average() const;

protected:

   // Protected Ctor to build from C++ data
   // For use only by derived classes that want to change the type tag of the XML block.
   DtStatisticsXmlBlock( const MAKRti::DtString& name, const MAKRti::DtString& typeTag, MAKRti::DtEnvValueSP root );   
   
protected:

   bool myInReset;

   DtSpyXmlBlockElement< unsigned int, true > myCount;
   DtSpyXmlBlockElement< NumericType, true > myTotal;
   DtSpyXmlBlockElement< NumericType, true > myMin;
   DtSpyXmlBlockElement< NumericType, true > myMax;
   DtSpyXmlBlockElement< double, true > myAvg;

};


// Specializations for types registered with pluggable factory

//versions of gcc prior to 3.4 do not accept the correct template specialization syntax
#if (( __GNUC__ == 3 ) && ( __GNUC_MINOR__ < 4 ))

DtStatisticsXmlBlock< unsigned int >::DtStatisticsXmlBlock( const MAKRti::DtString& name, MAKRti::DtEnvValueSP root );

DtStatisticsXmlBlock< int >::DtStatisticsXmlBlock( const MAKRti::DtString& name, MAKRti::DtEnvValueSP root );

DtStatisticsXmlBlock< float >::DtStatisticsXmlBlock( const MAKRti::DtString& name, MAKRti::DtEnvValueSP root );

DtStatisticsXmlBlock< double >::DtStatisticsXmlBlock( const MAKRti::DtString& name, MAKRti::DtEnvValueSP root );

#else

template <>
DtStatisticsXmlBlock< unsigned int >::DtStatisticsXmlBlock( const MAKRti::DtString& name, MAKRti::DtEnvValueSP root );

template <>
DtStatisticsXmlBlock< int >::DtStatisticsXmlBlock( const MAKRti::DtString& name, MAKRti::DtEnvValueSP root );

template <>
DtStatisticsXmlBlock< float >::DtStatisticsXmlBlock( const MAKRti::DtString& name, MAKRti::DtEnvValueSP root );

template <>
DtStatisticsXmlBlock< double >::DtStatisticsXmlBlock( const MAKRti::DtString& name, MAKRti::DtEnvValueSP root );

#endif  // __GNUC__ specific



#define statisticsXmlBlock_inl_
#include "statisticsXmlBlock.inl"
#undef  statisticsXmlBlock_inl_

#endif // DtStatisticsXmlBlock_H_