The classes in s111.api can be accessed by just importing s111. They are automatically imported but can be brought in separately if desired.:

from s100py import s111
s111.s111File(...)
# or
from s100py.s111 import api
api.s111File(...)
# or
from s100py import s111.api
s111.api.s111File(...)

s100py.s111.v1_2.api Module

Classes

DATA_DYNAMICITY(value[, names, module, ...])

S111 v1.2 Table 12.10 - Classification of data according to the relationship between the time of its collection, generation, or calculation of generation parameters, in relation to the time of publication of the dataset.

DEPTH_TYPE_INDEX(value[, names, module, ...])

S111 v1.2 H.6.1 - The vertical location of the current in the water column is normally referenced to some vertical datum.

DiscoveryMetadata(*args, **kwargs)

12.2.6 of v1.2.0

Enum(value[, names, module, qualname, type, ...])

Create a collection of name/value pairs.

FeatureContainerDCF2(*args, **opts)

Container for Data Coding Format 2

FeatureContainerDCF3(*args, **opts)

Container for Data Coding Format 3

FeatureInformation([recursively_create_children])

In S100, table 10c-8.

FeatureInformationDataset(*args, **opts)

This class comes from S100 -- 10c-9.5 Feature information group.

FeatureInstanceDCF2([...])

Data Coding Format 2 is the grid format from table 10c-12 in S100 spec.

FeatureInstanceDCF3([...])

Data Coding Format 3 is the Ungeorectified grid format from table 10c-12 in S100 spec.

GroupF([recursively_create_children])

Table 10.3 and sect 10.2.2 of v1.0.1

GroupFBase([recursively_create_children])

From S100 Table 10c-8 – Components of feature information group

S100Exception

S100File(*args, **kywrds)

S100Root([recursively_create_children])

From table 10c-6 in S100 v4.0 spec.

S111Exception

S111File(*args, **kywrds)

S111MetadataListBase(*args, **opts)

S111Root([recursively_create_children])

The root group contains a feature information group and N feature containers.

S111UnspecifiedClassException

S1xxCollection(*args, **opts)

This class represents arrays (noted in UML as , 1.., 0..* etc) which is not really part of HDF5.

S1xxDatasetBase(*args, **opts)

The S102 spec stores some things as datasets that could (or should) be stored as attributes.

S1xxGridsBase([recursively_create_children])

This base class is intended for use with "values" groups.

S1xxObject([recursively_create_children])

This class implements a general hdf5 group object that has attributes, datasets or sub-groups.

SurfaceCurrentContainerBase()

This is the SurfaceCurrent right off the root of the HDF5 which has possible attributes from S100 spec table 10c-10 This will hold child groups named SurfaceCurrent.NN

SurfaceCurrentContainerDCF2(*args, **opts)

SurfaceCurrentContainerDCF3(*args, **opts)

SurfaceCurrentFeatureDataset(*args, **opts)

SurfaceCurrentFeatureInstanceBase()

Basic template for the name of the attribute will be automatically determined based on the array position of the S111_MetadataList

SurfaceCurrentFeatureInstanceDCF2([...])

SurfaceCurrentFeatureInstanceDCF3([...])

SurfaceCurrentGroup([...])

10.2.5 of v1.0.1 also see section 12.3 and table 12.5

SurfaceCurrentGroupList(*args, **opts)

This is the list of Group.NNN that are held as a list.

SurfaceCurrentListBase(*args, **opts)

Sect 10.2.4 and Table 12.3 of v1.0.1 This is the set of SurfaceCurrent.NN that act like a list here.

SurfaceCurrentListDCF2(*args, **opts)

SurfaceCurrentListDCF3(*args, **opts)

SurfaceCurrentUncertaintyDataset(*args, **opts)

SurfaceCurrentUncertaintyInformation([...])

SurfaceCurrentValues([...])

VERTICAL_CS(value[, names, module, ...])

VERTICAL_DATUM(value[, names, module, ...])

Note: while a Vertical Datum can be created with the shorthand aliases, ex: MLWS, the string written and returned from the file/S100 object will be the official long name, e.g. "meanLowWaterSprings" etc.

VERTICAL_DATUM_REFERENCE(value[, names, ...])