A mixin to add a parameter set field to a model component class. More...
Inheritance diagram for carputils.model.general.ParameterSetMixin:
Public Member Functions | |
| def | __init__ (self, *args, **kwargs) |
| def | opts (self) |
| Generator that yields field name - value pairs for the command line. More... | |
Static Public Attributes | |
| PARAMETERS = None | |
| PARAMSET_FIELD = None | |
Detailed Description
A mixin to add a parameter set field to a model component class.
Two class attributes must be set in subclasses - PARAMETERS, the list of allowed parameters, and PARAMSET_FIELD, the name of the field to which the parameter set's values should be assigned.
Constructor & Destructor Documentation
◆ __init__()
| def carputils.model.general.ParameterSetMixin.__init__ | ( | self, | |
| * | args, | ||
| ** | kwargs | ||
| ) |
Reimplemented in carputils.model.general.AbstractIonicModel, and carputils.model.general.ModelMixin.
Member Function Documentation
◆ opts()
| def carputils.model.general.ParameterSetMixin.opts | ( | self | ) |
Generator that yields field name - value pairs for the command line.
Reimplemented in carputils.model.general.AbstractIonicModel, and carputils.model.general.ModelMixin.
Member Data Documentation
◆ PARAMETERS
|
static |
◆ PARAMSET_FIELD
|
static |
The documentation for this class was generated from the following file:
- carputils/model/general.py
