usFrameGrabbedInfo.h

/****************************************************************************
 *
 * This file is part of the ustk software.
 * Copyright (C) 2016 - 2017 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * ("GPL") version 2 as published by the Free Software Foundation.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ustk with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at ustk@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Authors:
 * Marc Pouliquen
 *
 *****************************************************************************/
 
#ifndef __usFrameGrabbedInfo_h_
#define __usFrameGrabbedInfo_h_
 
#include <visp3/ustk_core/usConfig.h>
 
#if defined(USTK_HAVE_QT5) || defined(USTK_HAVE_VTK_QT)
 
#include <visp3/ustk_grabber/usNetworkGrabber.h>
 
#include <visp3/core/vpMutex.h>
 
#include <QtCore/QTypeInfo>
 
template <class Type> class usFrameGrabbedInfo : public Type
{
public:
  explicit usFrameGrabbedInfo();
  ~usFrameGrabbedInfo();
 
  quint32 getFrameCount() const;
  int getFramesPerVolume() const;
  quint64 getTimeStamp() const;
 
  void setFrameCount(quint32 frameCount);
  void setFramesPerVolume(int framesPerVolume);
  void setTimeStamp(quint64 timeStamp);
 
private:
  quint32 m_frameCount;  // from the beginning of acquisition
  quint64 m_timeStamp;   // msecs since epoch (on ultrasond machine)
  int m_framesPerVolume; // number of frames in a volume (for 3D case)
};
 
template <class Type>
usFrameGrabbedInfo<Type>::usFrameGrabbedInfo() : Type(), m_frameCount(0), m_timeStamp(0), m_framesPerVolume(0)
{
}
 
template <class Type> usFrameGrabbedInfo<Type>::~usFrameGrabbedInfo() {}
 
template <class Type> quint32 usFrameGrabbedInfo<Type>::getFrameCount() const { return m_frameCount; }
 
template <class Type> int usFrameGrabbedInfo<Type>::getFramesPerVolume() const { return m_framesPerVolume; }
 
template <class Type> quint64 usFrameGrabbedInfo<Type>::getTimeStamp() const { return m_timeStamp; }
 
template <class Type> void usFrameGrabbedInfo<Type>::setFrameCount(quint32 frameCount) { m_frameCount = frameCount; }
 
template <class Type> void usFrameGrabbedInfo<Type>::setFramesPerVolume(int framesPerVolume)
{
  m_framesPerVolume = framesPerVolume;
}
 
template <class Type> void usFrameGrabbedInfo<Type>::setTimeStamp(quint64 timeStamp) { m_timeStamp = timeStamp; }
 
template <class Type> std::ostream &operator<<(std::ostream &out, const usFrameGrabbedInfo<Type> &other)
{
  out << "timestamp : " << other.getTimeStamp() << std::endl
      << "frameCount : " << other.getFrameCount() << std::endl
      << "frames per volume : " << other.getFramesPerVolume() << std::endl
      << (Type)other << std::endl;
 
  return out;
}
 
#endif // QT4 || QT5
#endif // __usFrameGrabbedInfo_h_