kappa_sdk.ShutInList

class kappa_sdk.ShutInList(shutins=None)

Class to store a List of Shut-in

Methods

ShutInList.append(object, /)	Append object to the end of the list.
ShutInList.clear()	Remove all items from list.
ShutInList.copy()	Return a shallow copy of the list.
ShutInList.count(value, /)	Return number of occurrences of value.
ShutInList.extend(iterable, /)	Extend list by appending elements from the iterable.
ShutInList.from_data(data)	Initialize a ShutInList object from a Data object
ShutInList.index(value[, start, stop])	Return first index of value.
ShutInList.insert(index, object, /)	Insert object before index.
ShutInList.pop([index])	Remove and return item at index (default last).
ShutInList.remove(value, /)	Remove first occurrence of value.
ShutInList.reverse()	Reverse IN PLACE.
ShutInList.sort(*[, key, reverse])	Sort the list in ascending order and return None.

Parameters:

shutins (Optional[List[ShutIn]])

__init__(shutins=None)

Parameters:

shutins (List[ShutIn] | None)

Return type:

None

static from_data(data)

Initialize a ShutInList object from a Data object

Parameters:

data (Data) – a Data object

Returns:

ShutInList – A list of ShutIn objects

Return type:

ShutInList