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
26
32namespace ola {
33namespace client {
34
42
50
58
67
76 uint8_t priority;
81
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
108
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_
The various callbacks used with the OLA Client.
The constants for DMX source priorities.
The base class for all 1 argument callbacks.
Definition Callback.h:982
A 3 argument callback which deletes itself after it's run.
Definition Callback.h:2850
DiscoveryType
The type of discovery to run with OlaClient::RunDiscovery().
Definition ClientArgs.h:62
@ DISCOVERY_CACHED
Definition ClientArgs.h:63
@ DISCOVERY_INCREMENTAL
Definition ClientArgs.h:64
@ DISCOVERY_FULL
Definition ClientArgs.h:65
PatchAction
The patch action, used with OlaClient::Patch()
Definition ClientArgs.h:38
@ PATCH
Definition ClientArgs.h:39
@ UNPATCH
Definition ClientArgs.h:40
PortDirection
The port direction.
Definition ClientArgs.h:54
@ OUTPUT_PORT
Definition ClientArgs.h:56
@ INPUT_PORT
Definition ClientArgs.h:55
RegisterAction
The register action, used with OlaClient::RegisterUniverse()
Definition ClientArgs.h:46
@ UNREGISTER
Definition ClientArgs.h:48
@ REGISTER
Definition ClientArgs.h:47
The namespace containing all OLA symbols.
Definition Credentials.cpp:44
Arguments passed to the SendDMX() method.
Definition ClientArgs.h:71
SendDMXArgs()
Create a new SendDMXArgs object.
Definition ClientArgs.h:85
uint8_t priority
The priority of the data, defaults to ola::dmx::PRIORITY_DEFAULT.
Definition ClientArgs.h:76
SendDMXArgs(GeneralSetCallback *_callback)
Create a new SendDMXArgs object.
Definition ClientArgs.h:93
GeneralSetCallback * callback
the Callback to run upon completion. Defaults to NULL.
Definition ClientArgs.h:80
Arguments used with OlaClient::RDMGet() and OlaClient::RDMSet() methods.
Definition ClientArgs.h:103
RDMCallback * callback
Definition ClientArgs.h:107
bool include_raw_frames
Set to true to include frame & timing information in the response.
Definition ClientArgs.h:112