SurfaceCurrentListDCF3
- class s100py.s111.v1_2.api.SurfaceCurrentListDCF3(*args, **opts)
Bases:
SurfaceCurrentListBase
Attributes Summary
Methods Summary
add_data(key, value)append(object, /)Append object to the end of the list.
clear()Remove all items from list.
copy()Return a shallow copy of the list.
count(value, /)Return number of occurrences of value.
extend(iterable, /)Extend list by appending elements from the iterable.
Gets all the non-standard keys that are contained in this object currently as well as all the standard keys (S100/HDF5 style names) that could be added.
Override this method if the dtype of compound dataset items is important
get_data(key)get_hdf5_from_file(file_obj)get_s1xx_attr(s1xx_name)Returns the S100 (HDF5) names for the things that are listed in the specs for this class.
Returns a list of properties that are lists (children based on S1xxCollection).
This function autodetermines the properties implemented (which have get/set @properties and _hdf_name associated)
This function autodetermines the HDF5 or xml names and their associated property names.
Override this method if the data types of attributes/groups/dataset items is important
Override this method if the write order of attributes/groups/dataset items is important
index(value[, start, stop])Return first index of value.
initialize_properties([...])Calls the create function for all the properties of the class.
insert(index, object, /)Insert object before index.
pop([index])Remove and return item at index (default last).
read(group_object)Given an h5py.File or a h5py group then read the data based on the encoded S100+ spec.
read_simple_attributes(group_object)Reads the standard simple types (strings, ints, floats, datetimes, enums) from the given group as specified by the class specs.
remove(value, /)Remove first occurrence of value.
reverse()Reverse IN PLACE.
set_datetime_attribute(val, hdf_name, date_type)set_enum_attribute(val, hdf_name, enum_type)Function to set an attribute that is an enumeration type using either it's string or numeric value or enumeration instance.
set_s1xx_attr(s1xx_name, val)sort(*[, key, reverse])Sort the list in ascending order and return None.
write(group_object)write the contained data and all it's children into an HDF5 file using h5py.
write_as_xml(etree_object)write_simple_attributes(group_object)Attributes Documentation
- metadata_name
- metadata_type
- read_re_pattern = '[_\\.](\\d+)$'
- write_format_str = '.%02d'
Methods Documentation
- add_data(key, value)
- append(object, /)
Append object to the end of the list.
- append_new_item()
- clear()
Remove all items from list.
- copy()
Return a shallow copy of the list.
- count(value, /)
Return number of occurrences of value.
- extend(iterable, /)
Extend list by appending elements from the iterable.
- get_all_keys()
Gets all the non-standard keys that are contained in this object currently as well as all the standard keys (S100/HDF5 style names) that could be added.
- Return type:
list
- get_compound_dtype()
Override this method if the dtype of compound dataset items is important
- Return type:
A list of dtype, None otherwise.
- get_data(key)
- get_hdf5_from_file(file_obj)
- get_s1xx_attr(s1xx_name)
- get_standard_keys()
Returns the S100 (HDF5) names for the things that are listed in the specs for this class.
- Returns:
The S102 HDF5 group/attribute/dataset names from this object that will be written or read from an HDF5 file. e.g. BathymetryCoverage or westBoundLongitude etc.
For the class “Root”: [‘BathymetryCoverage’, ‘Group_F’, ‘TrackingListCoverage’]
- Return type:
list
- get_standard_list_properties()
Returns a list of properties that are lists (children based on S1xxCollection). Basically a way of finding which items will be named <name>_001, <name>_002 etc
- Returns:
The property names that will have auto-generated names based on their index in a list.
- Return type:
list
- classmethod get_standard_properties()
This function autodetermines the properties implemented (which have get/set @properties and _hdf_name associated)
- Returns:
Names of the properties implemented.
For eample class “Root” might have (for S102): [‘bathymetry_coverage’, ‘feature_information’, ‘tracking_list_coverage’]
- Return type:
list
- get_standard_properties_mapping()
This function autodetermines the HDF5 or xml names and their associated property names. Keys are the s100 (HDF5 spelling) strings and the values are the python style naming.
- Returns:
dictionary of xml element names as keys and property names as values.
For the class “Root”: {‘BathymetryCoverage’: ‘bathymetry_coverage’, ‘Group_F’: ‘feature_information’, ‘TrackingListCoverage’: ‘tracking_list_coverage’}
- Return type:
dict
- get_write_dtypes()
Override this method if the data types of attributes/groups/dataset items is important
- Return type:
A list of tuples having key names and type, None otherwise.
- get_write_order()
Override this method if the write order of attributes/groups/dataset items is important
- Return type:
A list of key names if order is important, None otherwise.
- index(value, start=0, stop=9223372036854775807, /)
Return first index of value.
Raises ValueError if the value is not present.
- initialize_properties(recursively_create_children=False, overwrite=True)
Calls the create function for all the properties of the class. Default values will be created for each attribute that is expected to be contained in this object.
For example, say a class has simple attributes of ESPG code (int) and locatilty (str) and then a class made from S1xxObject called “extents” which has east and west inside it.
Calling initialize_properties(recursively_create_children=False) would result in EPSG=0, locality=”” and an instance of the “extents” class but NO value (nothing would be written to HDF5) for east, west.
Calling initialize_properties(recursively_create_children=True) would result in EPSG=0, locality=”” and an instance of the “extents” class but with east=0.0 and wesst=0.0 as well.
Calling initialize_properties(recursively_create_children=True, overwrite=False) with an esiting dataset, say locality=”test” would result in EPSG=0 being made, locality=”test” being retained and an instance of the “extents” class with east=0.0 and wesst=0.0 as well.
- Parameters:
recursively_create_children – True = Create children for any child data that would have other children False = Only create data for immediate children of this instance
overwrite – True = Overwrite existing data with new default data False = Keep existing data if it exists but create new data otherwise
- Return type:
None
- insert(index, object, /)
Insert object before index.
- pop(index=-1, /)
Remove and return item at index (default last).
Raises IndexError if list is empty or index is out of range.
- read(group_object)
Given an h5py.File or a h5py group then read the data based on the encoded S100+ spec.
- Parameters:
group_object – The group (an h5py.File is a group too) to read from.
- Return type:
None
- read_simple_attributes(group_object)
Reads the standard simple types (strings, ints, floats, datetimes, enums) from the given group as specified by the class specs.
- Parameters:
group_object – The group (an h5py.File is a group too) to read from.
- Return type:
None
- remove(value, /)
Remove first occurrence of value.
Raises ValueError if the value is not present.
- reverse()
Reverse IN PLACE.
- set_datetime_attribute(val, hdf_name, date_type)
- set_enum_attribute(val, hdf_name, enum_type)
Function to set an attribute that is an enumeration type using either it’s string or numeric value or enumeration instance.
- Parameters:
val – The value as a string, int or Enum().
hdf_name – The S100 name (hdf5 spelling).
enum_type – The class of enumeration to use if an instance needs to be created.
- Return type:
None
- set_s1xx_attr(s1xx_name, val)
- sort(*, key=None, reverse=False)
Sort the list in ascending order and return None.
The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).
If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.
The reverse flag can be set to sort in descending order.
- write(group_object)
write the contained data and all it’s children into an HDF5 file using h5py.
- Parameters:
group_object – An h5py.File or an h5py group object
- Return type:
None
- write_as_xml(etree_object)
- write_simple_attributes(group_object)
- __init__(*args, **opts)