[lmi-commits] [lmi] master 7aa151d 2/2: Document the side effects of TxSetDeathBft()

[Greg Chicares]

branch: master
commit 7aa151d33617f6726afb52e1c141d5cd62bea4e8
Author: Gregory W. Chicares <address@hidden>
Commit: Gregory W. Chicares <address@hidden>

    Document the side effects of TxSetDeathBft()
    
    A hypothetical const member such as
      double DetermineDeathBenefitIgnoringCorridor(mcenum_dbopt);
    would seem useful for reimplementing DBO changes, perhaps thus:
      ChangeSpecAmtBy
        ( DetermineDeathBenefitIgnoringCorridor(new_option)
        - DetermineDeathBenefitIgnoringCorridor(old_option)
        );
    However, that would conflict with the more important design decision
    to perform all such calculations only in TxSetDeathBft(), which has side
    effects. Because such a reimplementation is now being undertaken, it is
    important to document those side effects.
---
 ihs_avmly.cpp | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/ihs_avmly.cpp b/ihs_avmly.cpp
index 1bf9c25..2d41dd8 100644
--- a/ihs_avmly.cpp
+++ b/ihs_avmly.cpp
@@ -1546,6 +1546,13 @@ void AccountValue::TxSetBOMAV()
 
 /// Set death benefit reflecting corridor and death benefit option.
 ///
+/// These variables are updated here:
+///   DBIgnoringCorr
+///   DBReflectingCorr
+///   DB7702A
+///   DcvDeathBft
+/// so this function is called before any of them is needed.
+///
 /// Option 2 reflects the total account value: general as well as
 /// separate account, and loaned as well as unloaned. Notionally, it
 /// keeps NAAR level; therefore, it reflects AV rather than CSV.