Detailed Description

A Generic device.

This simple generic device creates a single output port around a Widget.

Inheritance diagram for ola::plugin::usbdmx::GenericDevice:

Collaboration diagram for ola::plugin::usbdmx::GenericDevice:

Public Member Functions
	GenericDevice (ola::AbstractPlugin owner, class WidgetInterface widget, const std::string &device_name, const std::string &device_id)
	Create a new GenericDevice. More...

std::string	DeviceId () const
	The device ID. More...

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	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
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

ola::plugin::usbdmx::GenericDevice::GenericDevice	(	ola::AbstractPlugin *	owner,
		class WidgetInterface *	widget,
		const std::string &	device_name,
		const std::string &	device_id
	)

Create a new GenericDevice.

Parameters

owner	The plugin this device belongs to
widget	The widget to use for this device.
device_name	The name of the device.
device_id	The id of the device.

std::string ola::plugin::usbdmx::GenericDevice::DeviceId ( ) const

inlinevirtual

The device ID.

Implements ola::Device.

bool ola::plugin::usbdmx::GenericDevice::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: