Package hec.data

Interface IVerticalDatum

All Superinterfaces:
mil.army.usace.hec.metadata.VerticalDatum
@Deprecated public interface IVerticalDatum extends mil.army.usace.hec.metadata.VerticalDatum
Deprecated.
As of 02/08/2021 use VerticalDatum
Interface for classes that work with vertical datums. This interface should be replaced with hec-nucleus interface

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    forceVerticalDatum(String datum)
    Deprecated.
    Sets the objects current vertical datum to the specified vertical datum without changing any elevations.
    double
    getCurrentOffset()
    Deprecated.
    Retrieves the offset added to the an elevation in the native vertical datum to generate an elevation in the current datum in the current unit
    double
    getCurrentOffset(String unit)
    Deprecated.
    Retrieves the offset added to the an elevation in the native vertical datum to generate an elevation in the current datum
    String
    getCurrentVerticalDatum()
    Deprecated.
    Retrieves the current vertical datum of the object's elevation(s)
    String
    getNativeVerticalDatum()
    Deprecated.
    Retrieves the native vertical datum of the object's elevation(s)
    double
    getNAVD88Offset()
    Deprecated.
    Retrieves the offset added to the an elevation in the native vertical datum to generate an elevation in NAVD88 in the current unit
    double
    getNAVD88Offset(String unit)
    Deprecated.
    Retrieves the offset added to the an elevation in the native vertical datum to generate an elevation in NAVD88
    double
    getNGVD29Offset()
    Deprecated.
    Retrieves the offset added to the an elevation in the native vertical datum to generate an elevation in NGVD29 in the current unit
    double
    getNGVD29Offset(String unit)
    Deprecated.
    Retrieves the offset added to the an elevation in the native vertical datum to generate an elevation in NGVD29
    VerticalDatumContainer
    getVerticalDatumContainer()
    Deprecated.
     
    String
    getVerticalDatumInfo()
    Deprecated.
    Retrieves a text representation of the vertical datum information
    boolean
    isCurrentVerticalDatumEstimated()
    Deprecated.
    Retrieves whether the elevation(s) in the current vertical datum were generated by an estimated offset
    boolean
    isNAVD88OffsetEstimated()
    Deprecated.
    Retrieves whether the offset added to the an elevation in the native vertical datum to generate an elevation in NAVD88 is an estimate
    boolean
    isNGVD29OffsetEstimated()
    Deprecated.
    Retrieves whether the offset added to the an elevation in the native vertical datum to generate an elevation in NGVD29 is an estimate
    void
    setVerticalDatumContainer(VerticalDatumContainer vdc)
    Deprecated.
     
    void
    setVerticalDatumInfo(String initStr)
    Deprecated.
    Initializes the object from a string initializer
    boolean
    toNativeVerticalDatum()
    Deprecated.
    Changes the object's elevation(s) (if necessary) to its native vertical datum
    boolean
    toNAVD88()
    Deprecated.
    Changes the object's elevation(s) (if necessary) to NAVD88
    boolean
    toNGVD29()
    Deprecated.
    Changes the object's elevation(s) (if necessary) to NGVD29
    boolean
    toVerticalDatum(String datum)
    Deprecated.
    Changes the object's elevation(s) (if necessary) to the specified vertical datum

  • Method Details

    • getNativeVerticalDatum

      String getNativeVerticalDatum() throws VerticalDatumException
      Deprecated.
      Retrieves the native vertical datum of the object's elevation(s)
      Specified by:
      getNativeVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum
      Returns:
      the native vertical datum of the object's elevation(s)
      Throws:
      VerticalDatumException - if the native vertical datum is not set

    • getCurrentVerticalDatum

      String getCurrentVerticalDatum() throws VerticalDatumException
      Deprecated.
      Retrieves the current vertical datum of the object's elevation(s)
      Specified by:
      getCurrentVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum
      Returns:
      the current vertical datum of the object's elevation(s)
      Throws:
      VerticalDatumException - if the current vertical datum is not set

    • isCurrentVerticalDatumEstimated

      boolean isCurrentVerticalDatumEstimated() throws VerticalDatumException
      Deprecated.
      Retrieves whether the elevation(s) in the current vertical datum were generated by an estimated offset
      Specified by:
      isCurrentVerticalDatumEstimated in interface mil.army.usace.hec.metadata.VerticalDatum
      Returns:
      whether the elevation(s) in the current vertical datum were generated by an estimated offset
      Throws:
      VerticalDatumException - if the current vertical datum is not set

    • toNativeVerticalDatum

      boolean toNativeVerticalDatum() throws VerticalDatumException
      Deprecated.
      Changes the object's elevation(s) (if necessary) to its native vertical datum
      Specified by:
      toNativeVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum
      Returns:
      whether a change was necessary (i.e., false = no elevations were modified)
      Throws:
      VerticalDatumException - if the native vertical datum is not set

    • toNGVD29

      boolean toNGVD29() throws VerticalDatumException
      Deprecated.
      Changes the object's elevation(s) (if necessary) to NGVD29
      Specified by:
      toNGVD29 in interface mil.army.usace.hec.metadata.VerticalDatum
      Returns:
      whether a change was necessary (i.e., false = no elevations were modified)
      Throws:
      VerticalDatumException - if the object doesn't contain enough information to perform the operation

    • toNAVD88

      boolean toNAVD88() throws VerticalDatumException
      Deprecated.
      Changes the object's elevation(s) (if necessary) to NAVD88
      Specified by:
      toNAVD88 in interface mil.army.usace.hec.metadata.VerticalDatum
      Returns:
      whether a change was necessary (i.e., false = no elevations were modified)
      Throws:
      VerticalDatumException - if the object doesn't contain enough information to perform the operation

    • toVerticalDatum

      boolean toVerticalDatum(String datum) throws VerticalDatumException
      Deprecated.
      Changes the object's elevation(s) (if necessary) to the specified vertical datum
      Specified by:
      toVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum
      Parameters:
      datum - the vertical datum to change to:
      • NGVD29
      • NAVD88
      • LOCAL
      • NATIVE
      Returns:
      whether a change was necessary (i.e., false = no elevations were modified)
      Throws:
      VerticalDatumException - if the object doesn't contain enough information to perform the operation

    • forceVerticalDatum

      boolean forceVerticalDatum(String datum) throws VerticalDatumException
      Deprecated.
      Sets the objects current vertical datum to the specified vertical datum without changing any elevations. This function bypasses normal vertical datum operations and should be called only in situations where the objects elevations are known to be in a datum other than the current datum.
      Specified by:
      forceVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum
      Parameters:
      datum - the vertical datum to change to:
      • NGVD29
      • NAVD88
      • LOCAL
      • NATIVE
      Returns:
      whether the specified vertical datum differs from the objects's current vertical datum before the call
      Throws:
      VerticalDatumException - if the object doesn't contain enough information to perform the operation

    • getCurrentOffset

      double getCurrentOffset() throws VerticalDatumException
      Deprecated.
      Retrieves the offset added to the an elevation in the native vertical datum to generate an elevation in the current datum in the current unit
      Specified by:
      getCurrentOffset in interface mil.army.usace.hec.metadata.VerticalDatum
      Returns:
      the offset added to the an elevation in the native vertical datum to generate an elevation in the current datum in the current unit
      Throws:
      VerticalDatumException - if the object doesn't contain the required offset information

    • getCurrentOffset

      double getCurrentOffset(String unit) throws VerticalDatumException
      Deprecated.
      Retrieves the offset added to the an elevation in the native vertical datum to generate an elevation in the current datum
      Specified by:
      getCurrentOffset in interface mil.army.usace.hec.metadata.VerticalDatum
      Parameters:
      unit - the unit to retrieve the offset in
      Returns:
      the offset added to the an elevation in the native vertical datum to generate an elevation in the current datum
      Throws:
      VerticalDatumException - if the object doesn't contain the required offset information

    • getNGVD29Offset

      double getNGVD29Offset() throws VerticalDatumException
      Deprecated.
      Retrieves the offset added to the an elevation in the native vertical datum to generate an elevation in NGVD29 in the current unit
      Specified by:
      getNGVD29Offset in interface mil.army.usace.hec.metadata.VerticalDatum
      Returns:
      the offset added to the an elevation in the native vertical datum to generate an elevation in NGVD29 in the current unit
      Throws:
      VerticalDatumException - if the object doesn't contain the required offset information

    • getNGVD29Offset

      double getNGVD29Offset(String unit) throws VerticalDatumException
      Deprecated.
      Retrieves the offset added to the an elevation in the native vertical datum to generate an elevation in NGVD29
      Specified by:
      getNGVD29Offset in interface mil.army.usace.hec.metadata.VerticalDatum
      Parameters:
      unit - the unit to retrieve the offset in
      Returns:
      the offset added to the an elevation in the native vertical datum to generate an elevation in NGVD29
      Throws:
      VerticalDatumException - if the object doesn't contain the required offset information

    • getNAVD88Offset

      double getNAVD88Offset() throws VerticalDatumException
      Deprecated.
      Retrieves the offset added to the an elevation in the native vertical datum to generate an elevation in NAVD88 in the current unit
      Specified by:
      getNAVD88Offset in interface mil.army.usace.hec.metadata.VerticalDatum
      Returns:
      the offset added to the an elevation in the native vertical datum to generate an elevation in NAVD88 in the current unit
      Throws:
      VerticalDatumException - if the object doesn't contain the required offset information

    • getNAVD88Offset

      double getNAVD88Offset(String unit) throws VerticalDatumException
      Deprecated.
      Retrieves the offset added to the an elevation in the native vertical datum to generate an elevation in NAVD88
      Specified by:
      getNAVD88Offset in interface mil.army.usace.hec.metadata.VerticalDatum
      Parameters:
      unit - the unit to retrieve the offset in
      Returns:
      the offset added to the an elevation in the native vertical datum to generate an elevation in NAVD88
      Throws:
      VerticalDatumException - if the object doesn't contain the required offset information

    • isNGVD29OffsetEstimated

      boolean isNGVD29OffsetEstimated() throws VerticalDatumException
      Deprecated.
      Retrieves whether the offset added to the an elevation in the native vertical datum to generate an elevation in NGVD29 is an estimate
      Specified by:
      isNGVD29OffsetEstimated in interface mil.army.usace.hec.metadata.VerticalDatum
      Returns:
      whether the offset added to the an elevation in the native vertical datum to generate an elevation in NGVD29 is an estimate
      Throws:
      VerticalDatumException - if the object doesn't contain the required offset information

    • isNAVD88OffsetEstimated

      boolean isNAVD88OffsetEstimated() throws VerticalDatumException
      Deprecated.
      Retrieves whether the offset added to the an elevation in the native vertical datum to generate an elevation in NAVD88 is an estimate
      Specified by:
      isNAVD88OffsetEstimated in interface mil.army.usace.hec.metadata.VerticalDatum
      Returns:
      whether the offset added to the an elevation in the native vertical datum to generate an elevation in NAVD88 is an estimate
      Throws:
      VerticalDatumException - if the object doesn't contain the required offset information

    • getVerticalDatumInfo

      String getVerticalDatumInfo() throws VerticalDatumException
      Deprecated.
      Retrieves a text representation of the vertical datum information
      Specified by:
      getVerticalDatumInfo in interface mil.army.usace.hec.metadata.VerticalDatum
      Returns:
      a text representation of the vertical datum information
      Throws:
      VerticalDatumException

    • setVerticalDatumInfo

      void setVerticalDatumInfo(String initStr) throws VerticalDatumException
      Deprecated.
      Initializes the object from a string initializer
      Specified by:
      setVerticalDatumInfo in interface mil.army.usace.hec.metadata.VerticalDatum
      Parameters:
      initStr - String initializer. May be either an XML fragment of the following format or simply the name of the native vertical datum (in which case no datum conversion is supported).
      Example XML fragment: 
                      <vertical-datum-info "unit"="ft">
                  <native-datum>OTHER</native-datum>
                  <local-datum-name>Pensacola</local-datum-name>
                  <elevation>1407.22</elevation>
                  <offset "estimate"="true">
                    <to-datum>NAVD-88</to-datum>
                    <value>1.457</value>
                  </offset>
                  <offset "estimate"="false">
                    <to-datum>NGVD-29</to-datum>
                    <value>1.07</value>
                  </offset>
                </vertical-datum-info>
      The <native-datum> element must be one of:
      • NGVD-29 (or NGVD 29, NGVD29) - no <local-datum-name> element allowed
      • NAVD-88 (or NAVD 88, NAVD88) - no <local-datum-name> element allowed
      • OTHER (or LOCAL) - <local-datum-name> element allowed but not required

      All <offset> elements specify the value to add to an elevation in the native datum to get an elevation in the datum specified <to-datum> datum (in the unit specified in the <vertical-datum-info> element.

      The <to-datum> values are limited to NGVD-29 and NAVD-88. No offset is required to be specified for the native datum.

      Throws:
      VerticalDatumException

    • getVerticalDatumContainer

      VerticalDatumContainer getVerticalDatumContainer()
      Deprecated.
      Specified by:
      getVerticalDatumContainer in interface mil.army.usace.hec.metadata.VerticalDatum

    • setVerticalDatumContainer

      void setVerticalDatumContainer(VerticalDatumContainer vdc) throws VerticalDatumException
      Deprecated.
      Throws:
      VerticalDatumException