ola::Device Class Reference

Detailed Description

A partial implementation of a Device.

Inheritance diagram for ola::Device:

Collaboration diagram for ola::Device:

Public Member Functions
	Device (AbstractPlugin *owner, const std::string &name)
const std::string	Name () const
	The name of this Device.
void	SetName (const std::string &name)
	Sets the name of this Device.
AbstractPlugin *	Owner () const
	The Plugin that owns this Device.
std::string	UniqueId () const
	The unique id of this Device. More...
virtual std::string	DeviceId () const =0
	The device ID. More...
bool	IsEnabled () const
bool	Start ()
	Start the Device.
bool	Stop ()
	Stop the Device.
bool	AllowLooping () const
	Allow input and output ports to be patched to the same universe.
bool	AllowMultiPortPatching () const
	Allow multiple ports of the same type to be patched to the same universe.
bool	AddPort (InputPort *port)
bool	AddPort (OutputPort *port)
void	InputPorts (std::vector< InputPort *> *ports) const
	Fetch a list of all ports in this Device.
void	OutputPorts (std::vector< OutputPort *> *ports) const
InputPort *	GetInputPort (unsigned int port_id) const
	Lookup a particular InputPort in this Device.
OutputPort *	GetOutputPort (unsigned int port_id) const
	Lookup a particular OutputPort in this Device.
void	DeleteAllPorts ()
	Free all ports.
virtual void	Configure (ola::rpc::RpcController *controller, const std::string &request, std::string *response, ConfigureCallback *done)
	Configure this Device.

Protected Member Functions
virtual bool	StartHook ()
	Called during Start(). More...
virtual void	PrePortStop ()
virtual void	PostPortStop ()

Additional Inherited Members
Public Types inherited from ola::AbstractDevice
typedef BaseCallback0< void >	ConfigureCallback

Member Function Documentation

DeviceId()

virtual std::string ola::Device::DeviceId ( ) const

pure virtual

The device ID.

Returns

an id which is unique within the plugin,

Implemented in ola::plugin::openpixelcontrol::OPCClientDevice, ola::plugin::e131::E131Device, ola::plugin::artnet::ArtNetDevice, ola::plugin::stageprofi::StageProfiDevice, ola::plugin::osc::OSCDevice, ola::plugin::usbdmx::DMXCProjectsNodleU1Device, ola::plugin::usbpro::UltraDMXProDevice, ola::plugin::openpixelcontrol::OPCServerDevice, ola::plugin::usbdmx::GenericDevice, ola::plugin::usbdmx::JaRuleDevice, ola::plugin::usbpro::UsbProDevice, ola::plugin::gpio::GPIODevice, ola::plugin::spi::SPIDevice, ola::plugin::usbpro::ArduinoRGBDevice, ola::plugin::usbpro::DmxTriDevice, ola::plugin::ftdidmx::FtdiDmxDevice, ola::plugin::spidmx::SPIDMXDevice, ola::plugin::dummy::DummyDevice, ola::plugin::uartdmx::UartDmxDevice, ola::plugin::usbpro::DmxterDevice, ola::plugin::usbpro::RobeDevice, ola::plugin::milinst::MilInstDevice, ola::plugin::renard::RenardDevice, ola::plugin::kinet::KiNetDevice, ola::plugin::nanoleaf::NanoleafDevice, ola::plugin::sandnet::SandNetDevice, ola::plugin::shownet::ShowNetDevice, ola::plugin::karate::KarateDevice, ola::plugin::opendmx::OpenDmxDevice, ola::plugin::pathport::PathportDevice, ola::plugin::espnet::EspNetDevice, and ola::plugin::dmx4linux::Dmx4LinuxDevice.

StartHook()

virtual bool ola::Device::StartHook ( )

inlineprotectedvirtual

Called during Start().

This allows the subclass to perform device initialization.

Reimplemented in ola::plugin::artnet::ArtNetDevice, ola::plugin::openpixelcontrol::OPCClientDevice, ola::plugin::e131::E131Device, ola::plugin::osc::OSCDevice, ola::plugin::stageprofi::StageProfiDevice, ola::plugin::usbdmx::DMXCProjectsNodleU1Device, ola::plugin::openpixelcontrol::OPCServerDevice, ola::plugin::usbdmx::GenericDevice, ola::plugin::usbdmx::JaRuleDevice, ola::plugin::ftdidmx::FtdiDmxDevice, ola::plugin::spi::SPIDevice, ola::plugin::gpio::GPIODevice, ola::plugin::dummy::DummyDevice, ola::plugin::pathport::PathportDevice, ola::plugin::sandnet::SandNetDevice, ola::plugin::spidmx::SPIDMXDevice, ola::plugin::uartdmx::UartDmxDevice, ola::plugin::kinet::KiNetDevice, ola::plugin::milinst::MilInstDevice, ola::plugin::renard::RenardDevice, ola::plugin::shownet::ShowNetDevice, ola::plugin::espnet::EspNetDevice, ola::plugin::nanoleaf::NanoleafDevice, ola::plugin::karate::KarateDevice, and ola::plugin::opendmx::OpenDmxDevice.

UniqueId()

string ola::Device::UniqueId ( ) const

virtual

The unique id of this Device.

Note

This is guaranteed to be unique and persist across restarts.

Implements ola::AbstractDevice.

---

The documentation for this class was generated from the following files:

• include/olad/Device.h
• olad/plugin_api/Device.cpp