OceanDirect  1.30.1-rc.4
OceanDirect C++/C API
LightSourceFeatureAdapter.h
1 /*****************************************************
2  * @file LightSourceFeatureAdapter.h
3  * @date May 2018
4  * @author Ocean Optics, Inc.
5  *
6  * This is a wrapper that allows
7  * access to OceanDirect LightSourceFeatureInterface 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_LIGHTSOURCEFEATUREADAPTER_H
30 #define OCEANDIRECT_LIGHTSOURCEFEATUREADAPTER_H
31 
32 #include "api/adapters/FeatureAdapterTemplate.h"
33 #include "vendors/OceanOptics/features/light_source/LightSourceFeatureInterface.h"
34 
35 namespace oceandirect {
36  namespace api {
37 
39  : public FeatureAdapterTemplate<LightSourceFeatureInterface> {
40  public:
41  LightSourceFeatureAdapter(LightSourceFeatureInterface *intf,
42  const FeatureFamily &f,
43  Protocol *p, Bus *b, unsigned short instanceIndex);
44  virtual ~LightSourceFeatureAdapter();
45 
46  int getLightSourceCount(int *errorCode);
47 
48  bool hasLightSourceEnable(int *errorCode, int lightSourceIndex);
49  bool isLightSourceEnabled(int *errorCode, int lightSourceIndex);
50  void setLightSourceEnable(int *errorCode, int lightSourceIndex,
51  bool enable);
52 
53  /* The intensity is normalized over the range [0, 1] where 0 is
54  * the minimum programmable intensity and 1 is the maximum
55  */
56  bool hasVariableIntensity(int *errorCode, int lightSourceIndex);
57  double getLightSourceIntensity(int *errorCode, int lightSourceIndex);
58  void setLightSourceIntensity(int *errorCode, int lightSourceIndex,
59  double intensity);
60  };
61 
62  }
63 }
64 
65 #endif
Definition: FeatureAdapterTemplate.h:44
Definition: LightSourceFeatureAdapter.h:39
This is an interface to Advance features of OceanDirect that allow access to less common controls....
Definition: AcquisitionDelayFeatureAdapter.h:35