Class PropertiesValidatorMixin

            object --+    
                     |    
InputMultiplicityMixin --+
                         |
                        PropertiesValidatorMixin

A mixin that verifies that all selected properties can be calculated for the input entries. The check is done for certain properties that can not be calculated for entries with spin multiplicity > 1. Classes that use this mixin must have both "Input" and "Properties" tabs.

Instance Methods

[hide private]

setup(self)
Initialize Mixin.

bool or tuple

checkMultiplicityProperty(self)
This function creates a list of entries for which some properties can not be calculated.

_getWarningText(self, names, props)
This function creates a text of warning message that will contain names of entries with multiplicity > 1 and a list of properties that can not be calculated for these entries.

Inherited from InputMultiplicityMixin (private): _getEntriesWithMultiplicity

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

setup(self)

Initialize Mixin.

Overrides: InputMultiplicityMixin.setup

checkMultiplicityProperty(self)

This function creates a list of entries for which some properties can not be calculated. A warning message is presented that shows both entry names and a list of offending properties.

Returns: bool or tuple

True if all calculations can be run, otherwise returns a tuple that contains False and a string with informative message.

Decorators:

@af2.validator()

_getWarningText(self, names, props)

This function creates a text of warning message that will contain names of entries with multiplicity > 1 and a list of properties that can not be calculated for these entries.

Parameters:

names (list) - list of entry names
props (list) - list of properties