synchronizer.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2008 University of Washington
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef SYNCHRONIZER_H
#define SYNCHRONIZER_H

#include <stdint.h>
#include "nstime.h"
#include "object.h"

namespace ns3 {

class Synchronizer : public Object 
{
public:
  static TypeId GetTypeId (void);

  Synchronizer ();
  virtual ~Synchronizer ();

  bool Realtime (void);

  uint64_t GetCurrentRealtime (void);

  void SetOrigin (uint64_t ts);

  uint64_t GetOrigin (void);

  int64_t GetDrift (uint64_t ts);

  bool Synchronize (uint64_t tsCurrent, uint64_t tsDelay);

  void Signal (void);

  void SetCondition (bool);

  void EventStart (void);

  uint64_t EventEnd (void);

protected:
  virtual void DoSetOrigin (uint64_t ns) = 0;

  virtual bool DoRealtime (void) = 0;

  virtual uint64_t DoGetCurrentRealtime (void) = 0;

  virtual bool DoSynchronize (uint64_t nsCurrent, uint64_t nsDelay) = 0;

  virtual void DoSignal (void) = 0;

  virtual void DoSetCondition (bool) = 0;

  virtual int64_t DoGetDrift (uint64_t ns) = 0;

  virtual void DoEventStart (void) = 0;
  virtual uint64_t DoEventEnd (void) = 0;

  uint64_t m_realtimeOriginNano;
  uint64_t m_simOriginNano;

private:
  uint64_t TimeStepToNanosecond (uint64_t ts);

  uint64_t NanosecondToTimeStep (uint64_t ns);
};

} // namespace ns3

#endif /* SYNCHRONIZER_H */