OceanDirect  1.30.1-rc.4
OceanDirect C++/C API
DataBufferFeatureAdapter.h
1 /*****************************************************
2  * @file DataBufferFeatureAdapter.h
3  * @date October 2018
4  * @author Ocean Optics, Inc.
5  *
6  * This is a wrapper that allows access to OceanDirect
7  * DataBufferFeatureInterface instances.
8  */
9  /************************************************************************
10  *
11  * OCEAN INSIGHT CONFIDENTIAL
12  * __________________
13  *
14  * [2018] - [2020] Ocean Insight Incorporated
15  * All Rights Reserved.
16  *
17  * NOTICE: All information contained herein is, and remains
18  * the property of Ocean Insight Incorporated and its suppliers,
19  * if any. The intellectual and technical concepts contained
20  * herein are proprietary to Ocean Insight Incorporated
21  * and its suppliers and may be covered by U.S. and Foreign Patents,
22  * patents in process, and are protected by trade secret or copyright law.
23  * Dissemination of this information or reproduction of this material
24  * is strictly forbidden unless prior written permission is obtained
25  * from Ocean Insight Incorporated.
26  *
27  **************************************************************************/
28 
29 #ifndef OCEANDIRECT_DATA_BUFFER_FEATURE_ADAPTER_H
30 #define OCEANDIRECT_DATA_BUFFER_FEATURE_ADAPTER_H
31 
32 #include "api/adapters/FeatureAdapterTemplate.h"
33 #include "vendors/OceanOptics/features/data_buffer/DataBufferFeatureInterface.h"
34 
35 namespace oceandirect {
36  namespace api {
37 
38  class DataBufferFeatureAdapter : public FeatureAdapterTemplate<DataBufferFeatureInterface> {
39  public:
40  DataBufferFeatureAdapter(DataBufferFeatureInterface *intf,
41  const FeatureFamily &f,
42  Protocol *p, Bus *b, unsigned short instanceIndex);
43  virtual ~DataBufferFeatureAdapter();
44 
45  /* Data buffer functions */
46  void clearBuffer(int *errorCode);
47  unsigned long getNumberOfElements(int *errorCode);
48  unsigned long getBufferCapacity(int *errorCode);
49  unsigned long getBufferCapacityMaximum(int *errorCode);
50  unsigned long getBufferCapacityMinimum(int *errorCode);
51  void setBufferCapacity(int *errorCode, unsigned long capacity);
52  void setBufferEnabled(int *errorCode, bool enabled);
53  bool getBufferEnabled(int *errorCode);
54  };
55 
56  } /* end namespace api */
57 } /* end namespace oceandirect */
58 
59 #endif /* OCEANDIRECT_DATA_BUFFER_FEATURE_ADAPTER_H */
60 
Definition: DataBufferFeatureAdapter.h:38
Definition: FeatureAdapterTemplate.h:44
This is an interface to Advance features of OceanDirect that allow access to less common controls....
Definition: AcquisitionDelayFeatureAdapter.h:35