Package hec.io

Class VerticalDatumContainer

java.lang.Object
mil.army.usace.hec.metadata.VerticalDatumContainer
hec.io.VerticalDatumContainer
All Implemented Interfaces:
Serializable, mil.army.usace.hec.metadata.VerticalDatum
@Deprecated public class VerticalDatumContainer extends mil.army.usace.hec.metadata.VerticalDatumContainer implements mil.army.usace.hec.metadata.VerticalDatum
Deprecated.
Class to hold vertical datum information about an object containing elevations
See Also:

  • Constructor Details

    • VerticalDatumContainer

      public VerticalDatumContainer()
      Deprecated.
      Public constructor

    • VerticalDatumContainer

      public VerticalDatumContainer(String initStr) throws mil.army.usace.hec.metadata.VerticalDatumException
      Deprecated.
      Public constructor
      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:
      mil.army.usace.hec.metadata.VerticalDatumException

    • VerticalDatumContainer

      public VerticalDatumContainer(mil.army.usace.hec.metadata.VerticalDatumContainer verticalDatumContainer)
      Deprecated.

  • Method Details

    • getNativeVerticalDatum

      public String getNativeVerticalDatum() throws VerticalDatumException
      Deprecated.
      Specified by:
      getNativeVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      getNativeVerticalDatum in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • getCurrentVerticalDatum

      public String getCurrentVerticalDatum() throws VerticalDatumException
      Deprecated.
      Specified by:
      getCurrentVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      getCurrentVerticalDatum in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • isCurrentVerticalDatumEstimated

      public boolean isCurrentVerticalDatumEstimated() throws VerticalDatumException
      Deprecated.
      Specified by:
      isCurrentVerticalDatumEstimated in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      isCurrentVerticalDatumEstimated in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • toNativeVerticalDatum

      public boolean toNativeVerticalDatum() throws VerticalDatumException
      Deprecated.
      Specified by:
      toNativeVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      toNativeVerticalDatum in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • toNGVD29

      public boolean toNGVD29() throws VerticalDatumException
      Deprecated.
      Specified by:
      toNGVD29 in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      toNGVD29 in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • toNAVD88

      public boolean toNAVD88() throws VerticalDatumException
      Deprecated.
      Specified by:
      toNAVD88 in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      toNAVD88 in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • toVerticalDatum

      public boolean toVerticalDatum(String datum) throws VerticalDatumException
      Deprecated.
      Specified by:
      toVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      toVerticalDatum in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • forceVerticalDatum

      public boolean forceVerticalDatum(String datum) throws VerticalDatumException
      Deprecated.
      Specified by:
      forceVerticalDatum in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      forceVerticalDatum in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • getCurrentOffset

      public double getCurrentOffset() throws VerticalDatumException
      Deprecated.
      Specified by:
      getCurrentOffset in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      getCurrentOffset in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • getCurrentOffset

      public double getCurrentOffset(String unit) throws VerticalDatumException
      Deprecated.
      Specified by:
      getCurrentOffset in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      getCurrentOffset in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • getNGVD29Offset

      public double getNGVD29Offset() throws VerticalDatumException
      Deprecated.
      Specified by:
      getNGVD29Offset in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      getNGVD29Offset in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • getNGVD29Offset

      public double getNGVD29Offset(String unit) throws VerticalDatumException
      Deprecated.
      Specified by:
      getNGVD29Offset in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      getNGVD29Offset in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • getNAVD88Offset

      public double getNAVD88Offset() throws VerticalDatumException
      Deprecated.
      Specified by:
      getNAVD88Offset in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      getNAVD88Offset in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • getNAVD88Offset

      public double getNAVD88Offset(String unit) throws VerticalDatumException
      Deprecated.
      Specified by:
      getNAVD88Offset in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      getNAVD88Offset in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      VerticalDatumException

    • isNGVD29OffsetEstimated

      public boolean isNGVD29OffsetEstimated() throws mil.army.usace.hec.metadata.VerticalDatumException
      Deprecated.
      Specified by:
      isNGVD29OffsetEstimated in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      isNGVD29OffsetEstimated in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      mil.army.usace.hec.metadata.VerticalDatumException

    • isNAVD88OffsetEstimated

      public boolean isNAVD88OffsetEstimated() throws mil.army.usace.hec.metadata.VerticalDatumException
      Deprecated.
      Specified by:
      isNAVD88OffsetEstimated in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      isNAVD88OffsetEstimated in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      mil.army.usace.hec.metadata.VerticalDatumException

    • getVerticalDatumInfo

      public String getVerticalDatumInfo()
      Deprecated.
      Specified by:
      getVerticalDatumInfo in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      getVerticalDatumInfo in class mil.army.usace.hec.metadata.VerticalDatumContainer

    • setVerticalDatumInfo

      public void setVerticalDatumInfo(String initStr) throws mil.army.usace.hec.metadata.VerticalDatumException
      Deprecated.
      Specified by:
      setVerticalDatumInfo in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      setVerticalDatumInfo in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Throws:
      mil.army.usace.hec.metadata.VerticalDatumException

    • clone

      public VerticalDatumContainer clone()
      Deprecated.
      Returns a copy of this object
      Overrides:
      clone in class mil.army.usace.hec.metadata.VerticalDatumContainer

    • getVerticalDatumContainer

      public VerticalDatumContainer getVerticalDatumContainer()
      Deprecated.
      Returns this VerticalDatumContainer object.
      Specified by:
      getVerticalDatumContainer in interface mil.army.usace.hec.metadata.VerticalDatum
      Overrides:
      getVerticalDatumContainer in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Returns:
      this

    • setVerticalDatumContainer

      public void setVerticalDatumContainer(mil.army.usace.hec.metadata.VerticalDatumContainer vdc)
      Deprecated.
      Sets all the member variables to the given VerticalDatumContainer member values.
      Overrides:
      setVerticalDatumContainer in class mil.army.usace.hec.metadata.VerticalDatumContainer
      Parameters:
      vdc -