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.api Module

Classes

ABC()

Helper class that provides a standard way to create an ABC using inheritance.

DEPTH_TYPE_INDEX(value)

Contains s111 metadata to pass to S111File.

DiscoveryMetadata(*args, **kwargs)

12.2.6 of v1.0.1

Enum(value)

Generic enumeration.

FeatureContainerDCF2(*args, **opts)

Container for Data Coding Format 2

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.

GeometryValuesDataset([...])

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

PositioningGroup([recursively_create_children])

S100Exception

S100Root([recursively_create_children])

From table 10c-6 in S100 spec.

S111Exception

S111File(*args, **kywrds)

S111MetadataListBase(*args, **opts)

S111Root([recursively_create_children])

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

S1XXFile(*args, **kywrds)

hdf5 files have primary creation methods of create_dataset to insert array data attrs a dictionary-like to add/read metadata about the current group create_group to make a group containing datasets and/or metadata

S1xxAttributesBase([recursively_create_children])

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

S1xxDatasetBase(*args, **opts)

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

S1xxGridsBase([recursively_create_children])

S1xxMetadataListBase(*args, **opts)

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

SurfaceCurrentContainer(*args, **opts)

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

SurfaceCurrentFeatureDataset(*args, **opts)

SurfaceCurrentFeatureInstance([...])

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.

SurfaceCurrentList(*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.

SurfaceCurrentUncertaintyDataset(*args, **opts)

SurfaceCurrentUncertaintyInformation([...])

SurfaceCurrentValues([...])

TYPE_OF_CURRENT_DATA(value)

An enumeration.