encoders.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019, Open Source Robotics Foundation
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the copyright holder nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #include <functional>
31 #include <memory>
32 #include <vector>
33 
34 #include "phidgets_api/encoder.h"
35 #include "phidgets_api/encoders.h"
36 #include "phidgets_api/phidget22.h"
37 
38 namespace phidgets {
39 
41  int32_t serial_number, int hub_port, bool is_hub_port_device,
42  std::function<void(int, int, double, int)> position_change_handler)
43 {
44  PhidgetReturnCode ret;
45 
46  PhidgetEncoderHandle enc_handle;
47 
48  ret = PhidgetEncoder_create(&enc_handle);
49  if (ret != EPHIDGET_OK)
50  {
51  throw Phidget22Error(
52  "Failed to create Encoder handle for determining channel "
53  "count",
54  ret);
55  }
56 
57  PhidgetHandle handle = reinterpret_cast<PhidgetHandle>(enc_handle);
58 
59  helpers::openWaitForAttachment(handle, serial_number, hub_port,
60  is_hub_port_device, 0);
61 
62  ret = Phidget_getDeviceChannelCount(handle, PHIDCHCLASS_ENCODER,
64 
65  helpers::closeAndDelete(&handle);
66 
67  if (ret != EPHIDGET_OK)
68  {
69  throw Phidget22Error("Failed to get Encoder device channel count", ret);
70  }
71 
72  encs_.resize(encoder_count_);
73  for (uint32_t i = 0; i < encoder_count_; ++i)
74  {
75  encs_[i] = std::make_unique<Encoder>(serial_number, hub_port,
76  is_hub_port_device, i,
77  position_change_handler);
78  }
79 }
80 
82 {
83 }
84 
85 uint32_t Encoders::getEncoderCount() const
86 {
87  return encoder_count_;
88 }
89 
90 int64_t Encoders::getPosition(int index) const
91 {
92  return encs_.at(index)->getPosition();
93 }
94 
95 void Encoders::setPosition(int index, int64_t position) const
96 {
97  return encs_.at(index)->setPosition(position);
98 }
99 
100 int64_t Encoders::getIndexPosition(int index) const
101 {
102  return encs_.at(index)->getIndexPosition();
103 }
104 
105 bool Encoders::getEnabled(int index) const
106 {
107  return encs_.at(index)->getEnabled();
108 }
109 
110 void Encoders::setEnabled(int index, bool enabled) const
111 {
112  return encs_.at(index)->setEnabled(enabled);
113 }
114 
115 Phidget_EncoderIOMode Encoders::getIOMode(int index) const
116 {
117  return encs_.at(index)->getIOMode();
118 }
119 
120 void Encoders::setIOMode(int index, Phidget_EncoderIOMode IOMode) const
121 {
122  return encs_.at(index)->setIOMode(IOMode);
123 }
124 
125 uint32_t Encoders::getDataInterval(int index) const
126 {
127  return encs_.at(index)->getDataInterval();
128 }
129 
130 void Encoders::setDataInterval(int index, uint32_t data_interval_ms) const
131 {
132  return encs_.at(index)->setDataInterval(data_interval_ms);
133 }
134 
135 } // namespace phidgets
phidgets::Encoders::setIOMode
void setIOMode(int index, Phidget_EncoderIOMode io_mode) const
Definition: encoders.cpp:120
phidgets
Definition: accelerometer.h:39
encoder.h
phidgets::Encoders::setEnabled
void setEnabled(int index, bool enabled) const
Set the powered state of an encoder. If an encoder is not enabled, it will not be given power,...
Definition: encoders.cpp:110
phidgets::Encoders::setPosition
void setPosition(int index, int64_t position) const
Sets the offset of an encoder such that current position is the specified value.
Definition: encoders.cpp:95
phidgets::Encoders::~Encoders
~Encoders()
Definition: encoders.cpp:81
phidgets::Encoders::getIOMode
Phidget_EncoderIOMode getIOMode(int index) const
Definition: encoders.cpp:115
phidgets::helpers::openWaitForAttachment
void openWaitForAttachment(PhidgetHandle handle, int32_t serial_number, int hub_port, bool is_hub_port_device, int channel)
Definition: phidget22.cpp:57
phidgets::helpers::closeAndDelete
void closeAndDelete(PhidgetHandle *handle) noexcept
Definition: phidget22.cpp:93
phidgets::Encoders::encoder_count_
uint32_t encoder_count_
Definition: encoders.h:92
phidgets::Encoders::getDataInterval
uint32_t getDataInterval(int index) const
Definition: encoders.cpp:125
phidget22.h
phidgets::Phidget22Error
Definition: phidget22.h:46
phidgets::Encoders::encs_
std::vector< std::unique_ptr< Encoder > > encs_
Definition: encoders.h:93
encoders.h
phidgets::Encoders::getEncoderCount
uint32_t getEncoderCount() const
Gets the number of encoder input channels supported by this board.
Definition: encoders.cpp:85
phidgets::Encoders::getIndexPosition
int64_t getIndexPosition(int index) const
Gets the position of an encoder the last time an index pulse occured. An index pulse in this context ...
Definition: encoders.cpp:100
phidgets::Encoders::Encoders
Encoders(int32_t serial_number, int hub_port, bool is_hub_port_device, std::function< void(int, int, double, int)> position_change_handler)
Definition: encoders.cpp:40
phidgets::Encoders::getEnabled
bool getEnabled(int index) const
Checks if an encoder is powered on and receiving events.
Definition: encoders.cpp:105
phidgets::Encoders::setDataInterval
void setDataInterval(int index, uint32_t data_interval_ms) const
Definition: encoders.cpp:130
phidgets::Encoders::getPosition
int64_t getPosition(int index) const
Reads the current position of an encoder.
Definition: encoders.cpp:90


phidgets_api
Author(s): Tully Foote, Ivan Dryanovski
autogenerated on Sun May 11 2025 02:20:27