interface - Systems

This topic discusses the Systems feature provided by the PLANTA Link API.

Classes

System

Methods

Function Parameters Return Value Description
System.__eq__(self, other) other: TODO, describe other! TODO RETURN VALUE TODO DESCRIPTION
System.__hash__(self)   TODO RETURN VALUE TODO DESCRIPTION
System.__init__(self, system_id) system_id: TODO, describe system_id! TODO RETURN VALUE TODO DESCRIPTION
System.__new__(cls, system_id, **kwargs) system_id: TODO, describe system_id!
kwargs: TODO, describe kwargs!
TODO RETURN VALUE TODO DESCRIPTION
System.create_conditional(self, classname, parameter, expected_value) classname: TODO, describe classname!
parameter: TODO, describe parameter!
expected_value: TODO, describe expected_value!
TODO RETURN VALUE TODO DESCRIPTION
System.delete(self)     Delete this system

Classmethods

Function Parameters Return Value Description
System.create(cls, **creation_parameters) creation_parameters: TODO, describe creation_parameters! TODO RETURN VALUE TODO DESCRIPTION
System.get_active_system(cls)   System or None Get the System instance that is currently active
System.get_active_system_id(cls)   UUID or None Retrieve the UUID of the currently active system

Staticmethods

Function Parameters Return Value Description
System.get_all_system_ids()   A list of UUID Fetches the UUID of all systems stored in the database

Properties

Property Getter Setter Description
System.is_active checked unchecked Returns True when all conditionals of this system meet their expected value

RegtestSystem

Methods

Function Parameters Return Value Description
RegtestSystem.__enter__(self)   RegtestSystem instance Enter the context
RegtestSystem.__exit__(self, *exc_details) exc_details: Exception details   Leave the context, deleting the RegtestSystem
Topic revision: r1 - 2017-10-10 - 18:06:35 - MarcelCarl








 
  • Suche in Topic-Namen

  • Suche in Topic-Inhalten