Skip to content

Commit 682b1c9

Browse files
committed
Add doc to samplingfeatures
1 parent 599d055 commit 682b1c9

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

odm2api/ODM2/models.py

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,18 +248,37 @@ class SamplingFeatures(Base):
248248
Where or on what an action was performed.
249249
"""
250250
SamplingFeatureID = Column('samplingfeatureid', Integer, primary_key=True, nullable=False)
251+
"""int: Primary key identifier."""
251252
SamplingFeatureUUID = Column('samplingfeatureuuid', String(36), nullable=False)
253+
"""str: A universally unique identifier for the sampling feature."""
252254
SamplingFeatureTypeCV = Column('samplingfeaturetypecv', ForeignKey(CVSamplingFeatureType.Name),
253255
nullable=False, index=True)
256+
"""str: CV term describing the type of sampling feature."""
254257
SamplingFeatureCode = Column('samplingfeaturecode', String(50), nullable=False)
258+
"""str: A short but meaningful text identifier for the sampling feature."""
255259
SamplingFeatureName = Column('samplingfeaturename', String(255))
260+
"""str: Sampling Feature name (free text)."""
256261
SamplingFeatureDescription = Column('samplingfeaturedescription', String(500))
262+
"""str: Text describing the sampling feature."""
257263
SamplingFeatureGeotypeCV = Column('samplingfeaturegeotypecv', ForeignKey(CVSamplingFeatureGeoType.Name),
258264
index=True)
265+
"""str: Dimensionality of SamplingFeature; point2d, line2d, etc."""
259266
Elevation_m = Column('elevation_m', Float(53))
267+
"""float: The elevation of the sampling feature in meters, or in the case of Specimen,
268+
the elevation from where the SamplingFeature.Specimen was collected"""
260269
ElevationDatumCV = Column('elevationdatumcv', ForeignKey(CVElevationDatum.Name), index=True)
261-
#FeatureGeometry = Column('featuregeometry', String(50))
270+
"""str: The code for the vertical geodetic datum that specifies the zero point for
271+
the Sampling Feature Elevation"""
272+
# FeatureGeometry = Column('featuregeometry', String(50))
273+
"""object: The location geometry of the sampling feature on the Earth expressed using a
274+
geometry data type. Can be a Point, Curve (profile, trajectory, etc),
275+
Surface (flat polygons, etc) or Solid/Volume (although often limited to
276+
2D geometries). """
262277
FeatureGeometryWKT = Column('featuregeometrywkt', String(50))
278+
"""str: The location geometry of the sampling feature on the Earth expressed as
279+
well known text (WKT). Can be a Point, Curve (profile, trajectory, etc.),
280+
Surface (flat polygons, etc.), or Solid/Volume (although often limited to
281+
2D geometries)."""
263282
__mapper_args__ = {
264283
# 'polymorphic_on': SamplingFeatureTypeCV,
265284
"polymorphic_on": case([

0 commit comments

Comments
 (0)