ola::Device Class Reference

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
void	SetName (const std::string &name)
AbstractPlugin *	Owner () const
std::string	UniqueId () const
virtual std::string	DeviceId () const =0
	The device ID.
bool	IsEnabled () const
bool	Start ()
bool	Stop ()
bool	AllowLooping () const
bool	AllowMultiPortPatching () const
bool	AddPort (InputPort *port)
bool	AddPort (OutputPort *port)
void	InputPorts (std::vector< InputPort * > *ports) const
void	OutputPorts (std::vector< OutputPort * > *ports) const
InputPort *	GetInputPort (unsigned int port_id) const
OutputPort *	GetOutputPort (unsigned int port_id) const
void	DeleteAllPorts ()
virtual void	Configure (ola::rpc::RpcController *controller, const std::string &request, std::string *response, ConfigureCallback *done)

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

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

Member Function Documentation

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::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::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::sandnet::SandNetDevice, ola::plugin::shownet::ShowNetDevice, ola::plugin::opendmx::OpenDmxDevice, ola::plugin::karate::KarateDevice, ola::plugin::pathport::PathportDevice, ola::plugin::espnet::EspNetDevice, and ola::plugin::dmx4linux::Dmx4LinuxDevice.

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::openpixelcontrol::OPCServerDevice, ola::plugin::usbdmx::GenericDevice, ola::plugin::usbdmx::JaRuleDevice, ola::plugin::spi::SPIDevice, ola::plugin::ftdidmx::FtdiDmxDevice, ola::plugin::gpio::GPIODevice, ola::plugin::dummy::DummyDevice, ola::plugin::pathport::PathportDevice, ola::plugin::sandnet::SandNetDevice, ola::plugin::uartdmx::UartDmxDevice, ola::plugin::milinst::MilInstDevice, ola::plugin::renard::RenardDevice, ola::plugin::shownet::ShowNetDevice, ola::plugin::espnet::EspNetDevice, ola::plugin::kinet::KiNetDevice, ola::plugin::opendmx::OpenDmxDevice, and ola::plugin::karate::KarateDevice.

---

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

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