sailor.assetcentral.failure_mode

Failure Mode module can be used to retrieve FailureMode information from AssetCentral.

Classes are provided for individual FailureModes as well as groups of FailureModes (FailureModeSet).

class sailor.assetcentral.failure_mode.FailureMode(ac_json)

Bases: AssetcentralEntity

AssetCentral Failure Mode Object.

Parameters

ac_json (dict) –

classmethod get_available_properties()

Return the available properties for this class.

property id

Return the ID of the object.

class sailor.assetcentral.failure_mode.FailureModeSet(elements)

Bases: AssetcentralEntitySet

Class representing a group of FailureModes.

as_df(columns=None)

Return all information on the objects stored in the MasterDataEntitySet as a pandas dataframe.

columns can be specified to select the columns (and their order) for the DataFrame.

Parameters

columns (Optional[Iterable[str]]) –

filter(**kwargs)

Select a subset of the collection based on named filter criteria for the attributes of the elements.

All keyword arguments are concatenated as filters with OR operator, i.e., only one of the supplied filters must match for an entity to be selected.

Returns a new AssetcentralEntitySet object.

Return type

MasterDataEntitySet

plot_distribution(by=None, fill=None, dropna=False)

Plot the distribution of elements of a MasterDataEntitySet based on their properties.

This effectively creates a histogram with the number of elements per group on the y-axis, and the group (given by the by parameter) on the x-axis. Additionally, the fill colour of the bar can be used to distinguish a second dimension.

sailor.assetcentral.failure_mode.find_failure_modes(*, extended_filters=(), **kwargs)

Fetch FailureModes from AssetCentral with the applied filters, return an FailureModeSet.

This method supports the usual filter criteria, i.e. - Any named keyword arguments applied as equality filters, i.e. the name of the FailureMode property is checked against the value of the keyword argument. If the value of the keyword argument is an iterable (e.g. a list) then all objects matching any of the values in the iterable are returned.

Parameters

• extended_filters – See Filter Language.

• **kwargs – See Filter Language.

Return type

FailureModeSet

Examples

Find all FailureModes with name ‘MyFailureMode’:

find_failure_modes(name='MyFailureMode')

Find all FailureModes which either have the name ‘MyFailureMode’ or the name ‘MyOtherFailureMode’:

find_failure_modes(name=['MyFailureMode', 'MyOtherFailureMode'])

If multiple named arguments are provided then all conditions have to match.

Example

Find all FailureModes with name ‘MyFailureMode’ which also have the short description ‘Description’:

find_failure_modes(name='MyFailureMode', short_description='Description')

The extended_filters parameter can be used to specify filters that can not be expressed as an equality. Each extended_filter needs to be provided as a string, multiple filters can be passed as a list of strings. As above, all filter criteria need to match. Extended filters can be freely combined with named arguments. Here, too, all filter criteria need to match for a FailureMode to be returned.

Example

Find all FailureModes where equipment count higher or equal to 5:

find_failure_modes(extended_filters=['equipments_count >= 5'])