Document what types are possible for get and put
CI / build-and-test (push) Successful in 6s

This commit is contained in:
2026-04-29 11:59:44 +02:00
parent 5cc30780a0
commit abc57815eb
+20
View File
@@ -96,6 +96,16 @@ template <typename T> class mEpicsCa {
* for `T` depending on the record type (for an enum record with `T =
* uint16_t`, `std::string` is a valid "alias"). The corresponding string or
* uint value is then put into `value`.
*
* Supported types for V are:
* - `int`
* - `short`
* - `long`
* - `uint16_t`
* - `float`
* - `double`
* - `std::string`
* For char arrays, use `mEpicsCa::get(char *buf, u_long len)` instead.
* @param value Pointer which gets populated with the channel value if
* reading succeeded.
* @return int MIDAS status error code as defined in midas.h.
@@ -118,6 +128,16 @@ template <typename T> class mEpicsCa {
*
* @tparam V Type of the `value` pointer, which needs to be a valid "alias"
* for `T`, see `mEpicsCa::get`. This is checked during instantiation.
*
* Supported types for V are:
* - `int`
* - `short`
* - `long`
* - `uint16_t`
* - `float`
* - `double`
* - `std::string`
* For char arrays, use `mEpicsCa::put(char *buf, u_long len)` instead.
* @param value Pointer to the new value which gets written to the channel.
* @return int MIDAS status error code as defined in midas.h.
*/