cfdm.core.Parameters¶
-
class
cfdm.core.
Parameters
(parameters=None, source=None, copy=True)[source]¶ Bases:
cfdm.core.abstract.container.Container
Mixin class for a collection of named parameters.
New in version (cfdm): 1.7.0
Initialization
- Parameters
- parameters:
dict
, optional Set parameters. The dictionary keys are parameter names, with corresponding values. Ignored if the source parameter is set.
Parameters may also be set after initialisation with the
set_parameters
andset_parameter
methods.- Parameter example:
parameters={'earth_radius': 6371007.}
- source: optional
Initialize the parameters from those of source.
Note that if source is a
Parameters
instance thencfdm.core.Parameters(source=source)
is equivalent tosource.copy()
.- copy:
bool
, optional If False then do not deep copy input parameters prior to initialization. By default arguments are deep copied.
- parameters:
Parameter terms¶
Methods
Delete a parameter. |
|
Get a parameter value. |
|
Whether a parameter has been set. |
|
Set a parameter-valued term. |
|
Return all parameters. |
|
Remove all parameters. |
|
Set parameters. |
Docstring substitutions¶
Methods
Return the special docstring substitutions. |
|
Return the docstring substitutions that apply to methods of the given class. |
|
Return the package depth, N, for {{package}} docstring substitutions for the given class. |
|
Return the names of methods to exclude from docstring substitutions for the given class. |