NDEVR
API Documentation
DeviCounterConnection.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2023, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: DeviCounter
28File: DLLInfo
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include <NDEVR/HardwareCommandQueue.h>
34#include <NDEVR/Connection.h>
35#include <NDEVR/ApplicationOptions.h>
36#include <functional>
37namespace NDEVR
38{
42 class DeviCounterConnection final : public Connection
43 {
44 public:
45 DeviCounterConnection(const Model& model, LogPtr raw_log = LogPtr(), LogPtr log = LogPtr(), QObject* parent = nullptr);
46 bool connectToSimulator();
47 bool open() final override;
48 bool open(const ConnectionInfo& request) final override;
49 public:
52 };
53}
The default object to store data of any type that should persist through sessions of the application.
Connection(const Model &model, LogPtr raw_network_log=nullptr, LogPtr command_log=nullptr, QObject *parent=nullptr)
Constructs a Connection with the given model and optional logs.
static ApplicationOption< bool > s_use_simulation
Whether to use the simulated device.
static ApplicationOption< String > s_devi_counter_connection
Connection address for the device.
bool open() final override
Opens the connection using the currently stored connection info.
A light-weight wrapper that will be a no-op if there is not a valid log reference,...
A core class that represents a node on model hierarchy.
Definition Model.h:292
The core String class for the NDEVR API.
Definition String.h:95
The primary namespace for the NDEVR SDK.
A structure designed to store information about a specific Connection.
Definition Connection.h:90