text: /***************************************************//**
   * @file    SpectrometerProtocolInterface.h
   * @date    February 2009
   * @author  Ocean Optics, Inc.
   *
   * This is a generic interface into spectrometer functionality
   * at the protocol level, agnostic to any particular protocol.
   * Each Protocol offering this functionality should implement
   * this interface.
   *
   * LICENSE:
   *
   * SeaBreeze Copyright (C) 2014, Ocean Optics Inc
   *
   * Permission is hereby granted, free of charge, to any person obtaining
   * a copy of this software and associated documentation files (the
   * "Software"), to deal in the Software without restriction, including
   * without limitation the rights to use, copy, modify, merge, publish,
   * distribute, sublicense, and/or sell copies of the Software, and to
   * permit persons to whom the Software is furnished to do so, subject
   * to the following conditions:
   *
   * The above copyright notice and this permission notice shall be included
   * in all copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
   * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
   * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
   * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
   * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
   * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
   *******************************************************/
  
  #ifndef SPECTROMETERPROTOCOLINTERFACE_H
  #define SPECTROMETERPROTOCOLINTERFACE_H
  
  #include "common/SeaBreeze.h"
  #include "common/ByteVector.h"
  #include "common/DoubleVector.h"
  #include "common/buses/Bus.h"
  #include "common/exceptions/ProtocolException.h"
  #include "common/protocols/ProtocolHelper.h"
  #include "vendors/OceanOptics/features/spectrometer/SpectrometerTriggerMode.h"
  
  namespace seabreeze {
  
      class SpectrometerProtocolInterface : public ProtocolHelper {
      public:
          SpectrometerProtocolInterface(Protocol *protocol);
          virtual ~SpectrometerProtocolInterface();
          virtual void requestFormattedSpectrum(const Bus &bus) throw (ProtocolException) = 0;
          virtual DoubleVector *readFormattedSpectrum(const Bus &bus) throw (ProtocolException) = 0;
          virtual void requestUnformattedSpectrum(const Bus &bus) throw (ProtocolException) = 0;
          virtual ByteVector *readUnformattedSpectrum(const Bus &bus) throw (ProtocolException) = 0;
          virtual void requestFastBufferSpectrum(const Bus &bus, unsigned int numberOfSamplesToRetrieve) throw (ProtocolException) = 0;
          virtual ByteVector *readFastBufferSpectrum(const Bus &bus, unsigned int numberOfSamplesToRetrieve) throw (ProtocolException) = 0;
          virtual void setIntegrationTimeMicros(const Bus &bus, unsigned long time_usec) throw (ProtocolException) = 0;
          virtual void setTriggerMode(const Bus &bus,SpectrometerTriggerMode &mode) throw (ProtocolException) = 0;
      };
  
  }
  
  #endif /* SPECTROMETERPROTOCOLINTERFACE_H */
  