ola::plugin::openpixelcontrol::OPCServerDevice Class Reference

Inheritance diagram for ola::plugin::openpixelcontrol::OPCServerDevice:

Collaboration diagram for ola::plugin::openpixelcontrol::OPCServerDevice:

Public Member Functions
	OPCServerDevice (AbstractPlugin *owner, PluginAdaptor *plugin_adaptor, Preferences *preferences, const ola::network::IPV4SocketAddress listen_addr)
	Create a new OPC server device. More...
std::string	DeviceId () const
	The device ID. More...
bool	AllowMultiPortPatching () const
	Allow multiple ports of the same type to be patched to the same universe.
Public Member Functions inherited from ola::Device
	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...
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	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
bool	StartHook ()
	Called during Start(). More...
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

OPCServerDevice()

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

owner	the Plugin that owns this device
plugin_adaptor	the PluginAdaptor to use
preferences	the Preferences container.
listen_addr	the IP:port to listen on.

Member Function Documentation

DeviceId()

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

virtual

The device ID.

Returns

an id which is unique within the plugin,

Implements ola::Device.

StartHook()

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:

• plugins/openpixelcontrol/OPCDevice.h
• plugins/openpixelcontrol/OPCDevice.cpp