simple_auxiliary

Simple Auxiliary Interface

module:

simple_auxiliary

synopsis:

common auxiliary interface for very simple auxiliary (without usage of thread or multiprocessing)

class pykiso.interfaces.simple_auxiliary.SimpleAuxiliaryInterface(name=None, activate_log=None)

Define the interface for all simple auxiliary where usage of thread or mulitprocessing is not necessary.

Auxiliary initialization.

Parameters:

• activate_log (List[str]) – loggers to deactivate

• name (str) – alias of the auxiliary instance

create_instance()

Create an auxiliary instance and ensure the communication to it.

Return type:

bool

Returns:

True if creation was successful otherwise False

Raises:

AuxiliaryCreationError – if instance creation failed

delete_instance()

Delete an auxiliary instance and its communication to it.

Return type:

bool

Returns:

True if deletion was successful otherwise False

resume()

Resume current auxiliary’s run, by running the create_instance method in the background. :rtype: None

Warning

due to the usage of create_instance if an issue occurred the exception AuxiliaryCreationError is raised.

stop()

Stop the auxiliary

suspend()

Suspend current auxiliary’s run.

Return type:

None