BSPumpService

class BSPumpService(app, service_name='bspump.PumpService')[source]

Bases: Service

Service registry based on Service object. Read more in ASAB documentation `Service <https://asab.readthedocs.io/en/latest/asab/service.html`_.

BSPumpService.__init__()[source]

Initializes parameters passed to the Service class.

Parameters

appApplication: Name of the Application.
service_namestr, Service name: string variable containing “”bspump.PumpService

BSPumpService Methods

BSPumpService.locate(address)[source]

locates pipeline, source or processor based on the adressed parameter

Parameters

addressstr, ID: Address of an pipeline component.

BSPumpService.add_pipeline(pipeline)[source]

Adds a pipeline to the BSPump.

Parameters

pipelinePipeline: Name of the Pipeline.

BSPumpService.add_pipelines(*pipelines)[source]

Adds a pipelines the BSPump.

Parameters

*pipelineslist: List of pipelines that are add to the BSPump.

BSPumpService.del_pipeline(pipeline)[source]

Deletes a pipeline from a list of Pipelines.

**Parameters*

pipelinestr, ID: ID of a pipeline.

BSPumpService.add_connection(connection)[source]

Adds a connection to the Connection dictionary.

Parameters

connectionstr, ID: ID of a connection.

Returns: connection

BSPumpService.add_connections(*connections)[source]

Adds a connections to the Connection dictionary.

Parameters

*connectionstr, ID: list of IDs of a connections.

BSPumpService.locate_connection(connection_id)[source]

Locates connection based on connection ID.

Parameters

connection_idID: Connection ID.

BSPumpService.add_lookup(lookup)[source]

Sets a lookup based on Lookup.

Parameters

lookupLookup: Name of the Lookup.

Returns: lookup

BSPumpService.add_lookups(*lookups)[source]

Adds a list of lookups to the Pipeline.

Parameters

lookupLookup: List of Lookups.

BSPumpService.locate_lookup(lookup_id, context=None)[source]

Locates lookup based on ID.

Parameters

lookup_idID: ID of a Lookup.
context,default = None: Additional information.

Returns: lookup from the lookup service or form the internal dictionary.

BSPumpService.add_lookup_factory(lookup_factory)[source]

Adds a lookup factory

Parameters

lookup_factory :: Name of lookup factory.

BSPumpService.add_matrix(matrix)[source]

Adds a matrix to the Pipeline.

Parameters

matrixMatrix: Name of Matrix.

Returns: matrix

BSPumpService.add_matrixes(*matrixes)[source]

Adds a list of Matrices to the Pipeline.

Parameters

*matrixeslist: List of matrices.

BSPumpService.locate_matrix(matrix_id)[source]

Locates a matrix based on matrix ID

Parameters

matrix_idstr, ID: ID of a matrix.

async BSPumpService.initialize(app)[source]

Initializes an Application based on ASAB Application

Parameters

appApplication: Name of the Application

async BSPumpService.finalize(app)[source]

Stops all the pipelines

Parameters

appApplication: Name of the Application