ifSnapshotsResponse.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2016 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include "vrfmsgs/vrfmsgsDefines.h"
#include "vrfmsgs/ifStatus.h"
#include <vlutil/vlString.h>
#include <vrfExtProtocol/simInterfaceContent.h>



class DT_DLL_vrfmsgs DtIfSnapshotsResponse : public DtSimInterfaceContent
{
public:

   struct Snapshot
   {
      Snapshot() : simTime(0), isPeriodic(false), SnapshotId(-1) {};
      Snapshot(const Snapshot& orig)
         : simTime(orig.simTime), SnapshotId(orig.SnapshotId),
           isPeriodic(orig.isPeriodic) {};

      virtual ~Snapshot() {};

      bool operator==(const Snapshot& rhs) const
      {
         return ((simTime == rhs.simTime) &&
                 (SnapshotId == rhs.SnapshotId) &&
                 (isPeriodic == rhs.isPeriodic));
      }

      bool operator!=(const Snapshot& rhs) const { return !(*this == rhs); }

      double simTime;
      bool isPeriodic;
      int SnapshotId;
   };

   typedef std::map<int, Snapshot> SnapshotStatus;

public:

   DtIfSnapshotsResponse();

   virtual ~DtIfSnapshotsResponse();

   DtIfSnapshotsResponse(const DtIfSnapshotsResponse& orig);

   DtIfSnapshotsResponse& operator=(const DtIfSnapshotsResponse& orig);

   virtual int type() const;

   virtual DtSimInterfaceContent * clone() const;

   virtual int netRepSize() const;
   virtual bool setFromNet(const char* contentBuffer, 
      unsigned contentSize);
   virtual bool setToNet();

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

   virtual const SnapshotStatus& snapshots() const;
   virtual void addSnapshot(int id, double simTime, bool isPeriodic);
   virtual void setSnapshots(const SnapshotStatus&);
   virtual void removeSnapshot(int id);
   virtual void removeAllBut(int id);
   virtual void clear();

   virtual void setBaseSnapshotTime(double);
   virtual void clearBaseSnapshot();
   double baseSnapshotTime() const { return myBaseSnapshotTime; };
   bool hasBaseSnapshot() const { return myHasBaseSnapshot; };

protected:
   SnapshotStatus mySnapshots;
   double myBaseSnapshotTime;
   bool myHasBaseSnapshot;
};

namespace DtBufferSerialize
{
   DT_DLL_vrfmsgs int getSize(const DtIfSnapshotsResponse::Snapshot&  messagePtr);

   DT_DLL_vrfmsgs char *encode(const DtIfSnapshotsResponse::Snapshot& messagePtr, char *buffer);

   DT_DLL_vrfmsgs const char *decode(DtIfSnapshotsResponse::Snapshot& messagePtr, const char *buffer);
}