cfdm.core.Constructs¶
-
class
cfdm.core.
Constructs
(auxiliary_coordinate=None, dimension_coordinate=None, domain_ancillary=None, field_ancillary=None, cell_measure=None, coordinate_reference=None, domain_axis=None, cell_method=None, source=None, copy=True, _use_data=True, _view=False, _ignore=())[source]¶ Bases:
cfdm.core.abstract.container.Container
A container for metadata constructs.
The following metadata constructs can be included:
auxiliary coordinate constructs
coordinate reference constructs
cell measure constructs
dimension coordinate constructs
domain ancillary constructs
domain axis constructs
cell method constructs
field ancillary constructs
The container is used by used by
Field
andDomain
instances.The container is like a dictionary in many ways, in that it stores key/value pairs where the key is the unique construct key with corresponding metadata construct value, and provides some of the usual dictionary methods.
New in version (cfdm): 1.7.0
Initialization
- Parameters
- auxiliary_coordinate:
str
, optional The base name for keys of auxiliary coordinate constructs.
- Parameter example:
auxiliary_coordinate='auxiliarycoordinate'
- dimension_coordinate:
str
, optional The base name for keys of dimension coordinate constructs.
- Parameter example:
dimension_coordinate='dimensioncoordinate'
- domain_ancillary:
str
, optional The base name for keys of domain ancillary constructs.
- Parameter example:
domain_ancillary='domainancillary'
- field_ancillary:
str
, optional The base name for keys of field ancillary constructs.
- Parameter example:
field_ancillary='fieldancillary'
- cell_measure:
str
, optional The base name for keys of cell measure constructs.
- Parameter example:
cell_measure='cellmeasure'
- coordinate_reference:
str
, optional The base name for keys of coordinate reference constructs.
- Parameter example:
coordinate_reference='coordinatereference'
- domain_axis:
str
, optional The base name for keys of domain axis constructs.
- Parameter example:
domain_axis='domainaxis'
- cell_method:
str
, optional The base name for keys of cell method constructs.
- Parameter example:
cell_method='cellmethod'
- source: optional
Initialize the construct keys and contained metadata constructs from those of source.
- copy:
bool
, optional If False then do not deep copy metadata constructs from those of source prior to initialization. By default such metadata constructs are deep copied.
- _ignore: sequence of
str
, optional Ignores the given construct types.
- Parameter example:
_ignore=('cell_method', 'field_ancillary')
- auxiliary_coordinate:
Constructs and identifiers¶
Methods
Return the construct key of the sole metadata construct. |
|
Return the sole metadata construct. |
|
Return the type of a metadata construct for a given key. |
|
Return all of the construct types for all keys. |
|
Return a new, unused construct key. |
|
Replace one metadata construct with another. |
Miscellaneous¶
Methods
Return a deep copy. |
|
Return a shallow copy. |
|
Return the constructs in their predetermined order. |
Dictionary-access methods¶
Methods
Return the construct for construct key, if it exists, else default. |
|
Return the items as (construct key, construct) pairs. |
|
Return all of the construct keys, in arbitrary order. |
|
Return all of the metadata constructs, in arbitrary order. |
|
Return a construct with the given key. |
Special¶
Methods
Called to implement membership test operators for construct keys. |
|
Called by the |
|
Called by the |
|
Return a construct with the given key. |
|
Called when an iterator is required. |
|
Return the number of constructs. |
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. |