Open Lighting Architecture  0.9.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
ola::plugin::openpixelcontrol::OPCServerDevice Class Reference
Inheritance diagram for ola::plugin::openpixelcontrol::OPCServerDevice:
ola::Device ola::AbstractDevice

Public Member Functions

 OPCServerDevice (AbstractPlugin *owner, PluginAdaptor *plugin_adaptor, Preferences *preferences, const ola::network::IPV4SocketAddress listen_addr)
 Create a new OPC server device.
std::string DeviceId () const
 The device ID.
bool AllowMultiPortPatching () const
- Public Member Functions inherited from ola::Device
 Device (AbstractPlugin *owner, const std::string &name)
const std::string Name () const
void SetName (const std::string &name)
AbstractPluginOwner () const
std::string UniqueId () const
bool IsEnabled () const
bool Start ()
bool Stop ()
bool AllowLooping () 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)

Protected Member Functions

bool StartHook ()
 Called during Start().
- Protected Member Functions inherited from ola::Device
virtual void PrePortStop ()
virtual void PostPortStop ()

Additional Inherited Members

- Public Types inherited from ola::AbstractDevice
typedef BaseCallback0< void > ConfigureCallback

Constructor & Destructor Documentation

ola::plugin::openpixelcontrol::OPCServerDevice::OPCServerDevice ( AbstractPlugin owner,
PluginAdaptor plugin_adaptor,
Preferences preferences,
const ola::network::IPV4SocketAddress  listen_addr 
)

Create a new OPC server device.

Parameters
ownerthe Plugin that owns this device
plugin_adaptorthe PluginAdaptor to use
preferencesthe Preferences container.
listen_addrthe IP:port to listen on.

Member Function Documentation

string ola::plugin::openpixelcontrol::OPCServerDevice::DeviceId ( ) const
virtual

The device ID.

Returns
an id which is unique within the plugin,

Implements ola::Device.

bool ola::plugin::openpixelcontrol::OPCServerDevice::StartHook ( )
protectedvirtual

Called during Start().

This allows the subclass to perform device initialization.

Reimplemented from ola::Device.


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