lrcConsoleLogXmlBlock.h

Go to the documentation of this file.

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

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

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

#include <iosfwd>
#include <vector>

// Define the XML tags used by this block
DtDECLARE_SPY_XML_TAG( DtLrcConsoleLogXmlTag );
DtDECLARE_SPY_XML_TAG( DtLrcConsoleLogEventXmlTag );
DtDECLARE_SPY_XML_TAG( DtLrcConsoleLogEventTimeXmlTag );
DtDECLARE_SPY_XML_TAG( DtLrcConsoleLogEventDescriptionXmlTag );
DtDECLARE_SPY_XML_TAG( DtLrcConsoleLogEventIsRtiAmbXmlTag );
DtDECLARE_SPY_XML_TAG( DtLrcConsoleLogEventIsExceptionXmlTag );
DtDECLARE_SPY_XML_TAG( DtLrcConsoleLogStartIndexXmlTag );
DtDECLARE_SPY_XML_TAG( DtLrcConsoleLogStopIndexXmlTag );
DtDECLARE_SPY_XML_TAG( DtLrcConsoleLogStartTimeXmlTag );
DtDECLARE_SPY_XML_TAG( DtLrcConsoleLogStopTimeXmlTag );


                      
class DtLrcConsoleLogXmlBlock;
class DtLrcConsoleLogEventXmlBlock;

typedef DtBoost::shared_ptr<DtLrcConsoleLogXmlBlock> DtLrcConsoleLogXmlBlockSP;
typedef DtBoost::weak_ptr<DtLrcConsoleLogXmlBlock>   DtLrcConsoleLogXmlBlockWP;
typedef DtBoost::shared_ptr<DtLrcConsoleLogEventXmlBlock> DtLrcConsoleLogEventXmlBlockSP;
typedef DtBoost::weak_ptr<DtLrcConsoleLogEventXmlBlock>   DtLrcConsoleLogEventXmlBlockWP;


// The DtLrcConsoleLogEventXmlBlock holds a single log event (usually either a service call,
// callback, or exception)
class DT_DLL_WWW DtLrcConsoleLogEventXmlBlock : public DtSpyXmlBlock
{
public:
   
   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

public:
   DtLrcConsoleLogEventXmlBlock( DtEnvValueSP existingNode, DtEnvValueSP root );
   DtLrcConsoleLogEventXmlBlock( DtTime time, bool isRtiAmbCall, bool isException,
      const DtString& description, DtEnvValueSP root );
   virtual ~DtLrcConsoleLogEventXmlBlock();

   // Time of the event
   inline DtTime time() const;

   // Is this an RTI Amb Call (else its a fedAmbCall)
   inline bool isRtiAmbCall() const;

   // Is this a thrown exception?
   inline bool isException() const;

   // Log text for the event
   inline DtString description() const;

protected:
   
   DtSpyXmlBlockElement< double, true > myTime;
   DtSpyXmlBlockElement< bool, true > myIsRtiAmbCall;
   DtSpyXmlBlockElement< bool, true > myIsException;
   DtSpyXmlBlockElement< DtString, true > myDescription;
};


// The DtLrcConsoleLogXmlBlock holds a complete list of logged events
class DT_DLL_WWW DtLrcConsoleLogXmlBlock : public DtSpyXmlBlock
{
public:
   typedef std::vector< DtLrcConsoleLogEventXmlBlockSP > LrcConsoleLogEventXmlBlockList;

   static DtSpyXmlBlockSP create( DtNodeAndParentPair xmlNodeAndParent );

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

   // Add and Remove from the log 
   virtual DtLrcConsoleLogEventXmlBlockSP addEvent( DtTime time, bool isRtiAmbCall,
      bool isException, const DtString& description );
   virtual DtLrcConsoleLogEventXmlBlockSP removeEvent( DtTime time );
   virtual void removeEvent( DtLrcConsoleLogEventXmlBlockSP eventSP );
   
   // List the logged events
   inline const LrcConsoleLogEventXmlBlockList& events() const;

   // Set/Get the start index (index in total log of first event in this segment)
   // - must be set after adding all events if this is not the complete log
   inline void setStartIndex( unsigned int startIndex );
   inline unsigned int startIndex() const;


   // Set/Get the stop index (index in total log of last event in this segment)
   // - must be set after adding all events if this is not the complete log
   inline void setStopIndex( unsigned int startIndex );
   inline unsigned int stopIndex() const;

   // Get the start time ( time stamp of first event in this segment )
   inline DtTime startTime() const;

   // Get the stop time ( time stamp of last event in this segment )
   inline DtTime stopTime() const;

protected:

   DtSpyXmlBlockElement< unsigned int, true > myStartIndex;
   DtSpyXmlBlockElement< unsigned int, true > myStopIndex;
   DtSpyXmlBlockElement< double, true > myStartTime;
   DtSpyXmlBlockElement< double, true > myStopTime;

   // Local cached pointers to children for faster lookups
   LrcConsoleLogEventXmlBlockList myEvents;
};

DtTime DtLrcConsoleLogEventXmlBlock::time() const { return myTime; }
bool DtLrcConsoleLogEventXmlBlock::isRtiAmbCall() const { return myIsRtiAmbCall; }
bool DtLrcConsoleLogEventXmlBlock::isException() const { return myIsException; }
DtString DtLrcConsoleLogEventXmlBlock::description() const { return myDescription; }
void DtLrcConsoleLogXmlBlock::setStartIndex( unsigned int startIndex ) { myStartIndex = startIndex; }
unsigned int DtLrcConsoleLogXmlBlock::startIndex() const { return myStartIndex; }
void DtLrcConsoleLogXmlBlock::setStopIndex( unsigned int stopIndex ) { myStopIndex = stopIndex; }
unsigned int DtLrcConsoleLogXmlBlock::stopIndex() const { return myStopIndex; }
DtTime DtLrcConsoleLogXmlBlock::startTime() const { return myStartTime; }
DtTime DtLrcConsoleLogXmlBlock::stopTime() const { return myStopTime; }
const DtLrcConsoleLogXmlBlock::LrcConsoleLogEventXmlBlockList& DtLrcConsoleLogXmlBlock::events() const
{
    return myEvents;
}

#endif // DtLrcConsoleLogXmlBlock_H_