cfdm.core.Properties¶
-
class
cfdm.core.
Properties
(properties=None, source=None, copy=True)[source]¶ Bases:
cfdm.core.abstract.container.Container
Mixin class for an object with descriptive properties.
New in version (cfdm): 1.7.0
Initialisation
- Parameters
- properties:
dict
, optional Set descriptive properties. The dictionary keys are property names, with corresponding values. Ignored if the source parameter is set.
Properties may also be set after initialisation with the
set_properties
andset_property
methods.- Parameter example:
properties={'standard_name': 'altitude'}
- source: optional
Initialise the properties from those of source.
Note that if source is a
Properties
instance thencfdm.core.Properties(source=source)
is equivalent tosource.copy()
.- copy:
bool
, optional If False then do not deep copy input parameters prior to initialisation. By default arguments are deep copied.
- properties:
Properties¶
Methods
Remove a property. |
|
Return a property. |
|
Whether a property has been set. |
|
Set a property. |
|
Return all properties. |
|
Remove all properties. |
|
Set properties. |
Miscellaneous¶
Methods
Return a deep copy. |
|
Whether or not there are cell bounds. |
|
Whether or not the construct has data. |
Special¶
Methods
Called by the |
Docstring substitutions¶
Methods
Return the special docstring substitutions. |
|
Returns the substitutions that apply to methods of the class. |
|
Returns the class {{package}} substitutions package depth. |
|
Returns method names excluded in the class substitutions. |