OceanDirect  1.30.1-rc.4
OceanDirect C++/C API
DeviceInformationFeatureAdapter.h
1 /*****************************************************
2  * @file DeviceInformationFeatureAdapter.h
3  * @date April 2021
4  * @author Ocean Optics, Inc.
5  *
6  * This is a wrapper that allows
7  * access to OceanDirect DeviceInformationFeatureInterface instances.
8  */
9  /************************************************************************
10  *
11  * OCEAN INSIGHT CONFIDENTIAL
12  * __________________
13  *
14  * [2018] - [2021] 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_DEVICE_INFORMATION_FEATURE_ADAPTER_H
30 #define OCEANDIRECT_DEVICE_INFORMATION_FEATURE_ADAPTER_H
31 
32 #include "api/adapters/FeatureAdapterTemplate.h"
33 #include "vendors/OceanOptics/features/device_info/DeviceInformationFeatureInterface.h"
34 
35 namespace oceandirect {
36  namespace api {
37 
38  class DeviceInformationFeatureAdapter : public FeatureAdapterTemplate<DeviceInformationFeatureInterface> {
39  public:
40  DeviceInformationFeatureAdapter(DeviceInformationFeatureInterface *intf,
41  const FeatureFamily &f,
42  Protocol *p, Bus *b, unsigned short instanceIndex);
44 
45  void resetDevice(int *errorCode);
46  std::uint16_t getOriginalVID(int *errorCode);
47  std::uint16_t getOriginalPID(int *errorCode);
48  std::uint16_t getVID(int *errorCode);
49  void setVID(int *errorCode, std::uint16_t vid);
50  std::uint16_t getPID(int *errorCode);
51  void setPID(int *errorCode, std::uint16_t pid);
52 
53  int getOriginalManufacturerString(int *errorCode, char *buffer, int bufferLength);
54  int getOriginalModelString(int *errorCode, char *buffer, int bufferLength);
55  int getManufacturerString(int *errorCode, char *buffer, int bufferLength);
56  void setManufacturerString(int *errorCode, char *buffer, int bufferLength);
57  int getModelString(int *errorCode, char *buffer, int bufferLength);
58  void setModelString(int *errorCode, char *buffer, int bufferLength);
59 
60  int getCommandList(int *errorCode, std::uint32_t *buffer, int bufferLength);
61  std::uint32_t getIntegrationTimeStepSize(int *errorCode);
62  };
63  }
64 }
65 
66 #endif
67 
Definition: DeviceInformationFeatureAdapter.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