Open Lighting Architecture 0.10.9
Loading...
Searching...
No Matches
ola::Device Class Referenceabstract
Inheritance diagram for ola::Device:
ola::AbstractDevice ola::plugin::artnet::ArtNetDevice ola::plugin::dmx4linux::Dmx4LinuxDevice ola::plugin::dummy::DummyDevice ola::plugin::e131::E131Device ola::plugin::espnet::EspNetDevice ola::plugin::ftdidmx::FtdiDmxDevice ola::plugin::gpio::GPIODevice ola::plugin::karate::KarateDevice ola::plugin::kinet::KiNetDevice ola::plugin::milinst::MilInstDevice ola::plugin::opendmx::OpenDmxDevice ola::plugin::openpixelcontrol::OPCClientDevice ola::plugin::openpixelcontrol::OPCServerDevice ola::plugin::osc::OSCDevice ola::plugin::pathport::PathportDevice ola::plugin::renard::RenardDevice ola::plugin::sandnet::SandNetDevice ola::plugin::shownet::ShowNetDevice ola::plugin::spi::SPIDevice ola::plugin::stageprofi::StageProfiDevice ola::plugin::uartdmx::UartDmxDevice ola::plugin::usbdmx::DMXCProjectsNodleU1Device ola::plugin::usbdmx::GenericDevice ola::plugin::usbdmx::JaRuleDevice ola::plugin::usbpro::UsbSerialDevice

Public Member Functions

 Device (AbstractPlugin *owner, const std::string &name)
 
const std::string Name () const
 
void SetName (const std::string &name)
 
AbstractPluginOwner () 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
 
InputPortGetInputPort (unsigned int port_id) const
 
OutputPortGetOutputPort (unsigned int port_id) const
 
void DeleteAllPorts ()
 
virtual void Configure (ola::rpc::RpcController *controller, const std::string &request, std::string *response, ConfigureCallback *done)
 
- Public Member Functions inherited from ola::AbstractDevice

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

◆ AllowLooping()

bool ola::Device::AllowLooping ( ) const
inlinevirtual

Implements ola::AbstractDevice.

◆ AllowMultiPortPatching()

bool ola::Device::AllowMultiPortPatching ( ) const
inlinevirtual

Implements ola::AbstractDevice.

◆ Configure()

void ola::Device::Configure ( ola::rpc::RpcController * controller,
const std::string & request,
std::string * response,
ConfigureCallback * done )
virtual

◆ DeviceId()

◆ GetInputPort()

InputPort * ola::Device::GetInputPort ( unsigned int port_id) const
virtual

Implements ola::AbstractDevice.

◆ GetOutputPort()

OutputPort * ola::Device::GetOutputPort ( unsigned int port_id) const
virtual

Implements ola::AbstractDevice.

◆ InputPorts()

void ola::Device::InputPorts ( std::vector< InputPort * > * ports) const
virtual

Implements ola::AbstractDevice.

◆ Name()

const std::string ola::Device::Name ( ) const
inlinevirtual

Implements ola::AbstractDevice.

◆ OutputPorts()

void ola::Device::OutputPorts ( std::vector< OutputPort * > * ports) const
virtual

Implements ola::AbstractDevice.

◆ Owner()

AbstractPlugin * ola::Device::Owner ( ) const
inlinevirtual

Implements ola::AbstractDevice.

◆ PostPortStop()

virtual void ola::Device::PostPortStop ( )
inlineprotectedvirtual

◆ PrePortStop()

virtual void ola::Device::PrePortStop ( )
inlineprotectedvirtual

◆ StartHook()

◆ Stop()

bool ola::Device::Stop ( )
virtual

Implements ola::AbstractDevice.

◆ UniqueId()

string ola::Device::UniqueId ( ) const
virtual

Implements ola::AbstractDevice.


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