Open Lighting Architecture: include/ola/client/ClientArgs.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
ClientArgs.h
Go to the documentation of this file.
1/*
2 * This library is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU Lesser General Public
4 * License as published by the Free Software Foundation; either
5 * version 2.1 of the License, or (at your option) any later version.
6 *
7 * This library is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 * Lesser General Public License for more details.
11 *
12 * You should have received a copy of the GNU Lesser General Public
13 * License along with this library; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15 *
16 * ClientArgs.h
17 * Types used as arguments to the OLA Client.
18 * Copyright (C) 2013 Simon Newton
19 */
20
21#ifndef INCLUDE_OLA_CLIENT_CLIENTARGS_H_
22#define INCLUDE_OLA_CLIENT_CLIENTARGS_H_
23
24#include <ola/client/CallbackTypes.h>
25#include <ola/dmx/SourcePriorities.h>
26
31
32namespace ola {
33namespace client {
34
38 enum PatchAction {
39 PATCH,
40 UNPATCH,
41};
42
46 enum RegisterAction {
47 REGISTER,
48 UNREGISTER,
49};
50
54 enum PortDirection {
55 INPUT_PORT,
56 OUTPUT_PORT,
57};
58
62 enum DiscoveryType {
63 DISCOVERY_CACHED,
64 DISCOVERY_INCREMENTAL,
65 DISCOVERY_FULL,
66};
67
71 struct SendDMXArgs {
76 uint8_t priority;
80 GeneralSetCallback *callback;
81
85 SendDMXArgs()
86 : priority(ola::dmx::SOURCE_PRIORITY_DEFAULT),
87 callback(NULL) {
88 }
89
93 explicit SendDMXArgs(GeneralSetCallback *_callback)
94 : priority(ola::dmx::SOURCE_PRIORITY_DEFAULT),
95 callback(_callback) {
96 }
97};
98
103 struct SendRDMArgs {
107 RDMCallback *callback;
108
112 bool include_raw_frames;
113
114 explicit SendRDMArgs(RDMCallback *_callback)
115 : callback(_callback),
116 include_raw_frames(false) {
117 }
118};
119} // namespace client
120} // namespace ola
121#endif // INCLUDE_OLA_CLIENT_CLIENTARGS_H_
CallbackTypes.h
The various callbacks used with the OLA Client.
SourcePriorities.h
The constants for DMX source priorities.
ola::client
OLA C++ API.
ola::client::DiscoveryType
DiscoveryType
The type of discovery to run with OlaClient::RunDiscovery().
Definition ClientArgs.h:62
ola::client::DISCOVERY_CACHED
@ DISCOVERY_CACHED
Definition ClientArgs.h:63
ola::client::DISCOVERY_INCREMENTAL
@ DISCOVERY_INCREMENTAL
Definition ClientArgs.h:64
ola::client::DISCOVERY_FULL
@ DISCOVERY_FULL
Definition ClientArgs.h:65
ola::client::RDMCallback
SingleUseCallback3< void, const Result &, const RDMMetadata &, const ola::rdm::RDMResponse * > RDMCallback
Called when a RDM request completes. Used with OlaClient::RDMGet() and OlaClient::RDMSet().
Definition CallbackTypes.h:154
ola::client::PatchAction
PatchAction
The patch action, used with OlaClient::Patch().
Definition ClientArgs.h:38
ola::client::PATCH
@ PATCH
Definition ClientArgs.h:39
ola::client::UNPATCH
@ UNPATCH
Definition ClientArgs.h:40
ola::client::PortDirection
PortDirection
The port direction.
Definition ClientArgs.h:54
ola::client::OUTPUT_PORT
@ OUTPUT_PORT
Definition ClientArgs.h:56
ola::client::INPUT_PORT
@ INPUT_PORT
Definition ClientArgs.h:55
ola::client::RegisterAction
RegisterAction
The register action, used with OlaClient::RegisterUniverse().
Definition ClientArgs.h:46
ola::client::UNREGISTER
@ UNREGISTER
Definition ClientArgs.h:48
ola::client::REGISTER
@ REGISTER
Definition ClientArgs.h:47
ola::client::GeneralSetCallback
BaseCallback1< void, const Result & > GeneralSetCallback
Invoked when an operation completes.
Definition CallbackTypes.h:91
ola::dmx
DMX512 related code.
Definition RunLengthEncoder.cpp:25
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44
ola::client::SendDMXArgs::SendDMXArgs
SendDMXArgs()
Create a new SendDMXArgs object.
Definition ClientArgs.h:85
ola::client::SendDMXArgs::priority
uint8_t priority
The priority of the data, defaults to ola::dmx::PRIORITY_DEFAULT.
Definition ClientArgs.h:76
ola::client::SendDMXArgs::SendDMXArgs
SendDMXArgs(GeneralSetCallback *_callback)
Create a new SendDMXArgs object.
Definition ClientArgs.h:93
ola::client::SendDMXArgs::callback
GeneralSetCallback * callback
the Callback to run upon completion. Defaults to NULL.
Definition ClientArgs.h:80
ola::client::SendRDMArgs::callback
RDMCallback * callback
Definition ClientArgs.h:107
ola::client::SendRDMArgs::include_raw_frames
bool include_raw_frames
Set to true to include frame & timing information in the response.
Definition ClientArgs.h:112