21 #ifndef INCLUDE_OLA_CLIENT_CLIENTTYPES_H_ 22 #define INCLUDE_OLA_CLIENT_CLIENTTYPES_H_ 25 #include <ola/rdm/RDMFrame.h> 47 const std::string &name,
59 unsigned int Id()
const {
return m_id; }
64 const std::string&
Name()
const {
return m_name; }
78 bool operator<(
const OlaPlugin &other)
const {
79 return m_id < other.m_id;
122 unsigned int universe,
124 const std::string &description,
130 m_universe(universe),
132 m_description(description),
133 m_priority_capability(capability),
134 m_priority_mode(mode),
135 m_priority(priority),
136 m_supports_rdm(supports_rdm) {}
139 unsigned int Id()
const {
return m_id; }
144 unsigned int Universe()
const {
return m_universe; }
146 bool IsActive()
const {
return m_active; }
154 return m_priority_capability;
157 return m_priority_mode;
160 uint8_t Priority()
const {
return m_priority; }
170 unsigned int m_universe;
172 std::string m_description;
185 unsigned int universe,
187 const std::string &description,
192 OlaPort(port_id, universe, active, description,
193 capability, mode, priority, supports_rdm) {
203 unsigned int universe,
205 const std::string &description,
210 OlaPort(port_id, universe, active, description,
211 capability, mode, priority, supports_rdm) {
223 const std::string &name,
225 const std::vector<OlaInputPort> &input_ports,
226 const std::vector<OlaOutputPort> &output_ports):
230 m_plugin_id(plugin_id),
231 m_input_ports(input_ports),
232 m_output_ports(output_ports) {}
235 std::string
Id()
const {
return m_id; }
236 unsigned int Alias()
const {
return m_alias; }
237 const std::string&
Name()
const {
return m_name; }
238 int PluginId()
const {
return m_plugin_id; }
240 const std::vector<OlaInputPort> &InputPorts()
const {
241 return m_input_ports;
243 const std::vector<OlaOutputPort> &OutputPorts()
const {
244 return m_output_ports;
247 bool operator<(
const OlaDevice &other)
const {
248 return m_alias < other.m_alias;
253 unsigned int m_alias;
256 std::vector<OlaInputPort> m_input_ports;
257 std::vector<OlaOutputPort> m_output_ports;
273 const std::string &name,
274 const std::vector<OlaInputPort> &input_ports,
275 const std::vector<OlaOutputPort> &output_ports,
276 unsigned int rdm_device_count):
280 m_input_ports(input_ports),
281 m_output_ports(output_ports),
282 m_rdm_device_count(rdm_device_count) {}
285 unsigned int Id()
const {
return m_id;}
286 merge_mode MergeMode()
const {
return m_merge_mode; }
287 const std::string&
Name()
const {
return m_name;}
288 unsigned int InputPortCount()
const {
return m_input_ports.size(); }
289 unsigned int OutputPortCount()
const {
return m_output_ports.size(); }
290 unsigned int RDMDeviceCount()
const {
return m_rdm_device_count; }
292 const std::vector<OlaInputPort> &InputPorts()
const {
293 return m_input_ports;
295 const std::vector<OlaOutputPort> &OutputPorts()
const {
296 return m_output_ports;
301 merge_mode m_merge_mode;
303 std::vector<OlaInputPort> m_input_ports;
304 std::vector<OlaOutputPort> m_output_ports;
305 unsigned int m_rdm_device_count;
323 : universe(_universe),
324 priority(_priority) {
350 : response_code(_response_code) {
355 #endif // INCLUDE_OLA_CLIENT_CLIENTTYPES_H_
static const uint8_t SOURCE_PRIORITY_DEFAULT
The default priority for a source.
Definition: SourcePriorities.h:41
The constants for DMX source priorities.
bool enabled
true if the plugin is enabled.
Definition: ClientTypes.h:101
RDMStatusCode
RDM Status Codes.
Definition: RDMResponseCodes.h:45
unsigned int Universe() const
The universe this port is patched to.
Definition: ClientTypes.h:144
Represents a device.
Definition: ClientTypes.h:219
const std::string & Description() const
The description of this port.
Definition: ClientTypes.h:151
port_priority_mode
Defines the different priority modes that OLA supports.
Definition: PortConstants.h:44
unsigned int Id() const
The plugin id.
Definition: ClientTypes.h:59
port_priority_capability
Defines the priority capability of a Port.
Definition: PortConstants.h:58
The state of a plugin. This information can be used to detect conflicts between plugins.
Definition: ClientTypes.h:93
bool IsEnabled() const
Indicates if the plugin is enabled or not.
Definition: ClientTypes.h:76
Enums representing the states of a response. This is generated from the proto file.
std::string preferences_source
The source of preferences for this plugin.
Definition: ClientTypes.h:109
bool IsActive() const
Indicates if the plugin is active or not.
Definition: ClientTypes.h:70
const std::string & Name() const
The name of the plugin.
Definition: ClientTypes.h:64
Different priority modes and priority capabilities. Please make sure to visit Merging Algorithms for ...
Represents a universe.
Definition: ClientTypes.h:264
bool active
true if the plugin is active.
Definition: ClientTypes.h:105
std::string name
The name of the plugin.
Definition: ClientTypes.h:97
An Output Port (sends DMX).
Definition: ClientTypes.h:200
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
Represents a Plugin.
Definition: ClientTypes.h:44
bool SupportsRDM() const
Indicates if this port supports RDM.
Definition: ClientTypes.h:166
The base class that represents a port.
Definition: ClientTypes.h:119
std::vector< OlaPlugin > conflicting_plugins
A list on plugins which conflict with this one.
Definition: ClientTypes.h:113