simpeg.utils.validate_list_of_types

simpeg.utils.validate_list_of_types(property_name, var, class_type, ensure_unique=False, min_n=0, max_n=None)

Validate list of instances of a certain class

Parameters:

property_namestr

The name of the property being set

varobject or a list of object

A list of objects

class_typeclass or tuple of class types

Class type(s) that are allowed in the list

ensure_uniquebool, optional

Checks if all items in the var are unique items.

min_n, max_nint, optional

Minimum and maximum supported list length. Defaults accept any length list.

Returns:

list

Returns the list once validated