hwm.hardware.devices.drivers.service.Service Class Reference

Provides the base automated service abstract class. More...

Inheritance diagram for hwm.hardware.devices.drivers.service.Service:

Public Member Functions
def	__init__
	Sets up the service instance. More...
def	id
	Returns the ID of the service. More...
def	type
	Returns the service type. More...

Private Attributes
	_service_id
	_service_type

Detailed Description

Provides the base automated service abstract class.

This class provides a base abstract class that driver services may implement.

Note

The properties defined by this interface are required for the Pipeline class (among others) to function properly. If you decide not to use this class, make sure to implement these properties.

Constructor & Destructor Documentation

def hwm.hardware.devices.drivers.service.Service.__init__	(		self,
			service_id,
			service_type
	)

Sets up the service instance.

Parameters

service_id	The service ID (what other pipeline devices will search for when looking for the service).
service_type	The service type.

Member Function Documentation

def hwm.hardware.devices.drivers.service.Service.id

(

self)

Returns the ID of the service.

This property returns the ID of the service which, when combined with the service type, forms a unique identifier for a given pipeline.

def hwm.hardware.devices.drivers.service.Service.type

(

self)

Returns the service type.

This property returns the service's type as a string. There are several standard service types (such as 'tracker') that the service can use, or it can define its own. However, if a service defines its own type other devices will only be able to use it if they query that specific type and if they know how to use the interface.

---

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

• hwm/hardware/devices/drivers/service.py